Server
Jira Service Management / Reference / REST API

Assets - Object Schema

Postman Collection
Operations
POST/assets/1.0/objectschema/createGET/assets/1.0/objectschema/{id}PUT/assets/1.0/objectschema/{id}DEL/assets/1.0/objectschema/{id}GET/assets/1.0/objectschema/{id}/attributesGET/assets/1.0/objectschema/listGET/assets/1.0/objectschema/{id}/objecttypes/flat
POST

Create object schema

Create a new object schema.

Request

Request bodyapplication/json

The object schema to create.

name

string

Required
objectSchemaKey

string

Required
description

string

Responses

Returns the newly created object schema.

application/json

ObjectSchemaEntry
POST/assets/1.0/objectschema/create
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/create' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "objectSchemaKey": "<string>", "description": "<string>" }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 { "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 }
GET

Get object schema

Get a single object schema.

Request

Path parameters

id

string

Required

Responses

Returns the object schema.

application/json

ObjectSchemaEntry
GET/assets/1.0/objectschema/{id}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 }
PUT

Update object schema

Update an object schema.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The object schema to update.

id

integer

name

string

objectSchemaKey

string

status

string

description

string

created

string

updated

string

objectCount

integer

archivedObjectCount

integer

objectTypeCount

integer

Responses

Returns the updated object schema.

application/json

ObjectSchemaEntry
PUT/assets/1.0/objectschema/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request PUT \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/{id}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 }
DEL

Delete object schema

Deletes a single object schema.

Request

Path parameters

id

string

Required

Responses

Returns the deleted object schema

application/json

ObjectSchemaEntry
DEL/assets/1.0/objectschema/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 }
GET

Find all attributesDeprecated

Use /objecttypeattribute/find instead.

Find all object type attributes for this object schema.

Request

Path parameters

id

string

Required

Query parameters

query

string

extended

string

onlyValueEditable

string

Responses

Returns the matching object schemas.

application/json

ObjectTypeAttributeEntry
GET/assets/1.0/objectschema/{id}/attributes
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/{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>" } }
GET

Search object schemas

Searches for an object schema by name.

Request

Query parameters

query

string

Responses

Returns the matching object schemas.

application/json

ObjectSchemaListEntry
GET/assets/1.0/objectschema/list
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/list' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "objectschemas": [ { "id": 2154, "name": "<string>", "objectSchemaKey": "<string>", "status": "<string>", "description": "<string>", "created": "<string>", "updated": "<string>", "objectCount": 2154, "archivedObjectCount": 2154, "objectTypeCount": 2154 } ] }
GET

Get object types

Get a flat list of all object types belonging to a certain object schema.

Request

Path parameters

id

string

Required

Query parameters

role

string

query

string

exclude

string

Responses

Returns the list of object types

application/json

ObjectTypeEntry
GET/assets/1.0/objectschema/{id}/objecttypes/flat
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/objectschema/{id}/objecttypes/flat' \ --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 }

Rate this page: