Data Retrieval Sessions

The /DataRetrievalSessions resource collection represents sessions created for retrieval jobs.

Get Data Retrieval Sessions

Returns a collection of all sessions created for retrieval jobs.

SecurityBearer

Request

query Parameters

dataRetrievalId	string <uuid> Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Get Retrieval Jobs.
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.
offset	integer <int32> Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses

200

default

Operation failure response.

get/v8/DataRetrievalSessions

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"offset": 0,
"limit": 0,
"setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
"results": [{"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"retrievalId": "00000000-0000-0000-0000-000000000000",
"repositoryId": "00000000-0000-0000-0000-000000000000",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"progress": 0,
"processedObjects": 0,
"type": "Retrieve",
"status": "Stopped",
"proxyId": "00000000-0000-0000-0000-000000000000",
"proxyPoolId": "00000000-0000-0000-0000-000000000000",
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}
],
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Get Data Retrieval Session by Session ID

Returns a resource representation of a data retrieval session with the specified ID.

SecurityBearer

Request

path Parameters

dataRetrievalSessionId

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.