Rate this page:
POST /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}
Create a new attribute on the given object type
string
The object type id that has this object type attribute associated with it
Input entity to create an object type attribute
string
boolean
string
integer
Value | Description |
---|---|
0 | Default |
1 | Object reference |
2 | User |
4 | Group |
7 | Status |
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 | |
9 | Textarea |
10 | Select |
11 | IP Address |
string
It is mandatory for Type = Object reference and should point to the referenced object type id
Array<string>
Valid for Type User. The Jira groups to restrict selection to
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
integer
Valid for Type Email, Select, Object, User, Group, Version and Project
0
integer
Valid for Type Email, Select, Object, User, Group, Version and Project
1
string
Valid for Integer and Double object type attributes
boolean
Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
boolean
Hide the object type attributes for Assets Users
boolean
Should the values be unique for object attributes associated with this object type attribute
boolean
Valid for Type Integer and Double. Should a sum be included in the view
string
Valid for Type Text and Email
string
Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.
string
Deprecated. Use qlQuery
instead. Valid for Type object reference.
string
Valid for Type Select. A comma separated list of all chosable options
1 2 3 4 5 6 7 8 9
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"
}'
Content type | Value |
---|---|
application/json |
Example response (application/json)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
{
"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 /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}/{id}
Update an existing object type attribute
string
The object type attribute to manipulate
string
The object type id that has this object type attribute associated with it
Input entity to update an object type attribute
string
boolean
string
integer
Value | Description |
---|---|
0 | Default |
1 | Object reference |
2 | User |
4 | Group |
7 | Status |
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 | |
9 | Textarea |
10 | Select |
11 | IP Address |
string
It is mandatory for Type = Object reference and should point to the referenced object type id
Array<string>
Valid for Type User. The Jira groups to restrict selection to
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
integer
Valid for Type Email, Select, Object, User, Group, Version and Project
0
integer
Valid for Type Email, Select, Object, User, Group, Version and Project
1
string
Valid for Integer and Double object type attributes
boolean
Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well
boolean
Hide the object type attributes for Assets Users
boolean
Should the values be unique for object attributes associated with this object type attribute
boolean
Valid for Type Integer and Double. Should a sum be included in the view
string
Valid for Type Text and Email
string
Valid for Type object reference. Allows specifying an AQL query to restrict which objects are selectable.
string
Deprecated. Use qlQuery
instead. Valid for Type object reference.
string
Valid for Type Select. A comma separated list of all chosable options
1 2 3 4 5 6 7
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"
}'
Content type | Value |
---|---|
application/json |
Example response (application/json)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
{
"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 /jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}
Delete an existing object type attribute
string
The object type attribute id to be manipulated
1 2
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}'
The object type attribute has been successfully deleted
A schema has not been defined for this response code.
Rate this page: