Directus / @directus/sdk / rest / createItem
Function: createItem()
createItem<
Schema
,Collection
,TQuery
>(collection
,item
,query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...[...]> extendsobject
?object
&UnpackList
<...> :never
:never
>>> extendsFF
?MapFlatFields
<UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...[...]> extendsobject
?object
&UnpackList
<...> :never
:never
>>,FieldsWildcard
<UnpackList
<IfAny
<Schema
,any
,Collection
extends keyofSchema
?UnpackList
<...> extendsobject
? ... & ... :never
:never
>>,Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>,PickRelationalFields
<UnpackList
<Mutable
<...>>> extendsnever
?never
:AllKeys
<UnpackList
<...> extendsField
? ... extends ... ? ... : ... :never
>>>,FF
extendsRecord
<string
,string
> ?FF
:Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>,Schema
>
Create a new item in the given collection.
Type parameters
• Schema extends object
• Collection extends string
| number
| symbol
• TQuery extends Query
<Schema
, Schema
[Collection
]>
Parameters
• collection: Collection
The collection of the item
• item: Partial
<UnpackList
<Schema
[Collection
]>>
The item to create
• query?: TQuery
Optional return data query
Returns
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...[...]> extends object
? object
& UnpackList
<...> : never
: never
>>> extends FF
? MapFlatFields
<UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...[...]> extends object
? object
& UnpackList
<...> : never
: never
>>, FieldsWildcard
<UnpackList
<IfAny
<Schema
, any
, Collection
extends keyof Schema
? UnpackList
<...> extends object
? ... & ... : never
: never
>>, Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>, PickRelationalFields
<UnpackList
<Mutable
<...>>> extends never
? never
: AllKeys
<UnpackList
<...> extends Field
? ... extends ... ? ... : ... : never
>>>, FF
extends Record
<string
, string
> ? FF
: Record
<string
, string
>> : never
, PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extends never
? never
: { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>, Schema
>
Returns the item objects of the item that were created.