More info on Jira Cloud Rest APIs

Claude Dev

There are over 250 endpoints in the Swagger that Jira is providing here: https://developer.atlassian.com/cloud/jira/platform/swagger.v3.json 

The response of many endpoints (like ex: GET /issue/{issueID}/comment) is an object where one property holds the list of requested items, in this case "comments" property which holds list of all comments.

This property/key that holds actual list of records is different from endpoint to endpoint.
Ex: GET /avatar/{type}/system, the property that holds all avatar details is "system".

Is it possible to get some kind of mapping between the endpoints and the key/property that holds the list of requested items/records?

 

Earl McCutcheon

Hello @Claude Dev ,

Thanks for reaching out, and i believe what you are looking for can be found under entity property calls.

Check out the document:

• https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/

As an example from the Knowledge Base documentation above: 

The example below shows how to get all of the properties stored against an issue.

curl -X GET https://jira-instance1.net/rest/api/2/issue/ENPR-4/properties/

The response from server will contain keys and URLs of all properties of the issue ENPR-4

{"keys":[{"self":"https://jira-instance1.net/rest/api/2/issue/ENPR-4/properties/tasks","key":"tasks"}]}

Regards,
Earl