Function: updateObjectTypeAttribute()

function updateObjectTypeAttribute(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  additionalValue?: string;
  confluenceAddValue?: {
   [key: string]: unknown;
     error?: boolean;
     key?: string;
     name?: string;
  };
  confluenceTypeValue?: {
   [key: string]: unknown;
     error?: boolean;
     id?: string;
     name?: string;
     uri?: string;
  };
  defaultType?: {
   [key: string]: unknown;
     id?: number;
     name?: string;
  };
  description?: string;
  editable?: boolean;
  hidden?: boolean;
  id?: number;
  includeChildObjectTypes?: boolean;
  indexed?: boolean;
  iql?: string;
  label?: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectAttributeExists?: boolean;
  objectType?: {
   [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;
  };
  options?: string;
  position?: number;
  qlQuery?: string;
  referenceObjectType?: {
   [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;
  };
  referenceObjectTypeId?: number;
  referenceType?: {
   [key: string]: unknown;
     after?: string;
     color?: string;
     description?: string;
     expand?: string;
     id?: number;
     name?: string;
     objectSchemaId?: number;
     position?: string;
     project?: string;
     removable?: boolean;
     url16?: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  versionTypeValue?: {
   [key: string]: unknown;
     avatarUrl?: string;
     id?: number;
     key?: string;
     name?: string;
     url?: string;
  };
  versionTypeValues?: object[];
}>;

Defined in: src/assetsServer/api/objectTypeAttributes.ts:67

Update an object type attribute.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: { additionalValue?: string; after?: string; defaultTypeId?: number; description?: string; expand?: string; hidden?: string; id?: number; includeChildObjectTypes?: string; indexed?: string; iql?: string; label?: string; maximumCardinality?: number; minimumCardinality?: number; name?: string; options?: string; position?: string; project?: string; qlQuery?: string; regexValidation?: string; removeExcessCardinality?: boolean; suffix?: string; summable?: string; type: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: string; }; id: string; objectTypeId: string; }	-
parameters.body?	{ additionalValue?: string; after?: string; defaultTypeId?: number; description?: string; expand?: string; hidden?: string; id?: number; includeChildObjectTypes?: string; indexed?: string; iql?: string; label?: string; maximumCardinality?: number; minimumCardinality?: number; name?: string; options?: string; position?: string; project?: string; qlQuery?: string; regexValidation?: string; removeExcessCardinality?: boolean; suffix?: string; summable?: string; type: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: string; }	-
parameters.body.additionalValue?	string	-
parameters.body.after?	string	-
parameters.body.defaultTypeId?	number	-
parameters.body.description?	string	-
parameters.body.expand?	string	-
parameters.body.hidden?	string	-
parameters.body.id?	number	-
parameters.body.includeChildObjectTypes?	string	-
parameters.body.indexed?	string	-
parameters.body.iql?	string	-
parameters.body.label?	string	-
parameters.body.maximumCardinality?	number	-
parameters.body.minimumCardinality?	number	-
parameters.body.name?	string	-
parameters.body.options?	string	-
parameters.body.position?	string	-
parameters.body.project?	string	-
parameters.body.qlQuery?	string	-
parameters.body.regexValidation?	string	-
parameters.body.removeExcessCardinality?	boolean	-
parameters.body.suffix?	string	-
parameters.body.summable?	string	-
parameters.body.type?	number	-
parameters.body.typeValue?	string	-
parameters.body.typeValueMulti?	string[]	-
parameters.body.uniqueAttribute?	string	-
parameters.id?	string	The ID of the attribute to update.
parameters.objectTypeId?	string	The ID of the object type to update the attribute for.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; additionalValue?: string; confluenceAddValue?: { [key: string]: unknown; error?: boolean; key?: string; name?: string; }; confluenceTypeValue?: { [key: string]: unknown; error?: boolean; id?: string; name?: string; uri?: string; }; defaultType?: { [key: string]: unknown; id?: number; name?: string; }; description?: string; editable?: boolean; hidden?: boolean; id?: number; includeChildObjectTypes?: boolean; indexed?: boolean; iql?: string; label?: boolean; maximumCardinality?: number; minimumCardinality?: number; name?: string; objectAttributeExists?: boolean; objectType?: { [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; }; options?: string; position?: number; qlQuery?: string; referenceObjectType?: { [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; }; referenceObjectTypeId?: number; referenceType?: { [key: string]: unknown; after?: string; color?: string; description?: string; expand?: string; id?: number; name?: string; objectSchemaId?: number; position?: string; project?: string; removable?: boolean; url16?: string; }; regexValidation?: string; removable?: boolean; sortable?: boolean; suffix?: string; summable?: boolean; system?: boolean; type?: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: boolean; versionTypeValue?: { [key: string]: unknown; avatarUrl?: string; id?: number; key?: string; name?: string; url?: string; }; versionTypeValues?: object[]; }>