Get study-level settings
get
/api/studies/{studyId}/config
Retrieves study-level configuration settings.
Request
Path Parameters
-
studyId: string
mHealth study identifier.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Nested Schema : AdherenceConfig
Type:
Show Source
object
-
alertFrequency(optional):
string
Frequency of compliance check. For example, "12H" will run compliance check every 12 hours.
-
deviceDataFrequency(optional):
string
The time period used to determine whether a device / eSource is in compliance. If mHealth Cloud Connector does not receive any data in this time period, a non-compliance alert will be created for this device/eSource. Default value is 24 hours.
-
startHour(optional):
integer
The compliance task start hour. The value must be 0 to 23.
404 Response
Invalid studyId.