Function: updateObjectTypeAttribute()

function updateObjectTypeAttribute(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  additionalValue?: string;
  defaultType?:   | {
   [key: string]: unknown;
     id: -1;
     name: "None";
   }
     | {
   [key: string]: unknown;
     id: 0;
     name: "Text";
   }
     | {
   [key: string]: unknown;
     id: 1;
     name: "Integer";
   }
     | {
   [key: string]: unknown;
     id: 2;
     name: "Boolean";
   }
     | {
   [key: string]: unknown;
     id: 3;
     name: "Double";
   }
     | {
   [key: string]: unknown;
     id: 4;
     name: "Date";
   }
     | {
   [key: string]: unknown;
     id: 5;
     name: "Time";
   }
     | {
   [key: string]: unknown;
     id: 6;
     name: "DateTime";
   }
     | {
   [key: string]: unknown;
     id: 7;
     name: "Url";
   }
     | {
   [key: string]: unknown;
     id: 8;
     name: "Email";
   }
     | {
   [key: string]: unknown;
     id: 9;
     name: "Textarea";
   }
     | {
   [key: string]: unknown;
     id: 10;
     name: "Select";
   }
     | {
   [key: string]: unknown;
     id: 11;
     name: "IP Address";
   };
  description?: string;
  editable?: boolean;
  globalId: string;
  hidden?: boolean;
  id: string;
  includeChildObjectTypes?: boolean;
  indexed: boolean;
  label: boolean;
  maximumCardinality?: number;
  minimumCardinality?: number;
  name?: string;
  objectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  options?: string;
  position: number;
  qlQuery?: string;
  referenceObjectType?: {
   [key: string]: unknown;
     abstractObjectType: boolean;
     created: Date;
     description?: string;
     globalId: string;
     icon: {
      [key: string]: unknown;
        id: string;
        name: string;
        url16: string;
        url48: string;
     };
     id: string;
     inherited: boolean;
     name: string;
     objectCount: number;
     objectSchemaId: string;
     parentObjectTypeId?: number;
     parentObjectTypeInherited: boolean;
     position: number;
     type?: number;
     updated: Date;
     workspaceId: string;
  };
  referenceObjectTypeId?: string;
  referenceType?: {
   [key: string]: unknown;
     cdmData?: {
      [key: string]: unknown;
        types?: object[];
     };
     color?: string;
     description?: string;
     globalId: string;
     id?: string;
     name: string;
     objectSchemaId?: string;
     url16?: string;
     workspaceId: string;
  };
  regexValidation?: string;
  removable?: boolean;
  sortable?: boolean;
  suffix?: string;
  summable?: boolean;
  system?: boolean;
  type?: number;
  typeValue?: string;
  typeValueMulti?: string[];
  uniqueAttribute?: boolean;
  workspaceId: string;
}>;

Defined in: src/assets/api/objectTypeAttributes.ts:44

Update an existing object type attribute

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ additionalValue?: string; defaultTypeId?: number; description?: string; hidden?: boolean; id: string; includeChildObjectTypes?: boolean; label?: boolean; maximumCardinality?: number; minimumCardinality?: number; name?: string; objectTypeId: string; options?: string; qlQuery?: string; regexValidation?: string; suffix?: string; summable?: boolean; type?: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: boolean; }	-
parameters.additionalValue?	string	Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference
parameters.defaultTypeId?	number
parameters.description?	string	-
parameters.hidden?	boolean	Hide the object type attributes for Assets Users
parameters.id?	string	The object type attribute to manipulate
parameters.includeChildObjectTypes?	boolean	Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
parameters.label?	boolean	-
parameters.maximumCardinality?	number	Valid for Type Email, Select, Object, User, Group, Version and Project
parameters.minimumCardinality?	number	Valid for Type Email, Select, Object, User, Group, Version and Project
parameters.name?	string	-
parameters.objectTypeId?	string	The object type id that has this object type attribute associated with it
parameters.options?	string	Valid for Type Select. A comma separated list of all chosable options
parameters.qlQuery?	string	Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.
parameters.regexValidation?	string	Valid for Type Text and Email
parameters.suffix?	string	Valid for Integer and Double object type attributes
parameters.summable?	boolean	Valid for Type Integer and Double. Should a sum be included in the view
parameters.type?	number
parameters.typeValue?	string	It is mandatory for Type = Object reference and should point to the referenced object type id
parameters.typeValueMulti?	string[]	Valid for Type User. The Jira groups to restrict selection to
parameters.uniqueAttribute?	boolean	Should the values be unique for object attributes associated with this object type attribute
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; additionalValue?: string; defaultType?: | { [key: string]: unknown; id: -1; name: "None"; } | { [key: string]: unknown; id: 0; name: "Text"; } | { [key: string]: unknown; id: 1; name: "Integer"; } | { [key: string]: unknown; id: 2; name: "Boolean"; } | { [key: string]: unknown; id: 3; name: "Double"; } | { [key: string]: unknown; id: 4; name: "Date"; } | { [key: string]: unknown; id: 5; name: "Time"; } | { [key: string]: unknown; id: 6; name: "DateTime"; } | { [key: string]: unknown; id: 7; name: "Url"; } | { [key: string]: unknown; id: 8; name: "Email"; } | { [key: string]: unknown; id: 9; name: "Textarea"; } | { [key: string]: unknown; id: 10; name: "Select"; } | { [key: string]: unknown; id: 11; name: "IP Address"; }; description?: string; editable?: boolean; globalId: string; hidden?: boolean; id: string; includeChildObjectTypes?: boolean; indexed: boolean; label: boolean; maximumCardinality?: number; minimumCardinality?: number; name?: string; objectType?: { [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }; options?: string; position: number; qlQuery?: string; referenceObjectType?: { [key: string]: unknown; abstractObjectType: boolean; created: Date; description?: string; globalId: string; icon: { [key: string]: unknown; id: string; name: string; url16: string; url48: string; }; id: string; inherited: boolean; name: string; objectCount: number; objectSchemaId: string; parentObjectTypeId?: number; parentObjectTypeInherited: boolean; position: number; type?: number; updated: Date; workspaceId: string; }; referenceObjectTypeId?: string; referenceType?: { [key: string]: unknown; cdmData?: { [key: string]: unknown; types?: object[]; }; color?: string; description?: string; globalId: string; id?: string; name: string; objectSchemaId?: string; url16?: string; workspaceId: string; }; regexValidation?: string; removable?: boolean; sortable?: boolean; suffix?: string; summable?: boolean; system?: boolean; type?: number; typeValue?: string; typeValueMulti?: string[]; uniqueAttribute?: boolean; workspaceId: string; }>