Directus / @directus/sdk / rest / readDashboard

Function: readDashboard() ​

readDashboard<Schema, TQuery>(key, query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<MergeCoreCollection<Schema, "directus_dashboards", Object>>> extends FF ? MapFlatFields<UnpackList<MergeCoreCollection<Schema, "directus_dashboards", Object>>, FieldsWildcard<UnpackList<MergeCoreCollection<Schema, "directus_dashboards", Object>>, 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<MergeCoreCollection<Schema, "directus_dashboards", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

List an existing dashboard by primary key.

Type parameters ​

• Schema extends object

• TQuery extends Query<Schema, DirectusDashboard<Schema>>

Parameters ​

• key: DirectusDashboard<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_dashboards", Object>>> extends FF ? MapFlatFields<UnpackList<MergeCoreCollection<Schema, "directus_dashboards", Object>>, FieldsWildcard<UnpackList<MergeCoreCollection<Schema, "directus_dashboards", Object>>, 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<MergeCoreCollection<Schema, "directus_dashboards", Object>> ? Extract<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<MergeCoreCollection<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

Returns the requested dashboard object.

Throws ​

Will throw if key is empty

Source ​

rest/commands/read/dashboards.ts:35