Directus / @directus/sdk / rest / readRelations
Function: readRelations() ​
readRelations<
Schema
>():RestCommand
<IfAny
<Schema
,Record
<string
,any
>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }>[],Schema
>
List all Relations that exist in Directus.
Type Parameters ​
• Schema
Returns ​
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusRelation<Schema>> extends FF ? MapFlatFields<DirectusRelation<Schema>, keyof DirectusRelation<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }>[], Schema
>
An array of up to limit Relation objects. If no items are available, data will be an empty array.