Directus / @directus/sdk / rest / readRole
Function: readRole()
readRole<
Schema
,TQuery
>(key
,query
?):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,Merge
<MappedFunctionFields
<Schema
,UnpackList
<MergeCoreCollection
<Schema
,"directus_roles"
,Object
>>> extendsFF
?MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
,"directus_roles"
,Object
>>,FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
,"directus_roles"
,Object
>>,Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>,PickRelationalFields
<UnpackList
<Mutable
<...>>> extendsnever
?never
:AllKeys
<UnpackList
<...> extendsField
? ... extends ... ? ... : ... :never
>>>,FF
extendsRecord
<string
,string
> ?FF
<FF
> :Record
<string
,string
>> :never
,PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extendsnever
?never
:{ [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_roles", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>,Schema
>
List an existing Role by primary key.
Type parameters
• Schema
• TQuery extends Query
<Schema
, DirectusRole
<Schema
>>
Parameters
• key: DirectusRole
<Schema
>["id"
]
The primary key of the dashboard
• query?: TQuery
The query parameters
Returns
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, Merge
<MappedFunctionFields
<Schema
, UnpackList
<MergeCoreCollection
<Schema
, "directus_roles"
, Object
>>> extends FF
? MapFlatFields
<UnpackList
<MergeCoreCollection
<Schema
, "directus_roles"
, Object
>>, FieldsWildcard
<UnpackList
<MergeCoreCollection
<Schema
, "directus_roles"
, Object
>>, Exclude
<UnpackList
<Mutable
<TQuery
["fields"
]>>, PickRelationalFields
<UnpackList
<Mutable
<...>>> extends never
? never
: AllKeys
<UnpackList
<...> extends Field
? ... extends ... ? ... : ... : never
>>>, FF
extends Record
<string
, string
> ? FF
<FF
> : Record
<string
, string
>> : never
, PickRelationalFields
<UnpackList
<Mutable
<TQuery
["fields"
]>>> extends never
? never
: { [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_roles", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field<Field>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field<Field>], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }
>>, Schema
>
Returns a Role object if a valid primary key was provided.
Throws
Will throw if key is empty