v1

latestOpenAPI 3.0.02026-07-136452257.6 KB

This endpoint is deprecated and will be removed on <b>18th of September 2024</b>. Please use POST /object/aql instead. Find objects based on Assets Query Language (AQL)

get/aql/objects

Query parameters

qlQuerystring

The query to determine which objects that should be fetched. E.g. objectType = "Computer". The empty AQL means all objects

pageinteger

Which page to fetch when paginating through the response

resultPerPageinteger

The amount of objects returned per page

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

includeAttributesDeepinteger

How many levels of attributes should be included. E.g. consider an object A that has a reference to object B that 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 the includeAttributesDeep=2 then object B's reference to object C will be included in object B's attributes

includeTypeAttributesboolean

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

includeExtendedInfoboolean

Include information about open Jira issues. Should each object have information if open tickets are connected to the object?

Response

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

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