The Assets REST API

Objecttypeattribute

Post objecttypeattribute {objectTypeId}

POST /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}

Create a new attribute on the given object type

Request

Path parameters

objectTypeId Required

string

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

Body parameters

Input entity to create an object type attribute

name Required

string

label

boolean

description

string

type Required

integer

Value	Description
0	Default
1	Object reference
2	User
4	Group
7	Status

defaultTypeId

integer

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

typeValue

string

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

typeValueMulti

Array<string>

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

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

minimumCardinality

integer

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

Default: 0

maximumCardinality

integer

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

Default: 1

suffix

string

Valid for Integer and Double object type attributes

includeChildObjectTypes

boolean

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

hidden

boolean

Hide the object type attributes for Assets Users

uniqueAttribute

boolean

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

summable

boolean

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

regexValidation

string

Valid for Type Text and Email

qlQuery

string

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

iql Deprecated

string

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

options

string

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

Example

cURL

Node.js

Java

Python

PHP

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

Responses

201

400

401

404

500

Content type	Value
application/json	ObjectTypeAttribute

Example response (application/json)

{
  "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 objecttypeattribute {objectTypeId} {id}

PUT /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}/{id}

Update an existing object type attribute

Request

Path parameters

id Required

string

The object type attribute to manipulate

objectTypeId Required

string

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

Body parameters

Input entity to update an object type attribute

name

string

label

boolean

description

string

type

integer

Value	Description
0	Default
1	Object reference
2	User
4	Group
7	Status

defaultTypeId

integer

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

typeValue

string

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

typeValueMulti

Array<string>

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

additionalValue

string

minimumCardinality

integer

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

Default: 0

maximumCardinality

integer

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

Default: 1

suffix

string

Valid for Integer and Double object type attributes

includeChildObjectTypes

boolean

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

hidden

boolean

Hide the object type attributes for Assets Users

uniqueAttribute

boolean

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

summable

boolean

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

regexValidation

string

Valid for Type Text and Email

qlQuery

string

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

iql Deprecated

string

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

options

string

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

Example

cURL

Node.js

Java

Python

PHP

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

Responses

200

400

401

404

500

Content type	Value
application/json	ObjectTypeAttribute

Example response (application/json)

{
  "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
}

Delete objecttypeattribute {id}

DELETE /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}

Delete an existing object type attribute

Request

Path parameters

id Required

string

The object type attribute id to be manipulated

Example

cURL

Node.js

Java

Python

PHP

1
2

curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}'

Responses

200

400

401

404

500

The object type attribute has been successfully deleted

A schema has not been defined for this response code.