Appearance

On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / createRelation

Function: createRelation() ​

createRelation<Schema>(item): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>, Schema>

Create a new relation.

Type parameters ​

• Schema extends object

Parameters ​

• item: NestedPartial<DirectusRelation<Schema>>

The relation to create

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>, Schema>

Returns the relation object for the created relation.

Source ​

rest/commands/create/relations.ts:19