POST api/v2/Study/{studyId}/ResumableData/Session

Initiates an asynchronous session to prepare a resumable study data download. The session ID is returned immediately; poll GET Session/{sessionId} to check readiness.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
studyId

Study ID

 globally unique identifier

Required

Body Parameters

Session request parameters (site filter, timestamps)

ResumableSessionRequest
NameDescriptionTypeAdditional information
ConfigLastUpdatedTimestamp

string

None.
LastDataSyncTimestamp

string

None.
SiteIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "configLastUpdatedTimestamp": "sample string 1",
  "lastDataSyncTimestamp": "sample string 2",
  "siteIds": null
}

Response Information

Resource Description

202 Accepted with the new session ID, or 409 if config is stale

Object

None.

Response Formats

application/json, text/json

Sample: 
{}