Skip to content

Variable: DashboardSchema

ts
const DashboardSchema: ZodObject<{
  automaticRefreshMs: ZodOptional<ZodNumber>;
  description: ZodOptional<ZodString>;
  editPermissions: ZodOptional<ZodArray<ZodObject<{
     group: ZodOptional<ZodObject<{
        groupId: ZodOptional<ZodNullable<...>>;
        name: ZodOptional<ZodString>;
        self: ZodOptional<ZodURL>;
     }, $loose>>;
     id: ZodOptional<ZodNumber>;
     project: ZodOptional<ZodObject<{
        archived: ZodOptional<ZodBoolean>;
        archivedBy: ZodOptional<ZodObject<..., ...>>;
        archivedDate: ZodOptional<ZodCoercedDate<...>>;
        assigneeType: ZodOptional<ZodCustom<..., ...>>;
        avatarUrls: ZodOptional<ZodObject<..., ...>>;
        components: ZodOptional<ZodArray<...>>;
        deleted: ZodOptional<ZodBoolean>;
        deletedBy: ZodOptional<ZodObject<..., ...>>;
        deletedDate: ZodOptional<ZodCoercedDate<...>>;
        description: ZodOptional<ZodString>;
        email: ZodOptional<ZodString>;
        entityId: ZodOptional<ZodString>;
        expand: ZodOptional<ZodString>;
        favourite: ZodOptional<ZodBoolean>;
        id: ZodOptional<ZodString>;
        insight: ZodOptional<ZodObject<..., ...>>;
        isPrivate: ZodOptional<ZodBoolean>;
        issueTypeHierarchy: ZodOptional<ZodObject<..., ...>>;
        issueTypes: ZodOptional<ZodArray<...>>;
        key: ZodOptional<ZodString>;
        landingPageInfo: ZodOptional<ZodObject<..., ...>>;
        lead: ZodOptional<ZodObject<..., ...>>;
        name: ZodOptional<ZodString>;
        permissions: ZodOptional<ZodObject<..., ...>>;
        projectCategory: ZodOptional<ZodObject<..., ...>>;
        projectTypeKey: ZodOptional<ZodCustom<..., ...>>;
        properties: ZodOptional<ZodRecord<..., ...>>;
        retentionTillDate: ZodOptional<ZodCoercedDate<...>>;
        roles: ZodOptional<ZodRecord<..., ...>>;
        self: ZodOptional<ZodURL>;
        simplified: ZodOptional<ZodBoolean>;
        style: ZodOptional<ZodCustom<..., ...>>;
        url: ZodOptional<ZodString>;
        uuid: ZodOptional<ZodString>;
        versions: ZodOptional<ZodArray<...>>;
     }, $loose>>;
     role: ZodOptional<ZodObject<{
        actors: ZodOptional<ZodArray<...>>;
        admin: ZodOptional<ZodBoolean>;
        currentUserRole: ZodOptional<ZodBoolean>;
        default: ZodOptional<ZodBoolean>;
        description: ZodOptional<ZodString>;
        id: ZodOptional<ZodNumber>;
        name: ZodOptional<ZodString>;
        roleConfigurable: ZodOptional<ZodBoolean>;
        scope: ZodOptional<ZodObject<..., ...>>;
        self: ZodOptional<ZodURL>;
        translatedName: ZodOptional<ZodString>;
     }, $loose>>;
     type: ZodCustom<
        | "global"
        | "user"
        | "group"
        | string & object
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
        | "project-unknown", 
        | "global"
        | "user"
        | "group"
        | string & object
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
       | "project-unknown">;
     user: ZodOptional<ZodObject<{
        accountId: ZodOptional<ZodString>;
        active: ZodOptional<ZodBoolean>;
        avatarUrls: ZodOptional<ZodObject<..., ...>>;
        displayName: ZodOptional<ZodString>;
        self: ZodOptional<ZodURL>;
     }, $loose>>;
  }, $loose>>>;
  id: ZodOptional<ZodString>;
  isFavourite: ZodOptional<ZodBoolean>;
  isWritable: ZodOptional<ZodBoolean>;
  name: ZodOptional<ZodString>;
  owner: ZodOptional<ZodObject<{
     accountId: ZodOptional<ZodString>;
     active: ZodOptional<ZodBoolean>;
     avatarUrls: ZodOptional<ZodObject<{
        16x16: ZodOptional<ZodURL>;
        24x24: ZodOptional<ZodURL>;
        32x32: ZodOptional<ZodURL>;
        48x48: ZodOptional<ZodURL>;
     }, $loose>>;
     displayName: ZodOptional<ZodString>;
     self: ZodOptional<ZodURL>;
  }, $loose>>;
  popularity: ZodOptional<ZodNumber>;
  rank: ZodOptional<ZodNumber>;
  self: ZodOptional<ZodURL>;
  sharePermissions: ZodOptional<ZodArray<ZodObject<{
     group: ZodOptional<ZodObject<{
        groupId: ZodOptional<ZodNullable<...>>;
        name: ZodOptional<ZodString>;
        self: ZodOptional<ZodURL>;
     }, $loose>>;
     id: ZodOptional<ZodNumber>;
     project: ZodOptional<ZodObject<{
        archived: ZodOptional<ZodBoolean>;
        archivedBy: ZodOptional<ZodObject<..., ...>>;
        archivedDate: ZodOptional<ZodCoercedDate<...>>;
        assigneeType: ZodOptional<ZodCustom<..., ...>>;
        avatarUrls: ZodOptional<ZodObject<..., ...>>;
        components: ZodOptional<ZodArray<...>>;
        deleted: ZodOptional<ZodBoolean>;
        deletedBy: ZodOptional<ZodObject<..., ...>>;
        deletedDate: ZodOptional<ZodCoercedDate<...>>;
        description: ZodOptional<ZodString>;
        email: ZodOptional<ZodString>;
        entityId: ZodOptional<ZodString>;
        expand: ZodOptional<ZodString>;
        favourite: ZodOptional<ZodBoolean>;
        id: ZodOptional<ZodString>;
        insight: ZodOptional<ZodObject<..., ...>>;
        isPrivate: ZodOptional<ZodBoolean>;
        issueTypeHierarchy: ZodOptional<ZodObject<..., ...>>;
        issueTypes: ZodOptional<ZodArray<...>>;
        key: ZodOptional<ZodString>;
        landingPageInfo: ZodOptional<ZodObject<..., ...>>;
        lead: ZodOptional<ZodObject<..., ...>>;
        name: ZodOptional<ZodString>;
        permissions: ZodOptional<ZodObject<..., ...>>;
        projectCategory: ZodOptional<ZodObject<..., ...>>;
        projectTypeKey: ZodOptional<ZodCustom<..., ...>>;
        properties: ZodOptional<ZodRecord<..., ...>>;
        retentionTillDate: ZodOptional<ZodCoercedDate<...>>;
        roles: ZodOptional<ZodRecord<..., ...>>;
        self: ZodOptional<ZodURL>;
        simplified: ZodOptional<ZodBoolean>;
        style: ZodOptional<ZodCustom<..., ...>>;
        url: ZodOptional<ZodString>;
        uuid: ZodOptional<ZodString>;
        versions: ZodOptional<ZodArray<...>>;
     }, $loose>>;
     role: ZodOptional<ZodObject<{
        actors: ZodOptional<ZodArray<...>>;
        admin: ZodOptional<ZodBoolean>;
        currentUserRole: ZodOptional<ZodBoolean>;
        default: ZodOptional<ZodBoolean>;
        description: ZodOptional<ZodString>;
        id: ZodOptional<ZodNumber>;
        name: ZodOptional<ZodString>;
        roleConfigurable: ZodOptional<ZodBoolean>;
        scope: ZodOptional<ZodObject<..., ...>>;
        self: ZodOptional<ZodURL>;
        translatedName: ZodOptional<ZodString>;
     }, $loose>>;
     type: ZodCustom<
        | "global"
        | "user"
        | "group"
        | string & object
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
        | "project-unknown", 
        | "global"
        | "user"
        | "group"
        | string & object
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
       | "project-unknown">;
     user: ZodOptional<ZodObject<{
        accountId: ZodOptional<ZodString>;
        active: ZodOptional<ZodBoolean>;
        avatarUrls: ZodOptional<ZodObject<..., ...>>;
        displayName: ZodOptional<ZodString>;
        self: ZodOptional<ZodURL>;
     }, $loose>>;
  }, $loose>>>;
  systemDashboard: ZodOptional<ZodBoolean>;
  view: ZodOptional<ZodString>;
}, $loose>;

Defined in: src/cloud/models/dashboard.ts:7

Details of a dashboard.