Assets REST API Reference

Assets 10.7.0

This is the reference document for the REST API and resources provided by Assets. REST APIs are for developers who want to integrate Assets with other standalone or web applications, and for administrators who want to script interactions with Assets on their Jira server. Because the REST API is based on open standards, you can use any web development language to access the API.

Assets is built upon the Jira platform. As such, there is a natural overlap in functionality between what is provided by Assets and what is provided by the Jira platform. If you are after an introductory, high-level view of Jira REST APIs, then the best place to start is Jira REST API home.

Using the REST API

Not familiar with the Assets REST API? Start with Getting started with Assets, which will help you get an understanding of Assets in Jira Service Management.

If you want instructions on how to use the REST APIs, check out the Appendix at the end of this page, where you'll find information on the following topics:

Experimental methods

To use experimental methods, you must set this header in your requests: X-ExperimentalApi : true. This indicates that you are opting into the experimental preview. Once a resource or method moves out of the experimental phase, then this header will no longer be required nor checked.

Note that methods marked as experimental may change without notice.

We welcome any feedback on these experimental methods. Share your comments and suggestions in our Developer Community.

Deprecated methods

Methods marked as deprecated are no longer supported. We recommended using alternative methods as these methods may be removed in future releases. For more information on alternative methods, refer to the method's description.

Resources

aql

Resource dedicated to finding objects based on the Assets Query Language (AQL)

Find objects using AQL.

Request
query parameters
ParameterTypeDescription
iqlstring

Default:

Deprecated parameter, use the qlQuery parameter instead.

The query to determine which objects that should be fetched. For example, objectType = "Computer". An empty query means all objects are fetched.

qlQuerystring

Default:

The query to determine which objects should be fetched. For example, objectType = "Computer". An empty query means all objects are fetched.

objectSchemaIdstring

Deprecated parameter, add objectSchemaId to the AQL instead.

Limit the scope of objects to find based on this schema. This is a multi-query parameter so multiple instances may be included to filter on multiple object schemas.

pageint

Default: 1

The page to fetch when paginating through the response.

orderByAttributeIdint

Deprecated parameter, use order by clause in AQL instead. Learn more about ordering in AQL.

The object type attribute ID to be used for ordering the result. It is of importance when paginating through a response.

orderAscboolean

Default: true

Deprecated parameter, use order by clause in AQL instead. Learn more about ordering in AQL.

Used in conjunction with the orderByAttributeId parameter to determine the sorting direction. If the value is set to true, objects are sorted in ascending order.

resultPerPageint

Default: 25

The number of objects returned per page.

includeAttributesboolean

Default: true

Should object attributes be included in the response. If this parameter is set to false, only the information on the object will be returned and object attributes will not be present.

includeAttributesDeepint

Default: 1

How many levels of attributes should be included in the response.

Example:

Consider object A, which has a reference to object B, which has a reference to object C. If object A is included in the response and includeAttributesDeep=1, object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if includeAttributesDeep=2, then object B's reference to object C will be included in object B's attributes.

includeTypeAttributesboolean

Default: false

Should the response include the object type attribute definition for each attribute that is returned with the objects.

includeExtendedInfoboolean

Default: false

Should the response include information about open issues and attachments. If the value is set to true, each returned object contains information on whether there are open tickets connected to it and if the object has attachments.

extendedboolean

Deprecated parameter, use includeTypeAttributes instead.

Responses
    • Status 200 - application/json

      Example
      {"objectEntries":[{"id":1,"label":"Example Object","objectKey":"TEST-1","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":1},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T08:06:45.478Z","updated":"2019-11-26T08:07:08.063Z","hasAvatar":false,"timestamp":1574755628063,"attributes":[{"id":3,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-1","searchValue":"TEST-1","displayValue":"TEST-1","referencedType":false}],"objectId":1},{"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Example Object","searchValue":"Example Object","displayValue":"Example Object","referencedType":false}],"objectId":1},{"id":4,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T08:06:45.478Z","searchValue":"2019-11-26T08:06:45.478Z","displayValue":"26/Nov/19 9:06 AM","referencedType":false}],"objectId":1},{"id":5,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T08:07:08.063Z","searchValue":"2019-11-26T08:07:08.063Z","displayValue":"26/Nov/19 9:07 AM","referencedType":false}],"objectId":1},{"id":1,"objectTypeAttributeId":5,"objectAttributeValues":[{"value":"2019-11-29","searchValue":"2019-11-29","displayValue":"29/Nov/19","referencedType":false}],"objectId":1},{"id":2,"objectTypeAttributeId":6,"objectAttributeValues":[{"value":"2019-10-01T08:06:00.000Z","searchValue":"2019-10-01T08:06:00.000Z","displayValue":"01/Oct/19 10:06 AM","referencedType":false}],"objectId":1}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=1"},"name":"Example Object"},{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-26T09:22:39.323Z","hasAvatar":false,"timestamp":1574760159323,"attributes":[{"id":7,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-2","searchValue":"TEST-2","displayValue":"TEST-2","referencedType":false}],"objectId":2},{"id":10,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Hello","searchValue":"Hello","displayValue":"Hello","referencedType":false}],"objectId":2},{"id":8,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"id":9,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"objectTypeAttributeId":5,"objectAttributeValues":[],"objectId":2},{"objectTypeAttributeId":6,"objectAttributeValues":[],"objectId":2}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"}],"objectTypeAttributes":[{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5}],"objectTypeId":0,"objectTypeIsInherited":false,"abstractObjectType":false,"totalFilterCount":2,"startIndex":1,"toIndex":2,"pageObjectSize":25,"pageNumber":1,"orderWay":"ascending","iql":"","qlQuery":"","iqlSearchResult":true,"qlQuerySearchResult":true,"conversionPossible":false,"pageSize":1}

      An object result set that can be used to paginate through the result list of objects.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-list-result-entry#","title":"Object List Result Entry","type":"object","properties":{"objectEntries":{"type":"array","items":{"$ref":"#/definitions/object-entry"}},"objectTypeAttributes":{"type":"array","items":{"$ref":"#/definitions/object-type-attribute-entry"}},"objectTypeId":{"type":"integer"},"objectTypeIsInherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"totalFilterCount":{"type":"integer"},"startIndex":{"type":"integer"},"toIndex":{"type":"integer"},"pageObjectSize":{"type":"integer"},"pageNumber":{"type":"integer"},"orderByTypeAttrId":{"type":"integer"},"orderWay":{"type":"string"},"filters":{"type":"array","items":{"title":"Object Filter Values Entry","type":"object","properties":{"objectTypeAttributeId":{"type":"integer"},"selectedValues":{"type":"array","items":{"type":"string"}},"filterByObjectType":{"type":"boolean"}},"additionalProperties":false,"required":["objectTypeAttributeId"]}},"qlQuery":{"type":"string"},"qlQuerySearchResult":{"type":"boolean"},"conversionPossible":{"type":"boolean"},"matchedFilterValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"inheritanceTree":{"title":"Object Type Inheritance Tree Entry","type":"object","properties":{"parentObjectTypeIdsInclSelf":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false}},"additionalProperties":false},"iql":{"type":"string"},"iqlSearchResult":{"type":"boolean"},"pageSize":{"type":"integer"}},"definitions":{"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"$ref":"#/definitions/object-entry"},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-entry":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["objectTypeId","objectTypeIsInherited","abstractObjectType","totalFilterCount","startIndex","toIndex","pageObjectSize","pageNumber","pageSize"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

