Sign in
Components

Add a health data component to a study

post/studies/{studyId}/components/health-data

Request

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

Path parameters

studyIdstring uuid required

Request body

namestring required

Display name for the component

Example request

{
  "data": {
    "sampleTypes": [
      "HKQuantityType;HKQuantityTypeIdentifierHeartRate",
      "HKQuantityType;HKQuantityTypeIdentifierStepCount",
      "HKCategoryType;HKCategoryTypeIdentifierSleepAnalysis"
    ]
  }
}

Response

Component added

idstring uuid required
namestring required

Display name for the component

Example response

{
  "data": {
    "sampleTypes": [
      "HKQuantityType;HKQuantityTypeIdentifierHeartRate",
      "HKQuantityType;HKQuantityTypeIdentifierStepCount",
      "HKCategoryType;HKCategoryTypeIdentifierSleepAnalysis"
    ]
  }
}

Changes

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