GET api/v2/Study/{studyId}/ResumableData/Session/{sessionId}

Polls the status of a resumable download session.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
studyId

Study ID

 globally unique identifier

Required
sessionId

Session ID returned by POST Session

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

202 while preparing, 200 when ready, 404 if not found

ResumableSessionStatus
NameDescriptionTypeAdditional information
SessionId

string

None.
IsReady

boolean

None.
TotalBatches

integer

None.
DataVersion

string

None.
ContinuationToken

string

None.
ConfigStatus

string

None.
ConfigBatches

integer

None.
PermissionsStatus

string

None.
PermissionsBatches

integer

None.
DataStatus

string

None.
ConfigContinuationToken

string

None.
PermissionsContinuationToken

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "sessionId": "sample string 1",
  "isReady": true,
  "totalBatches": 3,
  "dataVersion": "sample string 4",
  "continuationToken": "sample string 5",
  "configStatus": "sample string 6",
  "configBatches": 7,
  "permissionsStatus": "sample string 8",
  "permissionsBatches": 9,
  "dataStatus": "sample string 10",
  "configContinuationToken": "sample string 11",
  "permissionsContinuationToken": "sample string 12"
}