attachments

Delete an attachment by attachment ID.

Responses
    • Status 200 - application/json
      Returns the attachment.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/attachment-entry#","title":"Attachment Entry","type":"object","properties":{"id":{"type":"integer"},"author":{"type":"string"},"mimeType":{"type":"string"},"filename":{"type":"string"},"filesize":{"type":"string"},"created":{"type":"object"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}

    • Status 401
      Returned if the user is not logged in.
    • Status 403
      Returned if the user does not have permission to get an attachment.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Add an attachment to an object by object ID.

Responses
    • Status 200 - application/json

      Example
      [{"id":1,"author":"admin","mimeType":"image/png","filename":"astronaut.png","filesize":"490 B","created":"2019-11-27T11:42:22.283Z","comment":"","commentOutput":"","url":"http://jira/rest/insight/1.0/attachments/1"}]

      Returns the attachments for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-attachment-entry#","title":"List of Attachment Entry","type":"array","items":{"title":"Attachment Entry","type":"object","properties":{"id":{"type":"integer"},"author":{"type":"string"},"mimeType":{"type":"string"},"filename":{"type":"string"},"filesize":{"type":"string"},"created":{"type":"object"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}}

    • Status 401
      Returned if the user is not logged in.
    • Status 403
      Returned if the user does not have permission to get an attachment.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Get the attachments for an object by object ID.

Responses
    • Status 200 - application/json

      Example
      [{"id":1,"author":"admin","mimeType":"image/png","filename":"astronaut.png","filesize":"490 B","created":"2019-11-27T11:42:22.283Z","comment":"","commentOutput":"","url":"http://jira/rest/insight/1.0/attachments/1"}]

      Returns the attachments for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-attachment-entry#","title":"List of Attachment Entry","type":"array","items":{"title":"Attachment Entry","type":"object","properties":{"id":{"type":"integer"},"author":{"type":"string"},"mimeType":{"type":"string"},"filename":{"type":"string"},"filesize":{"type":"string"},"created":{"type":"object"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}}

    • Status 401
      Returned if the user is not logged in.
    • Status 403
      Returned if the user does not have permission to get an attachment.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

comment

Create a comment.

Request

Example
{"comment":"A comment to be added","objectId":1,"role":0}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/comment-entry#","title":"Comment Entry","type":"object","properties":{"created":{"type":"object"},"updated":{"type":"object"},"id":{"type":"integer"},"actor":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"role":{"type":"integer"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"objectId":{"type":"integer"},"canEdit":{"type":"boolean"},"canDelete":{"type":"boolean"}},"additionalProperties":false,"required":["role","canEdit","canDelete"]}

