ATatlassian

Changed on

Fetch Objects by AQL

post/object/aql

Request

  • Base URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1
  • URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1/object/aql
  • Auth
    • OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:cmdb-object:jira
    • or HTTP bearer

Query parameters

startAtinteger

The starting index for the next page of results

maxResultsinteger

The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned.

includeAttributesboolean

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

Request body

qlQuerystring required

The AQL that will fetch the objects.

Response

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

startAtinteger required
maxResultsinteger required
totalinteger required

Deprecated from <b>30 September 2024</b> please use POST /object/totalcount instead.

lastboolean required
isLastboolean required

Changes

  • 83fc72ce3b1eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /// to the response with the status