Data Retrieval Session Operations

The /DataRetrievalSessions/{sessionId}/LogItems resource collection represents information about the operations performed during a data retrieval session.

Get Information on Operations by Session ID

Returns information about the operations performed during a data retrieval session with the specified ID.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Specifies the identification number of the data retrieval session. For more information on how to get this parameter, see Get Data Retrieval Sessions.

query Parameters
offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

orderAsc
boolean

Defines whether the date and time are specified in ascending order. The default value is true.

Responses
200

OK

default

Operation failure response.

get/v8/DataRetrievalSessions/{sessionId}/LogItems
Request samples
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}

Get Information on Operation by LogItem ID

Returns information about a specific operation performed during a data retrieval session with the specified ID.

SecurityBearer
Request
path Parameters
sessionId
required
string <uuid>

Specifies the identification number of the data retrieval session. For more information on how to get this parameter, see Get Data Retrieval Sessions.

logItemId
required
string <uuid>

Specifies the identification number of the operation. For more information on how to get this parameter, see Get Information on Operations by Session ID.

Responses
200

OK

default

Operation failure response.

get/v8/DataRetrievalSessions/{sessionId}/LogItems/{logItemId}
Request samples
Response samples
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "usn": 0,
  • "type": "Running",
  • "message": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Document updated 12/18/2025

Page content applies to build 8.3.0.2201