• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / / REST API

Assets - Object Type

Postman Collection
OpenAPI
Operations
POST/assets/1.0/objecttype/{affectedId}/positionPOST/assets/1.0/objecttype/createGET/assets/1.0/objecttype/{id}PUT/assets/1.0/objecttype/{id}DEL/assets/1.0/objecttype/{id}GET/assets/1.0/objecttype/{id}/attributes
POST

Change object type position

Change the position of an object type in the object type hierarchy tree.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

affectedId

string

Required

Request bodyapplication/json

The new position of the object type.

toObjectTypeId

integer

position

integer

Responses

Returns the updated object type.

application/json

ObjectTypeEntry
POST/assets/1.0/objecttype/{affectedId}/position
1 2 3 4 5 6 7 8 curl --request POST \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/{affectedId}/position' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "toObjectTypeId": 2154, "position": 2154 }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }
POST

Create object type

Create a new object type.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

The new object type to create.

id

integer

name

string

description

string

iconId

integer

objectSchemaId

integer

parentObjectTypeId

integer

inherited

boolean

abstractObjectType

boolean

Responses

Returns the created object type.

application/json

ObjectTypeEntry
POST/assets/1.0/objecttype/create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --request POST \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/create' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 2154, "name": "<string>", "description": "<string>", "iconId": 2154, "objectSchemaId": 2154, "parentObjectTypeId": 2154, "inherited": true, "abstractObjectType": true }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }
GET

Get object type

Get a single object type.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Responses

Returns the requested object type.

application/json

ObjectTypeEntry
GET/assets/1.0/objecttype/{id}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }
PUT

Update object type

Update an existing object type.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Request bodyapplication/json

The object type to update.

id

integer

name

string

description

string

iconId

integer

objectSchemaId

integer

parentObjectTypeId

integer

inherited

boolean

abstractObjectType

boolean

Responses

Returns the updated object type.

application/json

ObjectTypeEntry
PUT/assets/1.0/objecttype/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 curl --request PUT \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/{id}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 2154, "name": "<string>", "description": "<string>", "iconId": 2154, "objectSchemaId": 2154, "parentObjectTypeId": 2154, "inherited": true, "abstractObjectType": true }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }
DEL

Delete object type

Delete an object type.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Responses

Returns the deleted object type.

application/json

ObjectTypeEntry
DEL/assets/1.0/objecttype/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }
GET

Find object type attributes

Find all object type attributes for this object type.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Query parameters

orderByRequired

string

orderByName

string

includeChildren

string

query

string

excludeParentAttributes

string

includeValueExist

string

onlyValueEditable

string

Responses

Returns a list of object type attributes.

application/json

ObjectTypeAttributeEntry
GET/assets/1.0/objecttype/{id}/attributes
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objecttype/{id}/attributes' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 { "id": 2154, "objectType": { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }, "name": "<string>", "label": true, "type": 2154, "description": "<string>", "defaultType": { "id": 2154, "name": "<string>" }, "typeValue": "<string>", "typeValueMulti": [ "<string>" ], "additionalValue": "<string>", "referenceType": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "description": "<string>", "color": "<string>", "url16": "<string>", "removable": true, "objectSchemaId": 2154 }, "referenceObjectTypeId": 2154, "referenceObjectType": { "id": 2154, "name": "<string>", "type": 2154, "description": "<string>", "icon": { "expand": "<string>", "project": "<string>", "position": "<string>", "after": "<string>", "id": 2154, "name": "<string>", "url16": "<string>", "url48": "<string>" }, "position": 2154, "created": "<string>", "updated": "<string>", "objectCount": 2154, "parentObjectTypeId": 2154, "objectSchemaId": 2154, "inherited": true, "abstractObjectType": true, "parentObjectTypeInherited": true }, "confluenceTypeValue": { "id": "<string>", "name": "<string>", "uri": "<string>", "error": true }, "confluenceAddValue": { "key": "<string>", "name": "<string>", "error": true }, "versionTypeValues": [ { "avatarUrl": "<string>", "id": 2154, "name": "<string>", "key": "<string>", "url": "<string>" } ], "editable": true, "system": true, "sortable": true, "summable": true, "indexed": true, "minimumCardinality": 2154, "maximumCardinality": 2154, "suffix": "<string>", "removable": true, "objectAttributeExists": true, "hidden": true, "includeChildObjectTypes": true, "uniqueAttribute": true, "regexValidation": "<string>", "qlQuery": "<string>", "options": "<string>", "position": 2154, "iql": "<string>", "versionTypeValue": { "avatarUrl": "<string>", "id": 2154, "name": "<string>", "key": "<string>", "url": "<string>" } }

Rate this page: