Directus / @directus/sdk / rest / readDashboard

Function: readDashboard() ​

readDashboard<Schema, TQuery>(key, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { color: (...) | (...); date_created: (...) | (...); icon: string; id: string; name: string; note: (...) | (...); user_created: (...) | (...) | (...) }, "directus_dashboards" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { color: (...) | (...); date_created: (...) | (...); icon: string; id: string; name: string; note: (...) | (...); user_created: (...) | (...) | (...) }, "directus_dashboards" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Defined in: rest/commands/read/dashboards.ts:35

List an existing dashboard by primary key.

Type Parameters ​

• Schema

• 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>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { color: (...) | (...); date_created: (...) | (...); icon: string; id: string; name: string; note: (...) | (...); user_created: (...) | (...) | (...) }, "directus_dashboards" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { color: (...) | (...); date_created: (...) | (...); icon: string; id: string; name: string; note: (...) | (...); user_created: (...) | (...) | (...) }, "directus_dashboards" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { color: ...; date_created: ...; icon: ...; id: ...; name: ...; note: ...; user_created: ... }, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Returns the requested dashboard object.

Throws ​

Will throw if key is empty