Responses
    • Status 200 - application/json

      Example
      {"created":"2019-11-27T12:37:41.492Z","updated":"2019-11-27T12:37:41.492Z","id":1,"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"role":0,"comment":"A comment to be added","commentOutput":"A comment to be added","objectId":1,"canEdit":true,"canDelete":true}

      Returns the created comment.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/comment-entry#","title":"Comment Entry","type":"object","properties":{"created":{"type":"object"},"updated":{"type":"object"},"id":{"type":"integer"},"actor":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"role":{"type":"integer"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"objectId":{"type":"integer"},"canEdit":{"type":"boolean"},"canDelete":{"type":"boolean"}},"additionalProperties":false,"required":["role","canEdit","canDelete"]}

    • Status 401
      Returned if the user is not logged in.
    • Status 403
      Returned if the user does not have permission to get an attachment.
    • Status 404
      Returned if the customer request does not exist.

Get the comments for an object by object ID.

Request
query parameters
ParameterTypeDescription
ascboolean

Whether to sort ascending.

Responses
    • Status 200 - application/json

      Example
      [{"created":"2019-11-27T12:37:41.492Z","updated":"2019-11-27T12:37:41.492Z","id":1,"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"role":0,"comment":"A comment to be added","commentOutput":"A comment to be added","objectId":1,"canEdit":true,"canDelete":true}]

      Returns the comments for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-comment-entry#","title":"List of Comment Entry","type":"array","items":{"title":"Comment Entry","type":"object","properties":{"created":{"type":"object"},"updated":{"type":"object"},"id":{"type":"integer"},"actor":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"role":{"type":"integer"},"comment":{"type":"string"},"commentOutput":{"type":"string"},"objectId":{"type":"integer"},"canEdit":{"type":"boolean"},"canDelete":{"type":"boolean"}},"additionalProperties":false,"required":["role","canEdit","canDelete"]}}

    • Status 401
      Returned if the user is not logged in.
    • Status 403
      Returned if the user does not have permission to get an attachment.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

config/statustype

Resource to handle the Assets statuses

Find status types for a given object schema ID.

Request
query parameters
ParameterTypeDescription
objectSchemaIdint

Include statuses for the object schema ID. If this parameter is supplied, statuses for the given object schema will be returned. Otherwise all global statuses will be returned.

Responses
    • Status 200 - application/json

      Example
      [{"id":5,"name":"Action Needed","category":2},{"id":1,"name":"Active","category":1},{"id":7,"name":"Closed","category":0},{"id":3,"name":"In Service","category":2},{"id":2,"name":"Running","category":1},{"id":6,"name":"Stopped","category":0},{"id":4,"name":"Support Requested","category":2}]

      Returns a list of status types for the request object schema.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-status-type-entry#","title":"List of Status Type Entry","type":"array","items":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Store a new status type.

Request

Example
{"name":"My action","category":2}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/status-type-entry#","title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}

Responses
    • Status 201 - application/json

      Example
      {"id":5,"name":"Action Needed","category":2}

      Returns the new status type.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/status-type-entry#","title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Retrieve details on a given status.

Responses
    • Status 200 - application/json

      Example
      {"id":5,"name":"Action Needed","category":2}

      Returns status details.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/status-type-entry#","title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Delete a single status type.

Responses
    • Status 200 - application/json
    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      The status type was not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Update an existing status type.

Request

Example
{"name":"My action","category":2}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/status-type-entry#","title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}

Responses
    • Status 200 - application/json

      Example
      {"id":5,"name":"Action Needed","category":2}

      Returns the updated status type.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/status-type-entry#","title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      The status type was not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

icon

Load and find icons.

Load a single icon by ID.

Responses
    • Status 200 - application/json

      Example
      {"id":1,"name":"Delete","url16":"http://jira/rest/insight/1.0/icon/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/icon/1/icon.png?size=48"}

      Returns the icon object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/icon-entry#","title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404

      Example
      {"errorMessages":["NotFoundInsightException: Could not find Icon with id: 999"],"errors":{}}

      Icon can not be found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Find all global icons i.e. icons not associated with a particular object schema.

Responses
    • Status 200 - application/json

      Example
      [{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/icon/25/icon.png?size=16","url48":"http://jira/rest/insight/1.0/icon/25/icon.png?size=48"},{"id":56,"name":"AV Receiver","url16":"http://jira/rest/insight/1.0/icon/56/icon.png?size=16","url48":"http://jira/rest/insight/1.0/icon/56/icon.png?size=48"},{"id":91,"name":"Active Directory","url16":"http://jira/rest/insight/1.0/icon/91/icon.png?size=16","url48":"http://ljira/rest/insight/1.0/icon/91/icon.png?size=48"}]

      Returns the array of all existing global icons.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-icon-entry#","title":"List of Icon Entry","type":"array","items":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Find all icons associated with an object schema. This resource will not include global icons.

Responses
    • Status 200 - application/json

      Example
      [{"id":143,"name":"Assets","url16":"http://jira/rest/insight/1.0/icon/143/icon.png?size=16","url48":"http://jira/rest/insight/1.0/icon/143/icon.png?size=48"}]

      Returns the array of icon objects.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-icon-entry#","title":"List of Icon Entry","type":"array","items":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

object

Load or manipulate individual objects. If multiple objects are to be returned, use the AQL endpoint instead.Show more

Retrieve the history entries for this object.

Request
query parameters
ParameterTypeDescription
ascboolean

Should the history be retrieved in ascending order. Uses the Jira setting for sort order as its default value.

abbreviateboolean

Default: true

Should the values returned in the history entry be abbreviated.

Responses
    • Status 200 - application/json

      Example
      [{"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"id":1,"type":0,"created":"2019-11-26T08:06:45.520Z","objectId":1},{"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"id":2,"affectedAttribute":"Date Attribute","oldValue":"Tue, 5 Nov 2019","newValue":"Sat, 30 Nov 2019","type":2,"created":"2019-11-26T08:06:56.131Z","objectId":1},{"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"id":3,"affectedAttribute":"Date Attribute","oldValue":"Sat, 30 Nov 2019","newValue":"Fri, 29 Nov 2019","type":2,"created":"2019-11-26T08:07:08.072Z","objectId":1},{"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"id":5,"affectedAttribute":"Name","oldValue":"Example Object","newValue":"IPhone","type":2,"created":"2019-11-26T19:52:09.971Z","objectId":1},{"actor":{"avatarUrl":"https://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028?d=mm&s=48","displayName":"admin","name":"admin","key":"admin","renderedLink":"<a class=\"user-hover\" rel=\"admin\" id=\"_admin\" href=\"/jira/secure/ViewProfile.jspa?name=admin\">admin</a>","isDeleted":false},"id":6,"affectedAttribute":"Reference","oldValue":"","newValue":"Hello","type":4,"created":"2019-11-26T20:16:02.956Z","objectId":1}]

      Returns a list of history entries for the requested object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-object-history-entry#","title":"List of Object History Entry","type":"array","items":{"title":"Object History Entry","type":"object","properties":{"actor":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"id":{"type":"integer"},"affectedAttribute":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"},"type":{"type":"integer"},"created":{"type":"object"},"objectId":{"type":"integer"},"importSourceId":{"type":"integer"}},"additionalProperties":false}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Find all inbound references for an object.

Responses
    • Status 200 - application/json

      Example
      [{"referenceTypes":[{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false}],"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"numberOfReferencedObjects":1,"openIssuesExists":false}]

      Returns a list of references for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-reference-type-object-info-entry#","title":"List of Reference Type Object Info Entry","type":"array","items":{"title":"Reference Type Object Info Entry","type":"object","properties":{"referenceTypes":{"type":"array","items":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]}},"objectType":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"numberOfReferencedObjects":{"type":"integer"},"openIssuesExists":{"type":"boolean"}},"additionalProperties":false}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Create a new object in Assets.

Request

Example
{"objectTypeId":1,"attributes":[{"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Hello"}]}]}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-in-entry#","title":"Object In Entry","type":"object","properties":{"objectTypeId":{"type":"integer"},"attributes":{"type":"array","items":{"title":"Object Attribute In Entry","type":"object","properties":{"objectId":{"type":"integer"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value In Entry","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"operationType":{"type":"integer"}},"additionalProperties":false,"required":["operationType"]}}},"additionalProperties":false}

Responses
    • Status 201 - application/json

      Example
      {"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-26T09:22:39.323Z","hasAvatar":false,"timestamp":1574760159323,"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"}

      An example of creating an object with the name set to "Hello" and where the Name attribute's ID is set to 2 and the object type ID is 1.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-entry#","title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"definitions":{"avatar-entry":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"link-entry":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-extended-entry":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["hasAvatar","timestamp"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Retrieve a list of objects based on an AQL query.

Request

Example
{"objectTypeId":"499497","attributesToDisplay":{"attributesToDisplayIds":[]},"page":1,"asc":1,"resultsPerPage":25,"includeAttributes":false,"objectSchemaId":"59271","qlQuery":""}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-iql-filter-param-entry#","title":"Object IQL Filter Param Entry","type":"object","properties":{"page":{"type":"integer"},"asc":{"type":"integer"},"objectTypeId":{"type":"integer"},"objectId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"qlQuery":{"type":"string"},"resultsPerPage":{"type":"integer"},"orderByTypeAttrId":{"type":"integer"},"includeAttributes":{"type":"boolean"},"attributesToDisplay":{"title":"Object Type Attributes To Display Entry","type":"object","properties":{"attributesToDisplayIds":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false},"iql":{"type":"string"}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"objectEntries":[{"id":1,"label":"Example Object","objectKey":"TEST-1","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":1},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T08:06:45.478Z","updated":"2019-11-26T08:07:08.063Z","hasAvatar":false,"timestamp":1574755628063,"attributes":[{"id":3,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-1","searchValue":"TEST-1","displayValue":"TEST-1","referencedType":false}],"objectId":1},{"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Example Object","searchValue":"Example Object","displayValue":"Example Object","referencedType":false}],"objectId":1},{"id":4,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T08:06:45.478Z","searchValue":"2019-11-26T08:06:45.478Z","displayValue":"26/Nov/19 9:06 AM","referencedType":false}],"objectId":1},{"id":5,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T08:07:08.063Z","searchValue":"2019-11-26T08:07:08.063Z","displayValue":"26/Nov/19 9:07 AM","referencedType":false}],"objectId":1},{"id":1,"objectTypeAttributeId":5,"objectAttributeValues":[{"value":"2019-11-29","searchValue":"2019-11-29","displayValue":"29/Nov/19","referencedType":false}],"objectId":1},{"id":2,"objectTypeAttributeId":6,"objectAttributeValues":[{"value":"2019-10-01T08:06:00.000Z","searchValue":"2019-10-01T08:06:00.000Z","displayValue":"01/Oct/19 10:06 AM","referencedType":false}],"objectId":1}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=1"},"name":"Example Object"},{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-26T09:22:39.323Z","hasAvatar":false,"timestamp":1574760159323,"attributes":[{"id":7,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-2","searchValue":"TEST-2","displayValue":"TEST-2","referencedType":false}],"objectId":2},{"id":10,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Hello","searchValue":"Hello","displayValue":"Hello","referencedType":false}],"objectId":2},{"id":8,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"id":9,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"objectTypeAttributeId":5,"objectAttributeValues":[],"objectId":2},{"objectTypeAttributeId":6,"objectAttributeValues":[],"objectId":2}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"}],"objectTypeAttributes":[{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5}],"objectTypeId":0,"objectTypeIsInherited":false,"abstractObjectType":false,"totalFilterCount":2,"startIndex":1,"toIndex":2,"pageObjectSize":25,"pageNumber":1,"orderWay":"ascending","iql":"","qlQuery":"","iqlSearchResult":true,"qlQuerySearchResult":true,"conversionPossible":false,"pageSize":1}

      Returns the navlist response and the objects matching the query.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-list-result-entry#","title":"Object List Result Entry","type":"object","properties":{"objectEntries":{"type":"array","items":{"$ref":"#/definitions/object-entry"}},"objectTypeAttributes":{"type":"array","items":{"$ref":"#/definitions/object-type-attribute-entry"}},"objectTypeId":{"type":"integer"},"objectTypeIsInherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"totalFilterCount":{"type":"integer"},"startIndex":{"type":"integer"},"toIndex":{"type":"integer"},"pageObjectSize":{"type":"integer"},"pageNumber":{"type":"integer"},"orderByTypeAttrId":{"type":"integer"},"orderWay":{"type":"string"},"filters":{"type":"array","items":{"title":"Object Filter Values Entry","type":"object","properties":{"objectTypeAttributeId":{"type":"integer"},"selectedValues":{"type":"array","items":{"type":"string"}},"filterByObjectType":{"type":"boolean"}},"additionalProperties":false,"required":["objectTypeAttributeId"]}},"qlQuery":{"type":"string"},"qlQuerySearchResult":{"type":"boolean"},"conversionPossible":{"type":"boolean"},"matchedFilterValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"inheritanceTree":{"title":"Object Type Inheritance Tree Entry","type":"object","properties":{"parentObjectTypeIdsInclSelf":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false}},"additionalProperties":false},"iql":{"type":"string"},"iqlSearchResult":{"type":"boolean"},"pageSize":{"type":"integer"}},"definitions":{"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"$ref":"#/definitions/object-entry"},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-entry":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["objectTypeId","objectTypeIsInherited","abstractObjectType","totalFilterCount","startIndex","toIndex","pageObjectSize","pageNumber","pageSize"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Deprecated. Use /navlist/aql.

Request

Example
{"objectTypeId":"499497","attributesToDisplay":{"attributesToDisplayIds":[]},"page":1,"asc":1,"resultsPerPage":25,"includeAttributes":false,"objectSchemaId":"59271","qlQuery":""}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-iql-filter-param-entry#","title":"Object IQL Filter Param Entry","type":"object","properties":{"page":{"type":"integer"},"asc":{"type":"integer"},"objectTypeId":{"type":"integer"},"objectId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"qlQuery":{"type":"string"},"resultsPerPage":{"type":"integer"},"orderByTypeAttrId":{"type":"integer"},"includeAttributes":{"type":"boolean"},"attributesToDisplay":{"title":"Object Type Attributes To Display Entry","type":"object","properties":{"attributesToDisplayIds":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false},"iql":{"type":"string"}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"objectEntries":[{"id":1,"label":"Example Object","objectKey":"TEST-1","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":1},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T08:06:45.478Z","updated":"2019-11-26T08:07:08.063Z","hasAvatar":false,"timestamp":1574755628063,"attributes":[{"id":3,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-1","searchValue":"TEST-1","displayValue":"TEST-1","referencedType":false}],"objectId":1},{"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Example Object","searchValue":"Example Object","displayValue":"Example Object","referencedType":false}],"objectId":1},{"id":4,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T08:06:45.478Z","searchValue":"2019-11-26T08:06:45.478Z","displayValue":"26/Nov/19 9:06 AM","referencedType":false}],"objectId":1},{"id":5,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T08:07:08.063Z","searchValue":"2019-11-26T08:07:08.063Z","displayValue":"26/Nov/19 9:07 AM","referencedType":false}],"objectId":1},{"id":1,"objectTypeAttributeId":5,"objectAttributeValues":[{"value":"2019-11-29","searchValue":"2019-11-29","displayValue":"29/Nov/19","referencedType":false}],"objectId":1},{"id":2,"objectTypeAttributeId":6,"objectAttributeValues":[{"value":"2019-10-01T08:06:00.000Z","searchValue":"2019-10-01T08:06:00.000Z","displayValue":"01/Oct/19 10:06 AM","referencedType":false}],"objectId":1}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=1"},"name":"Example Object"},{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-26T09:22:39.323Z","hasAvatar":false,"timestamp":1574760159323,"attributes":[{"id":7,"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-2","searchValue":"TEST-2","displayValue":"TEST-2","referencedType":false}],"objectId":2},{"id":10,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Hello","searchValue":"Hello","displayValue":"Hello","referencedType":false}],"objectId":2},{"id":8,"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"id":9,"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"objectTypeAttributeId":5,"objectAttributeValues":[],"objectId":2},{"objectTypeAttributeId":6,"objectAttributeValues":[],"objectId":2}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"}],"objectTypeAttributes":[{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5}],"objectTypeId":0,"objectTypeIsInherited":false,"abstractObjectType":false,"totalFilterCount":2,"startIndex":1,"toIndex":2,"pageObjectSize":25,"pageNumber":1,"orderWay":"ascending","iql":"","qlQuery":"","iqlSearchResult":true,"qlQuerySearchResult":true,"conversionPossible":false,"pageSize":1}

      Returns the navlist response and the objects matching the query.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-list-result-entry#","title":"Object List Result Entry","type":"object","properties":{"objectEntries":{"type":"array","items":{"$ref":"#/definitions/object-entry"}},"objectTypeAttributes":{"type":"array","items":{"$ref":"#/definitions/object-type-attribute-entry"}},"objectTypeId":{"type":"integer"},"objectTypeIsInherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"totalFilterCount":{"type":"integer"},"startIndex":{"type":"integer"},"toIndex":{"type":"integer"},"pageObjectSize":{"type":"integer"},"pageNumber":{"type":"integer"},"orderByTypeAttrId":{"type":"integer"},"orderWay":{"type":"string"},"filters":{"type":"array","items":{"title":"Object Filter Values Entry","type":"object","properties":{"objectTypeAttributeId":{"type":"integer"},"selectedValues":{"type":"array","items":{"type":"string"}},"filterByObjectType":{"type":"boolean"}},"additionalProperties":false,"required":["objectTypeAttributeId"]}},"qlQuery":{"type":"string"},"qlQuerySearchResult":{"type":"boolean"},"conversionPossible":{"type":"boolean"},"matchedFilterValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"inheritanceTree":{"title":"Object Type Inheritance Tree Entry","type":"object","properties":{"parentObjectTypeIdsInclSelf":{"type":"object","patternProperties":{".+":{"type":"array","items":{"type":"integer"}}},"additionalProperties":false}},"additionalProperties":false},"iql":{"type":"string"},"iqlSearchResult":{"type":"boolean"},"pageSize":{"type":"integer"}},"definitions":{"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"$ref":"#/definitions/object-entry"},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-entry":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["objectTypeId","objectTypeIsInherited","abstractObjectType","totalFilterCount","startIndex","toIndex","pageObjectSize","pageNumber","pageSize"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Update an existing object in Assets.

Request

Example
{"objectTypeId":1,"attributes":[{"objectTypeAttributeId":7,"objectAttributeValues":[{"value":"TEST-1"},{"value":"TEST-2"}]}]}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-in-entry#","title":"Object In Entry","type":"object","properties":{"objectTypeId":{"type":"integer"},"attributes":{"type":"array","items":{"title":"Object Attribute In Entry","type":"object","properties":{"objectId":{"type":"integer"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value In Entry","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"operationType":{"type":"integer"}},"additionalProperties":false,"required":["operationType"]}}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-27T07:12:36.215Z","hasAvatar":false,"timestamp":1574838756215,"attributes":[{"id":7,"objectTypeAttribute":{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-2","searchValue":"TEST-2","displayValue":"TEST-2","referencedType":false}],"objectId":2},{"id":10,"objectTypeAttribute":{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"Hello","searchValue":"Hello","displayValue":"Hello","referencedType":false}],"objectId":2},{"id":8,"objectTypeAttribute":{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T09:22:39.323Z","searchValue":"2019-11-26T09:22:39.323Z","displayValue":"26/Nov/19 10:22 AM","referencedType":false}],"objectId":2},{"id":9,"objectTypeAttribute":{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-27T07:12:36.215Z","searchValue":"2019-11-27T07:12:36.215Z","displayValue":"27/Nov/19 8:12 AM","referencedType":false}],"objectId":2},{"objectTypeAttribute":{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},"objectTypeAttributeId":5,"objectAttributeValues":[],"objectId":2},{"objectTypeAttribute":{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5},"objectTypeAttributeId":6,"objectAttributeValues":[],"objectId":2},{"id":12,"objectTypeAttribute":{"id":7,"name":"Reference","label":false,"type":1,"referenceType":{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false},"referenceObjectTypeId":1,"referenceObjectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":-1,"suffix":"","removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"regexValidation":"","iql":"","qlQuery":"","options":"","position":6},"objectTypeAttributeId":7,"objectAttributeValues":[{"referencedObject":{"id":1,"label":"IPhone","objectKey":"TEST-1","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":1},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T08:06:45.478Z","updated":"2019-11-26T20:16:02.951Z","hasAvatar":false,"timestamp":1574799362951,"_links":{"self":"http://jira/secure/ShowObject.jspa?id=1"},"name":"IPhone"},"searchValue":"TEST-1","displayValue":"IPhone","referencedType":true},{"referencedObject":{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-27T07:12:36.215Z","hasAvatar":false,"timestamp":1574838756215,"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"},"searchValue":"TEST-2","displayValue":"Hello","referencedType":true}],"objectId":2}],"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"}

      Returns the updated object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-entry#","title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"definitions":{"avatar-entry":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"link-entry":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-extended-entry":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["hasAvatar","timestamp"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Load one object.

Request
query parameters
ParameterTypeDescription
includeAttributesboolean

Default: true

Should the attributes be included in the response.

includeExtendedInfoboolean

Default: true

Should the extended info be included in the response.

Responses
    • Status 200 - application/json

      Example
      {"id":1,"label":"IPhone","objectKey":"TEST-1","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":1},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T08:06:45.478Z","updated":"2019-11-26T20:16:02.951Z","hasAvatar":false,"timestamp":1574799362951,"attributes":[{"id":3,"objectTypeAttribute":{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-1","searchValue":"TEST-1","displayValue":"TEST-1","referencedType":false}],"objectId":1},{"id":6,"objectTypeAttribute":{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"IPhone","searchValue":"IPhone","displayValue":"IPhone","referencedType":false}],"objectId":1},{"id":4,"objectTypeAttribute":{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T08:06:45.478Z","searchValue":"2019-11-26T08:06:45.478Z","displayValue":"26/Nov/19 9:06 AM","referencedType":false}],"objectId":1},{"id":5,"objectTypeAttribute":{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T20:16:02.951Z","searchValue":"2019-11-26T20:16:02.951Z","displayValue":"26/Nov/19 9:16 PM","referencedType":false}],"objectId":1},{"id":1,"objectTypeAttribute":{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},"objectTypeAttributeId":5,"objectAttributeValues":[{"value":"2019-11-29","searchValue":"2019-11-29","displayValue":"29/Nov/19","referencedType":false}],"objectId":1},{"id":2,"objectTypeAttribute":{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5},"objectTypeAttributeId":6,"objectAttributeValues":[{"value":"2019-10-01T08:06:00.000Z","searchValue":"2019-10-01T08:06:00.000Z","displayValue":"01/Oct/19 10:06 AM","referencedType":false}],"objectId":1},{"id":11,"objectTypeAttribute":{"id":7,"name":"Reference","label":false,"type":1,"referenceType":{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false},"referenceObjectTypeId":1,"referenceObjectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":-1,"suffix":"","removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"regexValidation":"","iql":"","qlQuery":"","options":"","position":6},"objectTypeAttributeId":7,"objectAttributeValues":[{"referencedObject":{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-27T07:12:36.215Z","hasAvatar":false,"timestamp":1574838756215,"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"},"searchValue":"TEST-2","displayValue":"Hello","referencedType":true}],"objectId":1}],"extendedInfo":{"openIssuesExists":false,"attachmentsExists":false},"_links":{"self":"http://jira/secure/ShowObject.jspa?id=1"},"name":"IPhone"}

      Returns the requested object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-entry#","title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"definitions":{"avatar-entry":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"link-entry":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-extended-entry":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["hasAvatar","timestamp"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Delete the referenced object.

