Skip to content

Function: updateSchema() ​

ts
function updateSchema(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  canManage?: boolean;
  created: Date;
  description?: string;
  globalId: string;
  id: string;
  name: string;
  objectCount: number;
  objectSchemaKey: string;
  objectTypeCount: number;
  status?: string;
  updated: Date;
  workspaceId: string;
}>;

Defined in: src/assets/api/objectSchemas.ts:75

Update an object schema

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; id: string; name?: string; objectSchemaKey?: string; }-
parameters.description?string-
parameters.id?stringThe object schema id
parameters.name?string-
parameters.objectSchemaKey?string-
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; canManage?: boolean; created: Date; description?: string; globalId: string; id: string; name: string; objectCount: number; objectSchemaKey: string; objectTypeCount: number; status?: string; updated: Date; workspaceId: string; }>