Skip to content

Function: updateObjectType() ​

ts
function updateObjectType(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  abstractObjectType?: boolean;
  created?: Date;
  description?: string;
  icon?: {
   [key: string]: unknown;
     after?: string;
     expand?: string;
     id?: number;
     name?: string;
     position?: string;
     project?: string;
     url16?: string;
     url48?: string;
  };
  id?: number;
  inherited?: boolean;
  name?: string;
  objectCount?: number;
  objectSchemaId?: number;
  parentObjectTypeId?: number;
  parentObjectTypeInherited?: boolean;
  position?: number;
  type?: number;
  updated?: Date;
}>;

Defined in: src/assetsServer/api/objectTypes.ts:75

Update an existing object type.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body?: { abstractObjectType?: boolean; description?: string; iconId?: number; id?: number; inherited?: boolean; name?: string; objectSchemaId?: number; parentObjectTypeId?: number; }; id: string; }-
parameters.body?{ abstractObjectType?: boolean; description?: string; iconId?: number; id?: number; inherited?: boolean; name?: string; objectSchemaId?: number; parentObjectTypeId?: number; }-
parameters.body.abstractObjectType?boolean-
parameters.body.description?string-
parameters.body.iconId?number-
parameters.body.id?number-
parameters.body.inherited?boolean-
parameters.body.name?string-
parameters.body.objectSchemaId?number-
parameters.body.parentObjectTypeId?number-
parameters.id?stringThe ID of the object type to update.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; abstractObjectType?: boolean; created?: Date; description?: string; icon?: { [key: string]: unknown; after?: string; expand?: string; id?: number; name?: string; position?: string; project?: string; url16?: string; url48?: string; }; id?: number; inherited?: boolean; name?: string; objectCount?: number; objectSchemaId?: number; parentObjectTypeId?: number; parentObjectTypeInherited?: boolean; position?: number; type?: number; updated?: Date; }>