Responses
    • Status 200
      Returns the deleted object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-entry#","title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"definitions":{"avatar-entry":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"link-entry":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"$ref":"#/definitions/avatar-entry"},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"$ref":"#/definitions/object-extended-entry"},"_links":{"$ref":"#/definitions/link-entry"},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-extended-entry":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["hasAvatar","timestamp"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

List all attributes for the given object.

Responses
    • Status 200 - application/json

      Example
      [{"id":3,"objectTypeAttribute":{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},"objectTypeAttributeId":1,"objectAttributeValues":[{"value":"TEST-1","searchValue":"TEST-1","displayValue":"TEST-1","referencedType":false}],"objectId":1},{"id":6,"objectTypeAttribute":{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"IPhone","searchValue":"IPhone","displayValue":"IPhone","referencedType":false}],"objectId":1},{"id":4,"objectTypeAttribute":{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},"objectTypeAttributeId":3,"objectAttributeValues":[{"value":"2019-11-26T08:06:45.478Z","searchValue":"2019-11-26T08:06:45.478Z","displayValue":"26/Nov/19 9:06 AM","referencedType":false}],"objectId":1},{"id":5,"objectTypeAttribute":{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},"objectTypeAttributeId":4,"objectAttributeValues":[{"value":"2019-11-26T20:16:02.951Z","searchValue":"2019-11-26T20:16:02.951Z","displayValue":"26/Nov/19 9:16 PM","referencedType":false}],"objectId":1},{"id":1,"objectTypeAttribute":{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},"objectTypeAttributeId":5,"objectAttributeValues":[{"value":"2019-11-29","searchValue":"2019-11-29","displayValue":"29/Nov/19","referencedType":false}],"objectId":1},{"id":2,"objectTypeAttribute":{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5},"objectTypeAttributeId":6,"objectAttributeValues":[{"value":"2019-10-01T08:06:00.000Z","searchValue":"2019-10-01T08:06:00.000Z","displayValue":"01/Oct/19 10:06 AM","referencedType":false}],"objectId":1},{"id":11,"objectTypeAttribute":{"id":7,"name":"Reference","label":false,"type":1,"referenceType":{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false},"referenceObjectTypeId":1,"referenceObjectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":6},"objectTypeAttributeId":7,"objectAttributeValues":[{"referencedObject":{"id":2,"label":"Hello","objectKey":"TEST-2","avatar":{"url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url72":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=72&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url144":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=144&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","url288":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=288&uuid=b3c879a0-b6c0-4ce4-9fa1-c6b97db698cc","objectId":2},"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"created":"2019-11-26T09:22:39.323Z","updated":"2019-11-26T09:22:39.323Z","hasAvatar":false,"timestamp":1574760159323,"_links":{"self":"http://jira/secure/ShowObject.jspa?id=2"},"name":"Hello"},"searchValue":"TEST-2","displayValue":"Hello","referencedType":true}],"objectId":1}]

      Returns the list of attributes for the requested object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-object-attribute-entry#","title":"List of Object Attribute Entry","type":"array","items":{"$ref":"#/definitions/object-attribute-entry"},"definitions":{"object-attribute-entry":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"$ref":"#/definitions/object-attribute-entry"}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]}},"objectId":{"type":"integer"}},"additionalProperties":false},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      Returned if the customer request does not exist.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

