Components

Add an informational component to a study

post/studies/{studyId}/components/informational

Request

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

Path parameters

studyIdstring uuid required

Request body

namestring required

Display name for the component

dataInformationalComponentData required

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

Example request

{
  "data": {
    "en-US": {
      "title": "Welcome",
      "lede": "Introduction to the study",
      "content": "Welcome to the study"
    },
    "de-DE": {
      "title": "Willkommen",
      "lede": "Einführung in die Studie",
      "content": "Willkommen zur Studie"
    }
  }
}

Response

Component added

idstring uuid required
namestring required

Display name for the component

dataInformationalComponentData required

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

Example response

{
  "data": {
    "en-US": {
      "title": "Welcome",
      "lede": "Introduction to the study",
      "content": "Welcome to the study"
    },
    "de-DE": {
      "title": "Willkommen",
      "lede": "Einführung in die Studie",
      "content": "Willkommen zur Studie"
    }
  }
}

Changes

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