Develop > Developer Reference > Using APIs > Universal CMDB REST API > Reference > Get Chunked Query Result

Get Chunked Query Result

This call retrieves a chunk from a chunked TQL query result.

URL

/topology/result/{resultTokenId}/{chunkNumber}

Method

GET

Headers

Required: 

Authorization: Bearer <token>

Note <token> is the token that is returned by the Authentication call.

Example: 

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0

Request Type

JSON

Response Type

JSON

URL Parameters

Required: 

{resultTokenId}: [resultTokenId]
{chunkNumber}: [integer]

Data types:

[resultTokenId] - The string that represents a token that identifies this resultId, retrieved from an execute query call when the resultSize > chunkNumber.

Payload

N/A

Success Response

Response: 200

Content: 

{
  cis: [
    {
      ucmdbId: [ucmdb_id],
      type: [ucmdb_cit],
      properties: {
        <ucmdb_cit_prop>: [ucmdb_cit_prop_value],
        …
      }
    },
    …
  ],
  relations: [
    {
      ucmdbId: [ucmdb_id],
      type: [ucmdb_cit],
      end1Id: [ucmdb_id],
      end2Id: [ucmdb_id],
      properties: {
        <ucmdb_cit_prop>: [ucmdb_cit_prop_value],
        …
      }
    },
    …
  ]
}

Data Types:

[ucmdb_id]

The string that represents the ID of an object.

[ucmdb_cit]

The string that represents the name of a valid CI Type from the UCMDB. The name of the CI Type can be found inside the CI Type Manager.

[ucmdb_cit_prop_value]

The property value, which can be integer, string, Boolean, long, double, ISO8601 date, or a list of values depending on the CIT property data type.

Custom fields:

<ucmdb_cit_prop>

The valid property name of the CI Type. You can get the name and the list of all properties of a CI Type from the CI Type Manager.

Note The … (three dots) denotes that there can be 0 or more values.

Error response

Code: 400

Content: 

{
  error: [string]
}

 

Code: 400

Content: 

{
  error: The following error has occurred: Please provide a valid chunk result id Please consult logs for more details
}

Notes

  • The user that the token belongs to must have the required permissions for executing the TQL queries by definition with the SDK.

  • The user that created the result ID token must be the same as the one querying it.

Send Help Center feedback