objectattribute

Creates a new attribute for a given object.

Request
query parameters
ParameterTypeDescription
includeTypeAttributeboolean

Default: false

Should the response include the object type attribute definition.

Example
{"objectAttributeValues":[{"value":"IPhone"}],"objectId":1,"objectTypeAttributeId":2}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-attribute-in-entry#","title":"Object Attribute In Entry","type":"object","properties":{"objectId":{"type":"integer"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value In Entry","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"operationType":{"type":"integer"}},"additionalProperties":false,"required":["operationType"]}

Responses
    • Status 201 - application/json

      Example
      {"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"IPhone","searchValue":"IPhone","displayValue":"IPhone","referencedType":false}],"objectId":1}

      Creates a new attribute for a given object, and returns the attribute for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-attribute-entry#","title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"definitions":{"object-attribute-value-entry":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"additionalProperties":false}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Deprecated. Update the object attribute using the object resource instead. Update an already existing object attribute.

Request

Example
{"objectAttributeValues":[{"value":"IPhone"}],"objectId":1,"objectTypeAttributeId":2}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-attribute-in-entry#","title":"Object Attribute In Entry","type":"object","properties":{"objectId":{"type":"integer"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"title":"Object Attribute Value In Entry","type":"object","properties":{"value":{"type":"string"}},"additionalProperties":false}},"operationType":{"type":"integer"}},"additionalProperties":false,"required":["operationType"]}

Responses
    • Status 200 - application/json

      Example
      {"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"IPhone","searchValue":"IPhone","displayValue":"IPhone","referencedType":false}],"objectId":1}

      Updates an attribute for a given object, and returns the attribute for the object.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-attribute-entry#","title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"definitions":{"object-attribute-value-entry":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"additionalProperties":false}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Deprecated. Use the object resource to fetch attributes. Load a single object attribute.

Responses
    • Status 200 - application/json

      Example
      {"id":6,"objectTypeAttributeId":2,"objectAttributeValues":[{"value":"IPhone","searchValue":"IPhone","displayValue":"IPhone","referencedType":false}],"objectId":1}

      Load a single object attribute.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-attribute-entry#","title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"definitions":{"object-attribute-value-entry":{"title":"Object Attribute Value Entry","type":"object","properties":{"referencedObject":{"title":"Object Entry","type":"object","properties":{"id":{"type":"integer"},"label":{"type":"string"},"objectKey":{"type":"string"},"avatar":{"title":"Avatar Entry","type":"object","properties":{"id":{"type":"integer"},"avatarUUID":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"},"url72":{"type":"string"},"url144":{"type":"string"},"url288":{"type":"string"},"objectId":{"type":"integer"}},"additionalProperties":false},"objectType":{"$ref":"#/definitions/object-type-entry"},"created":{"type":"object"},"updated":{"type":"object"},"hasAvatar":{"type":"boolean"},"timestamp":{"type":"integer"},"attributes":{"type":"array","items":{"title":"Object Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectTypeAttribute":{"$ref":"#/definitions/object-type-attribute-entry"},"objectTypeAttributeId":{"type":"integer"},"objectAttributeValues":{"type":"array","items":{"$ref":"#/definitions/object-attribute-value-entry"}},"objectId":{"type":"integer"}},"additionalProperties":false}},"extendedInfo":{"title":"Object Extended Entry","type":"object","properties":{"openIssuesExists":{"type":"boolean"},"attachmentsExists":{"type":"boolean"}},"additionalProperties":false,"required":["openIssuesExists","attachmentsExists"]},"_links":{"title":"Link Entry","type":"object","properties":{"self":{"type":"string"}},"additionalProperties":false},"name":{"type":"string"}},"additionalProperties":false,"required":["hasAvatar","timestamp"]},"user":{"title":"User Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"key":{"type":"string"},"emailAddress":{"type":"string"},"html":{"type":"string"},"renderedLink":{"type":"string"},"isDeleted":{"type":"boolean"},"lastSeenVersion":{"type":"string"},"self":{"type":"string"}},"additionalProperties":false,"required":["isDeleted"]},"group":{"title":"Group Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"confluencePage":{"title":"Confluence Page Entry","type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"version":{"title":"Version Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"name":{"type":"string"},"id":{"type":"integer"},"url":{"type":"string"}},"additionalProperties":false},"project":{"$ref":"#/definitions/project-entry"},"status":{"title":"Status Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"category":{"type":"integer"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["category"]},"value":{},"additionalValue":{"type":"string"},"displayValue":{},"referencedType":{"type":"boolean"},"searchValue":{}},"additionalProperties":false,"required":["referencedType"]},"object-type-attribute-entry":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

objectconnectedtickets

Access relations between Jira issues and Assets objects

Retrieve all tickets connected to the specified object.

Request
query parameters
ParameterTypeDescription
filterIdlong

Filter the tickets based on the filter ID. If filterId is not specified then no filter will be used. In the context of Jira the filterId will be the ID on an existing JQL filter.

limitint

Limit the result set to the amount of objects. If the limit is not specified all connected tickets will be returned.

Responses
    • Status 200 - application/json

      Example
      {"tickets":[{"key":"PROJ-1","id":10000,"reporter":"admin","created":"2019-11-27T08:16:52.337Z","updated":"2019-11-27T08:16:52.337Z","title":"This is the Jira Summary of a Task in todo","status":{"name":"To Do","colorName":"blue-gray"},"type":{"name":"Task","description":"A task that needs to be done.","iconUrl":"http://jira/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype"},"priority":{"name":"Medium","iconUrl":"http://jira/images/icons/priorities/medium.svg"}}],"allTicketsQuery":"cf[10000] = TEST-1"}

      Returns the connected jira tickets

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/tickets-entry#","title":"Tickets Entry","type":"object","properties":{"tickets":{"type":"array","items":{"title":"Ticket Entry","type":"object"}},"allTicketsQuery":{"type":"string"}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

objectschema

Load or manipulate object schemas.

Deprecated. Use /objecttypeattribute/find instead.

Find all object type attributes for this object schema.

Request
query parameters
ParameterTypeDescription
onlyValueEditableboolean

Default: false

Should the response only include attributes where only the value is editable.

extendedboolean

Default: false

Should the response be extended to include additional information.

querystring

Query to filter on available object type attributes.

Responses
    • Status 200 - application/json

      Example
      [{"id":5,"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},{"id":6,"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5},{"id":7,"name":"Reference","label":false,"type":1,"referenceType":{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false},"referenceObjectTypeId":1,"referenceObjectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":-1,"suffix":"","removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"regexValidation":"","iql":"","qlQuery":"","options":"","position":6},{"id":2,"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},{"id":1,"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},{"id":3,"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},{"id":4,"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3}]

      Returns the matching object schemas.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-attribute-entry#","title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"definitions":{"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Find all object types belonging to a certain object schema.

Request
query parameters
ParameterTypeDescription
querystring

Query to filter on available object types.

excludestring

Exclude object types with this name.

Responses
    • Status 200 - application/json

      Example
      [{"id":2,"name":"Computer","type":0,"icon":{"id":71,"name":"Astronaut","url16":"http://jira/rest/insight/1.0/objecttype/2/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/2/icon.png?size=48"},"position":0,"created":"2019-11-27T11:13:22.889Z","updated":"2019-11-27T11:13:22.889Z","objectCount":0,"parentObjectTypeId":1,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}]

      Returns the list of object types

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-object-type-entry#","title":"List of Object Type Entry","type":"array","items":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Create a new object schema.

Request

Example
{"name":"Computers","objectSchemaKey":"COMP","description":"The IT department schema"}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-in-entry#","title":"Object Schema In Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"}},"additionalProperties":false}

Responses
    • Status 201 - application/json

      Example
      {"id":2,"name":"Computers","objectSchemaKey":"COMP","status":"Ok","description":"The IT department schema","created":"2019-11-27T11:30:40.810Z","updated":"2019-11-27T11:30:40.810Z","objectCount":0,"objectTypeCount":0}

      Returns the newly created object schema.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-entry#","title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Retrieve a single object schema.

Responses
    • Status 200 - application/json

      Example
      {"id":2,"name":"Computers","objectSchemaKey":"COMP","status":"Ok","description":"The IT department schema","created":"2019-11-27T11:30:40.810Z","updated":"2019-11-27T11:30:40.810Z","objectCount":0,"objectTypeCount":0}

      Returns the object schema.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-entry#","title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Update an object schema.

Request

Example
{"id":2,"name":"Computers","objectSchemaKey":"COMP","status":"Ok","description":"The IT department schema","created":"2019-11-27T11:30:40.810Z","updated":"2019-11-27T11:30:40.810Z","objectCount":0,"objectTypeCount":0}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-entry#","title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}

Responses
    • Status 200 - application/json

      Example
      {"id":2,"name":"Computers","objectSchemaKey":"COMP","status":"Ok","description":"The IT department schema","created":"2019-11-27T11:30:40.810Z","updated":"2019-11-27T11:30:40.810Z","objectCount":0,"objectTypeCount":0}

      Returns the updated object schema.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-entry#","title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      Object Schema not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Deletes a single object schema.

Responses
    • Status 200 - application/json

      Example
      {"id":2,"name":"Computers","objectSchemaKey":"COMP","status":"Ok","description":"The IT department schema","created":"2019-11-27T11:30:40.810Z","updated":"2019-11-27T11:30:40.810Z","objectCount":0,"objectTypeCount":0}

      Returns the deleted object schema

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-entry#","title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      Object schema not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Searches for an object schema by name.

Request
query parameters
ParameterTypeDescription
querystring

Query to filter on available object schemas.

Responses
    • Status 200 - application/json
      Returns the matching object schemas

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-schema-list-entry#","title":"Object Schema List Entry","type":"object","properties":{"objectschemas":{"type":"array","items":{"title":"Object Schema Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"objectSchemaKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"objectTypeCount":{"type":"integer"}},"additionalProperties":false,"required":["objectCount","objectTypeCount"]}}},"additionalProperties":false}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

objecttype

Load or manipulate object types.

Find all object type attributes for this object type.

Request
query parameters
ParameterTypeDescription
onlyValueEditableboolean

Default: false

Should the response only include attributes where only the value is editable.

orderByNameboolean

Default: false

Should the response be ordered by name.

querystring

Filter attributes that start with the query.

includeValueExistboolean

Default: false

Should the response only include attributes where attribute values exists.

excludeParentAttributesboolean

Default: false

Should the response exclude parent attributes.

includeChildrenboolean

Default: false

Should the response include child attributes.

orderByRequiredboolean

Default: false

Should the response be ordered by the number of required attributes.

Responses
    • Status 200 - application/json

      Example
      [{"id":1,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Key","label":false,"type":0,"defaultType":{"id":0,"name":"Text"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":0},{"id":2,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Name","label":true,"type":0,"description":"The name of the object","defaultType":{"id":0,"name":"Text"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":1},{"id":3,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Created","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":2},{"id":4,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Updated","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":false,"system":true,"sortable":true,"summable":false,"minimumCardinality":1,"maximumCardinality":1,"removable":false,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":3},{"id":5,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Date Attribute","label":false,"type":0,"defaultType":{"id":4,"name":"Date"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":4},{"id":6,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"DateTime Attribute","label":false,"type":0,"defaultType":{"id":6,"name":"DateTime"},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":1,"removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"options":"","position":5},{"id":7,"objectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"name":"Reference","label":false,"type":1,"referenceType":{"id":1,"name":"Dependency","description":"Dependency","color":"e8f00e","url16":"http://jira/rest/insight/1.0/config/referencetype/1/image.png?size=16","removable":false},"referenceObjectTypeId":1,"referenceObjectType":{"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":0,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false},"editable":true,"system":false,"sortable":true,"summable":false,"minimumCardinality":0,"maximumCardinality":-1,"suffix":"","removable":true,"hidden":false,"includeChildObjectTypes":false,"uniqueAttribute":false,"regexValidation":"","iql":"","qlQuery":"","options":"","position":6}]

      Example response for new object type creation

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/list-of-object-type-attribute-entry#","title":"List of Object Type Attribute Entry","type":"array","items":{"title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]},"definitions":{"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}}}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Create an object type.

Request

Example
{"name":"Computers","description":"The IT department computers","iconId":1,"parentObjectTypeId":1,"objectSchemaId":1}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-type-in-entry#","title":"Object Type In Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"iconId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"}},"additionalProperties":false}

Responses
    • Status 201 - application/json

      Example
      {"id":3,"name":"Computers","type":0,"description":"The IT department computers","icon":{"id":1,"name":"Delete","url16":"http://jira/rest/insight/1.0/objecttype/3/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/3/icon.png?size=48"},"position":1,"created":"2019-11-27T11:15:00.078Z","updated":"2019-11-27T11:15:00.078Z","objectCount":0,"parentObjectTypeId":1,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}

      Example response for new object type creation.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-entry#","title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

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

Request

Example
{"toObjectTypeId":2,"position":0}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/js-tree-position-entry#","title":"JS Tree Position Entry","type":"object","properties":{"toObjectTypeId":{"type":"integer"},"position":{"type":"integer"}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":2,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}

      Example response for changing an object type position

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-entry#","title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Retrieve a single object type.

Responses
    • Status 200 - application/json

      Example
      {"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":2,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}

      Example object type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-entry#","title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Update an object type.

Request

Example
{"name":"Computers","description":"The IT department computers","iconId":1,"parentObjectTypeId":1}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-type-in-entry#","title":"Object Type In Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"iconId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"}},"additionalProperties":false}

Responses
    • Status 200 - application/json

      Example
      {"id":3,"name":"Computers","type":0,"description":"The IT department computers","icon":{"id":1,"name":"Delete","url16":"http://jira/rest/insight/1.0/objecttype/3/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/3/icon.png?size=48"},"position":1,"created":"2019-11-27T11:15:00.078Z","updated":"2019-11-27T11:17:44.360Z","objectCount":0,"parentObjectTypeId":1,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}

      Example response for object type update

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-entry#","title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Delete an object type.

Responses
    • Status 200 - application/json

      Example
      {"id":1,"name":"ObjectType","type":0,"icon":{"id":25,"name":"3D Printer","url16":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=16","url48":"http://jira/rest/insight/1.0/objecttype/1/icon.png?size=48"},"position":0,"created":"2019-11-26T08:06:02.891Z","updated":"2019-11-26T08:06:02.891Z","objectCount":2,"objectSchemaId":1,"inherited":false,"abstractObjectType":false,"parentObjectTypeInherited":false}

      Example response for deleted object type

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-entry#","title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

objecttypeattribute

Load or manipulate individual object type attributes.

Delete a single object type attribute.

Responses
    • Status 200
    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      The object type attribute was not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Store an object type attribute.

Request

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-type-attribute-in-entry#","title":"Object Type Attribute In Entry","type":"object","properties":{"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"iql":{"type":"string"}},"additionalProperties":false}

Responses
    • Status 201 - application/json
      Returns the stored object type attribute.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-attribute-entry#","title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"definitions":{"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Update an object type attribute.

Request

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/object-type-attribute-in-entry#","title":"Object Type Attribute In Entry","type":"object","properties":{"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"iql":{"type":"string"}},"additionalProperties":false}

Responses
    • Status 200 - application/json
      Returns the updated object type attribute.

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/object-type-attribute-entry#","title":"Object Type Attribute Entry","type":"object","properties":{"id":{"type":"integer"},"objectType":{"$ref":"#/definitions/object-type-entry"},"name":{"type":"string"},"label":{"type":"boolean"},"type":{"type":"integer"},"description":{"type":"string"},"defaultType":{"title":"Default Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false},"typeValue":{"type":"string"},"typeValueMulti":{"type":"array","items":{"type":"string"}},"additionalValue":{"type":"string"},"referenceType":{"title":"Reference Type Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"url16":{"type":"string"},"removable":{"type":"boolean"},"objectSchemaId":{"type":"integer"}},"additionalProperties":false,"required":["removable"]},"referenceObjectTypeId":{"type":"integer"},"referenceObjectType":{"$ref":"#/definitions/object-type-entry"},"confluenceTypeValue":{"title":"Application Link Entry","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"confluenceAddValue":{"title":"Confluence Space Entry","type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"error":{"type":"boolean"}},"additionalProperties":false,"required":["error"]},"versionTypeValues":{"type":"array","items":{"$ref":"#/definitions/project-entry"}},"editable":{"type":"boolean"},"system":{"type":"boolean"},"sortable":{"type":"boolean"},"summable":{"type":"boolean"},"indexed":{"type":"boolean"},"minimumCardinality":{"type":"integer"},"maximumCardinality":{"type":"integer"},"suffix":{"type":"string"},"removable":{"type":"boolean"},"objectAttributeExists":{"type":"boolean"},"hidden":{"type":"boolean"},"includeChildObjectTypes":{"type":"boolean"},"uniqueAttribute":{"type":"boolean"},"regexValidation":{"type":"string"},"qlQuery":{"type":"string"},"options":{"type":"string"},"position":{"type":"integer"},"iql":{"type":"string"},"versionTypeValue":{"$ref":"#/definitions/project-entry"}},"definitions":{"object-type-entry":{"title":"Object Type Entry","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"integer"},"description":{"type":"string"},"icon":{"title":"Icon Entry","type":"object","properties":{"expand":{"type":"string"},"project":{"type":"string"},"position":{"type":"string"},"after":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"url16":{"type":"string"},"url48":{"type":"string"}},"additionalProperties":false},"position":{"type":"integer"},"created":{"type":"object"},"updated":{"type":"object"},"objectCount":{"type":"integer"},"parentObjectTypeId":{"type":"integer"},"objectSchemaId":{"type":"integer"},"inherited":{"type":"boolean"},"abstractObjectType":{"type":"boolean"},"parentObjectTypeInherited":{"type":"boolean"}},"additionalProperties":false,"required":["type","position","objectCount","inherited","abstractObjectType","parentObjectTypeInherited"]},"project-entry":{"title":"Project Entry","type":"object","properties":{"avatarUrl":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"key":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false,"required":["label","editable","system","sortable","summable","indexed","minimumCardinality","maximumCardinality","removable","hidden","includeChildObjectTypes","uniqueAttribute"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

progress

Handle the progress of ongoing tasks.

Show progress of ongoing tasks

Parameters

Category
Specifies the type of ongoing task.
Possible values include: imports, insight-reindex, freetext-reindex, cache-query, async-task

ResourceId
Specifies the id of the ongoing task.

Examples

Retrieve the progress of the most recent reindex task 

/progress/category/insight-reindex/reindex

Retrieve the progress of an import task 

/progress/category/imports/{id}

Responses
    • Status 200 - application/json

      Example
      {"progressInPercent":100,"resourceId":"reindex","category":"assets-reindex","status":"FINISHED","stepDescription":"Re-index Assets","currentStep":1,"numberOfSteps":1,"currentWorkUnits":23,"currentStepTotalWorkUnits":23,"totalWorkUnits":23,"result":"OK","resultMessage":"Re-Indexing was successful","actor":"admin","startDate":"2019-11-27T12:23:54.891Z","finishedDate":"2019-11-27T12:23:54.946Z"}

      Example response for object type update

      Schema
      {"id":"https://docs.atlassian.com/jira/REST/schema/progress-out-entry#","title":"Progress Out Entry","type":"object","properties":{"progressInPercent":{"type":"integer"},"resourceId":{"type":"string"},"category":{"type":"string"},"status":{"type":"string"},"stepDescription":{"type":"string"},"currentStep":{"type":"integer"},"numberOfSteps":{"type":"integer"},"currentWorkUnits":{"type":"integer"},"currentWorkDescription":{"type":"string"},"currentStepTotalWorkUnits":{"type":"integer"},"totalWorkUnits":{"type":"integer"},"result":{"type":"string"},"resultData":{},"resultMessage":{"type":"string"},"actor":{"type":"string"},"startDate":{"type":"object"},"finishedDate":{"type":"object"},"estimatedFinishDate":{"type":"object"}},"additionalProperties":false,"required":["currentWorkUnits","currentStepTotalWorkUnits","totalWorkUnits"]}

    • Status 401
      Client must be authenticated to access this resource.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

qrcode

Load QR codes.

Retrieve a QR code for an object.

Request
query parameters
ParameterTypeDescription
sizeint

The size of the QR code

Responses
    • Status 200 - image/png
      Returns an image of the requested QR code.
    • Status 401
      Client must be authenticated to access this resource.
    • Status 404
      The object was not found.
    • Status 500
      Something went wrong. Please try again later. If the error persists, contact our support team.

Appendix

Topics in this section:

Structure of the REST URIs

Assets's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Assets REST API uses JSON as its communication format, and the standard HTTP methods like GET, PUT, POST, and DELETE (see each individual resource to find out which methods are available). URIs for Assets's REST API resources have the following structure: 

http://host:port/context/rest/assets/{version}/resource-name

Note:

  • All query parameters for the Assets resources are optional, unless specified otherwise.

Authentication

The Assets REST API uses the same authentication methods as Jira. The preferred authentication methods are OAuth and HTTP Basic Auth (when using SSL). Other supported methods include: HTTP Cookies and Trusted Applications.

If you are using Assets in a browser you can call the REST API from JavaScript on the page and rely on the authentication that the browser has established.

You can find OAuth code samples in several programming languages at bitbucket.org/atlassianlabs/atlassian-oauth-examples/src/master.