Cloud

Assets / Guides / REST API

Objecttypeattribute

Postman Collection

OpenAPI

Operations

POST/objecttypeattribute/{objectTypeId}PUT/objecttypeattribute/{objectTypeId}/{id}DEL/objecttypeattribute/{id}

POST

Post objecttypeattribute {objectTypeId}

Create a new attribute on the given object type

Scopes

OAuth 2.0 scopes required:

write:cmdb-attribute:jira

Request

Path parameters

objectTypeId

string

Required

Request bodyapplication/json

name

string

Required

label

boolean

description

string

type

integer

Required

defaultTypeId

integer

typeValue

string

typeValueMulti

array<string>

additionalValue

string

minimumCardinality

integer

maximumCardinality

integer

Responses

application/json

ObjectTypeAttribute

The definition of the attribute that is associated with an object type

POST/objecttypeattribute/{objectTypeId}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Geolocation",
  "type": "0",
  "defaultTypeId": "0"
}'

201Response

{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330",
  "id": "1330",
  "name": "Geolocation",
  "label": false,
  "defaultType": {
    "id": 0,
    "name": "Text"
  },
  "editable": true,
  "system": false,
  "sortable": true,
  "summable": false,
  "indexed": true,
  "minimumCardinality": 0,
  "maximumCardinality": 1,
  "removable": true,
  "hidden": false,
  "includeChildObjectTypes": false,
  "uniqueAttribute": false,
  "options": "",
  "position": 6
}

PUT

Put objecttypeattribute {objectTypeId} {id}

Update an existing object type attribute

Scopes

OAuth 2.0 scopes required:

write:cmdb-attribute:jira

Request

Path parameters

string

Required

objectTypeId

string

Required

Request bodyapplication/json

name

string

label

boolean

description

string

type

integer

defaultTypeId

integer

typeValue

string

typeValueMulti

array<string>

additionalValue

string

minimumCardinality

integer

maximumCardinality

integer

Responses

application/json

ObjectTypeAttribute

The definition of the attribute that is associated with an object type

PUT/objecttypeattribute/{objectTypeId}/{id}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}/{id}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "GPS coordinates of the office"
}'

200Response

{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330",
  "id": "1330",
  "name": "Geolocation",
  "label": false,
  "defaultType": {
    "id": 0,
    "name": "Text"
  },
  "editable": true,
  "system": false,
  "sortable": true,
  "summable": false,
  "indexed": true,
  "minimumCardinality": 0,
  "maximumCardinality": 1,
  "removable": true,
  "hidden": false,
  "includeChildObjectTypes": false,
  "uniqueAttribute": false,
  "options": "",
  "position": 6
}

DEL

Delete objecttypeattribute {id}

Delete an existing object type attribute

Scopes

OAuth 2.0 scopes required:

delete:cmdb-attribute:jira

Request

Path parameters

string

Required

Responses

The object type attribute has been successfully deleted

DEL/objecttypeattribute/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}' \
  --header 'Authorization: Bearer <access_token>'