ATatlassian

Changed on

Update an existing object type attribute

put/objecttypeattribute/{objectTypeId}/{id}

Request

  • Base URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1
  • URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1/objecttypeattribute/{objectTypeId}/{id}
  • Auth
    • OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:cmdb-attribute:jira
    • or HTTP bearer

Request body

namestring
displayNamestring
labelboolean
descriptionstring
typeinteger
ValueDescription
0Default
1Object reference
2User
4Group
7Status
defaultTypeIdinteger
IdDescription (mandatory if type = Default)
-1None
0Text
1Integer
2Boolean
3Double
4Date
5Time
6DateTime
7Url
8Email
9Textarea
10Select
11IP Address
typeValuestring

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

typeValueMultistring[]

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

additionalValuestring

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

minimumCardinalityinteger

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

maximumCardinalityinteger

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

suffixstring

Valid for Integer and Double object type attributes

includeChildObjectTypesboolean

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

hiddenboolean

Hide the object type attributes for Assets Users

uniqueAttributeboolean

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

summableboolean

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

regexValidationstring

Valid for Type Text and Email

qlQuerystring

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

iqlstring

Deprecated. Use qlQuery instead. Valid for Type object reference.

optionsstring

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

Response

workspaceIdstring required
globalIdstring required
idstring required
namestring
displayNamestring
labelboolean required
typeinteger
ValueDescription
0Default
1Object reference
2User
4Group
7Status
descriptionstring
typeValuestring
typeValueMultistring[]
additionalValuestring
referenceObjectTypeIdstring
editableboolean
systemboolean
indexedboolean required

Describes if this object type attribute is indexed. For an indexed attribute the AQL search will be faster, but this will affect memory consumption.

sortableboolean
summableboolean
minimumCardinalityinteger
maximumCardinalityinteger
suffixstring
removableboolean
objectAttributeExistsboolean
hiddenboolean
includeChildObjectTypesboolean
uniqueAttributeboolean
regexValidationstring
iqlstring

Deprecated. Use qlQuery instead.

qlQuerystring
optionsstring
positioninteger required

Changes

  • 83fc72ce3b1eRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status