jira.js
    Preparing search index...

    Function updateObjectTypeAttribute

    • Update an existing object type attribute

      Parameters

      • 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;
        }
        • OptionaladditionalValue?: 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

        • OptionaldefaultTypeId?: number
          Id Description (mandatory if type = Default)
          -1 None
          0 Text
          1 Integer
          2 Boolean
          3 Double
          4 Date
          5 Time
          6 DateTime
          7 Url
          8 Email
          9 Textarea
          10 Select
          11 IP Address
        • Optionaldescription?: string
        • Optionalhidden?: boolean

          Hide the object type attributes for Assets Users

        • id: string

          The object type attribute to manipulate

        • OptionalincludeChildObjectTypes?: boolean

          Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well

        • Optionallabel?: boolean
        • OptionalmaximumCardinality?: number

          Valid for Type Email, Select, Object, User, Group, Version and Project

        • OptionalminimumCardinality?: number

          Valid for Type Email, Select, Object, User, Group, Version and Project

        • Optionalname?: string
        • objectTypeId: string

          The object type id that has this object type attribute associated with it

        • Optionaloptions?: string

          Valid for Type Select. A comma separated list of all chosable options

        • OptionalqlQuery?: string

          Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.

        • OptionalregexValidation?: string

          Valid for Type Text and Email

        • Optionalsuffix?: string

          Valid for Integer and Double object type attributes

        • Optionalsummable?: boolean

          Valid for Type Integer and Double. Should a sum be included in the view

        • Optionaltype?: number
          Value Description
          0 Default
          1 Object reference
          2 User
          4 Group
          7 Status
        • OptionaltypeValue?: string

          It is mandatory for Type = Object reference and should point to the referenced object type id

        • OptionaltypeValueMulti?: string[]

          Valid for Type User. The Jira groups to restrict selection to

        • OptionaluniqueAttribute?: boolean

          Should the values be unique for object attributes associated with this object type attribute

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              additionalValue?: string;
              defaultType?: | { 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"; [key: string]: unknown };
              description?: string;
              editable?: boolean;
              globalId: string;
              hidden?: boolean;
              id: string;
              includeChildObjectTypes?: boolean;
              indexed: boolean;
              label: boolean;
              maximumCardinality?: number;
              minimumCardinality?: number;
              name?: string;
              objectType?: {
                  abstractObjectType: boolean;
                  created: Date;
                  description?: string;
                  globalId: string;
                  icon: {
                      id: string;
                      name: string;
                      url16: string;
                      url48: string;
                      [key: string]: unknown;
                  };
                  id: string;
                  inherited: boolean;
                  name: string;
                  objectCount: number;
                  objectSchemaId: string;
                  parentObjectTypeId?: number;
                  parentObjectTypeInherited: boolean;
                  position: number;
                  type?: number;
                  updated: Date;
                  workspaceId: string;
                  [key: string]: unknown;
              };
              options?: string;
              position: number;
              qlQuery?: string;
              referenceObjectType?: {
                  abstractObjectType: boolean;
                  created: Date;
                  description?: string;
                  globalId: string;
                  icon: {
                      id: string;
                      name: string;
                      url16: string;
                      url48: string;
                      [key: string]: unknown;
                  };
                  id: string;
                  inherited: boolean;
                  name: string;
                  objectCount: number;
                  objectSchemaId: string;
                  parentObjectTypeId?: number;
                  parentObjectTypeInherited: boolean;
                  position: number;
                  type?: number;
                  updated: Date;
                  workspaceId: string;
                  [key: string]: unknown;
              };
              referenceObjectTypeId?: string;
              referenceType?: {
                  cdmData?: {
                      types?: {
                          key?: string;
                          opinionated?: boolean;
                          version?: number;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  color?: string;
                  description?: string;
                  globalId: string;
                  id?: string;
                  name: string;
                  objectSchemaId?: string;
                  url16?: string;
                  workspaceId: string;
                  [key: string]: unknown;
              };
              regexValidation?: string;
              removable?: boolean;
              sortable?: boolean;
              suffix?: string;
              summable?: boolean;
              system?: boolean;
              type?: number;
              typeValue?: string;
              typeValueMulti?: string[];
              uniqueAttribute?: boolean;
              workspaceId: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility