Type Reference

Item

interface Item {
    ancestors: string[];
    values: Record<string,any>; // custom field value
    name: string; // Item title
    workspace: {  // Workspace
		  objectId: string;
    },
    itemType: { // Item type
  		objectId: string;
    },
    createdAt: string; // creation time
    createdBy: { // creator
			objectId: string
		};
    key: string; // Item key
    status:  { // Item status
			objectId: string
		};
    updatedAt: string; // update time
    objectId: string;
}

User

interface User {
    objectId: string;
    createdAt: string; // creation time
    updatedAt: string; // update time
    username: string; // user name
    email: string;
    enabled: boolean; // Whether to enable
    deleted: boolean; // delete or not
    nickname: string;
    language: string; // language (e.g. 'zh-CN')
    role: {
      name: string; // role identification
      isRoot: boolean;  // Is it a top role
      tag: string; // role Name
      objectId: string;
    };
}

Workspace

interface Workspace {
	createdAt: string; // creation time
	updatedAt: string; // update time
	name: string;  // workspace name
	key: string; // workspace key
	createdBy: { // creator
    objectId: string;
  };
	lead: { // person in charge
    objectId: string;
  };
	icon: string; // icon url
	updatedBy: { // updater
    objectId: string;
  };
	objectId: string;
}

ItemType

interface ItemType {
  name: string;  // item type name
	key: string;   // item type key
	description: string;
	icon: string;   // icon url
	objectId: string;
}

Filter

interface Filter {
	createdAt: string;   // creation time
	updatedAt: string;   // update time
	expression: string;  // iql
	name: string;        // filter name
	global: boolean; 	   // Whether to global filter
	createdBy: {  // creator
    objectId: string;
  };
	objectId: string;
}

View

interface View {
  name: string;
  component: string;
  permission: any;
  createdBy: {  // creator
    objectId: string;
  };
}

Board

interface Board {
  name: string;
  key: string;
  workspace: Workspace;
  permission: any;
  filterSource: string;
  icon: string;
  createdBy: {  // creator
    objectId: string;
  };
}

WorkspaceTemplate

interface WorkspaceTemplate {
  workspace?: {objectId: string}; // Only available when creating a template based on an existing workspace
  objectId: string; // The ID of the workspace template
  name: string; // The workspace template name
  itemTypeScheme: {objectId: string}; // The item type scheme
  itemTypeScreenScheme: {objectId: string}; // The item t ype screen scheme
  workflowScheme: {objectId: string}; // The workflow scheme
}

BaseLineItem

interface BaseLineItem {
  objectId: string; // The ID of the baseline item
  itemId: string; // Original item ID
  values: Record<string, any>
  name: string;
  key: string;
  workspace: {  // Workspace
		objectId: string;
  },
  itemType: {  // itemType
		objectId: string;
  },
  status: {  // status
		objectId: string;
  },
}