CASE FrameworkCASE Framework

Export study configuration, surveys, and rules

GET
/v1/studies/{studyKey}/export-config

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

studyKey*string

Query Parameters

config?string
Default"false"
Value in"true" | "false"
surveys?string
Default"false"
Value in"true" | "false"
rules?string
Default"false"
Value in"true" | "false"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/studies/string/export-config"
{
  "exportedAt": "2019-08-24T14:15:22Z",
  "config": {
    "id": "64b8f0f2e1b1c8a1d2e3f4g5",
    "key": "string",
    "secretKey": "string",
    "status": "string",
    "props": {},
    "configs": {},
    "notificationSubscriptions": [
      {}
    ],
    "stats": {},
    "nextTimerEvent": 0,
    "rules": [
      {}
    ]
  },
  "rules": {
    "id": "string",
    "studyKey": "string",
    "uploadedAt": 0,
    "uploadedBy": "string",
    "rules": [
      {}
    ],
    "serialisedRules": "string"
  },
  "surveys": [
    {
      "id": "string",
      "surveyKey": "string",
      "props": {},
      "prefillRules": [
        {}
      ],
      "contextRules": {},
      "maxItemsPerPage": {},
      "availableFor": "string",
      "requireLoginBeforeSubmission": true,
      "published": 0,
      "unpublished": 0,
      "surveyDefinition": {},
      "versionId": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      }
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}