CASE FrameworkManagement APIResponses
Start responses export task
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Path Parameters
studyKey*string
Query Parameters
surveyKey?string
page?integer
page number (starting from 1)
Default
1Range
1 <= valuelimit?integer
maximum number of responses per page
Default
10Range
1 <= valuefilter?
bson.M object to filter responses
sort?
bson.M object to sort responses
shortKeys?boolean
return short keys for responses
Default
falsequestionOptionSep?string
separator used in option keys
Default
"-"format?string
response export format
Default
"wide"Value in
"wide" | "long" | "json"extraContextColumns?string
comma-separated list of extra context columns
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/studies/string/data-exporter/responses/"{
"task": {
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "string",
"targetCount": 0,
"processedCount": 0,
"resultFile": "string",
"fileType": "string",
"error": "string"
}
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}