ATatlassian

Changed on

Retrieve a list of objects based on an AQL. Deprecated from <b>30 September 2024</b>. Please use POST /object/aql instead. For more information please see https://developer.atlassian.com/changelog/#CHANGE-1661.

post/object/navlist/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/navlist/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

Request body

qlQuerystring required

The AQL that will fetch the objects. The object type parameter will be appended implicitly to this AQL

iqlstring

Required if qlQuery is not set. Deprecated. Use qlQuery instead.

objectTypeIdstring required
pageinteger

The requested page to be loaded for a paginated result. The default value is page = 1

resultsPerPageinteger required

How many objects should be returned in the request. It is used with page attribute for pagination.

orderByTypeAttrIdinteger

Which attribute should be used to order by. The preferred way is to use an order by in qlQuery and not pass this argument.

ascinteger

Sort objects in ascending order or descending order based on the attribute identified by orderByTypeAttrId. 1 means ascending all other values mean descending. The preferred way is to not supply the asc parameter and use an order by in qlQuery instead.

objectIdstring

Identifies an object that should be included in the result. The page will be calculated accordingly to include the object specified in the result set

objectSchemaIdstring required
includeAttributesboolean

Should attribute values be included in the response.

Response

The navlist response and the objects matching the query

objectTypeIdstring

Deprecated field that shows which object type id the result is for. Not applicable when using AQL

objectTypeIsInheritedboolean

Deprecated field should not be used.

abstractObjectTypeboolean

Deprecated field should not be used.

totalFilterCountinteger

Deprecated from <b>30 September 2024</b> please use POST /object/totalcount instead. The total amount of objects that was matched in the search query. This number may be greater than the amount of objects currently shown

startIndexinteger required

The offset of the first object in the search query that is present in the result, used for pagination

toIndexinteger required

The index of the last object present in the result of the search query

pageObjectSizeinteger required

The amount of objects currently returned per page in the result set

pageNumberinteger required

The current page of objects in the result set pagination

orderByTypeAttrIdinteger

Deprecated field - The object type attribute id used for sorting

orderWaystring

Deprecated field - The sort order, used in conjunction with the orderByTypeAttrId

filtersobject

Deprecated field - The field is used for basic search

qlQuerystring required

The AQL that was used to find the object result set

qlQuerySearchResultboolean

Determines if the query was based on an AQL or by basic search

iqlstring required

Deprecated, use qlQuery instead

iqlSearchResultboolean

Deprecated, use qlQuerySearchResult instead

conversionPossibleboolean

Is it possible to transform this AQL to basic search or vice versa

matchedFilterValuesobject

Deprecated field should not be used

inheritanceTreeobject

Deprecated field should not be used

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