Getting Data Retrieval Session by Session ID
You can get a resource representation of a data retrieval session with the specified ID.
Request
GET https://<hostname>:4443/v6/DataRetrievalSessions/{dataRetrievalSessionId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
dataRetrievalSessionId | string | Specifies the identification number of the data retrieval session. For more information on how to get this parameter, see Getting Data Retrieval Sessions. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies the data retrieval session ID. |
name | string | Specifies a name of the data retrieval session. |
retrievalId | string | Specifies the retrieval job ID. |
creationTime | UTC | Specifies date and time when the data retrieval session was created. |
endTime | UTC | Specifies date and time when the latest data retrieval session ended. |
progress | integer | Specifies the number of processed objects during the data retrieval session. |
processedObjects | integer | Specifies the number of items processed by the retrieval job. |
type | string | Specifies the data retrieval session type. The following types are available:
|
status | string | Specifies the status of the retrieval job. The following values are available:
|
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the data retrieval session with the ID 668f478c-0326-440a-8bdf-58cf39163ea2.
Request: GET https://abc.tech.local:4443/v6/DataRetrievalSessions/668f478c-0326-440a-8bdf-58cf39163ea2
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "id": "668f478c-0326-440a-8bdf-58cf39163ea2", "name": "Exchange data retrieval", "retrievalId": "8a76872b-7f2c-4c50-95f4-92c4d41bc47c", "creationTime": "2022-01-28T20:52:36.9177053+01:00", "endTime": "2022-01-28T20:56:17.7513457+01:00", "progress": 5, "processedObjects": 37, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } } |