Components

Replace a questionnaire component

put/studies/{studyId}/components/questionnaire/{componentId}

Request

  • Base URL: http://localhost:8080/api/v0
  • URL: http://localhost:8080/api/v0/studies/{studyId}/components/questionnaire/{componentId}
  • Auth: HTTP bearer

Path parameters

studyIdstring uuid required
componentIdstring uuid required

Request body

namestring required

Display name for the component

dataQuestionnaireComponentData required

Localized questionnaire content keyed by locale (e.g., "en-US", "de-DE")

Example request

{
  "data": {
    "en-US": {
      "questionnaire": "{\"resourceType\": \"Questionnaire\", \"title\": \"Daily Survey\"}"
    },
    "de-DE": {
      "questionnaire": "{\"resourceType\": \"Questionnaire\", \"title\": \"Tägliche Umfrage\"}"
    }
  }
}

Response

Component replaced

idstring uuid required
namestring required

Display name for the component

dataQuestionnaireComponentData required

Localized questionnaire content keyed by locale (e.g., "en-US", "de-DE")

Example response

{
  "data": {
    "en-US": {
      "questionnaire": "{\"resourceType\": \"Questionnaire\", \"title\": \"Daily Survey\"}"
    },
    "de-DE": {
      "questionnaire": "{\"resourceType\": \"Questionnaire\", \"title\": \"Tägliche Umfrage\"}"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.