REST API for Clinical One Platform

V1.0

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings

Retrieves all mHealth subject settings configured for the specified study and mode.

Request

Path Parameters

mode(required): string
Mode of the study, accepts: test, active, or training.
Example:
```
test
```
studyId(required): string(uuid)
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
Example:
```
7E355221FB2B4B698E4C37952778A8E0
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SubjectSettingDto

Subject setting data including start version, key/value, and auditing info.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectSettingDto"
    }
}

Nested Schema : SubjectSettingDto

Type: object

Subject setting data including start version, key/value, and auditing info.

Show Source

attributeKey(required): string
Key of the subject setting attribute. Possible values:
- sequential_across_study_or_site
- limit_screened_subjects
- withdraw_subject_codebreak
- limit_randomize_subjects
- user_enters_screening_visit_date
- user_edits_screening_visit_date
- user_enters_randomization_visit_date
- user_edits_randomization_visit_date
- user_enters_dispensation_visit_date
- user_edits_dispensation_visit_date
- user_enters_non_dispensation_visit_date
- user_edits_non_dispensation_visit_date
- user_enters_optional_visit_date
- user_edits_optional_visit_date
- user_enters_withdraw_visit_date
- user_edits_withdraw_visit_date
- randomization_visit_date_additional_setting
- dispensation_visit_date_additional_setting
- can_dispensation_visit_be_skipped
- can_non_dispensation_visit_be_skipped
- separate_siteid_and_subjectid_hyphen
- limit_study_status
- limit_site_scr
- limit_site_rand
- limit_site_alerts
- limit_site_status
- limit_country_scr
- limit_country_rand
- limit_country_alerts
- limit_country_status
- padding_for_subject_id
- max_randomize_subject
- subject_alerts
- max_screened_subject
- subject_addition_allowed
- subject_number_selection_allowed
- subject_number_format
- retry_partial_sdv_selection
- notify_unsched_visit_failure_only
- notify_screening_failure_only
- notify_optional_visit_failure_only
- notify_nondisp_visit_failure_only
- notify_randomization_failure_only
- notify_dispensation_failure_only
- notify_subjcomplete_visit_failure_only
- show_visit_window
- notify_first_screened_in_study
- notify_first_screened_at_site
- notify_first_randomized_in_study
- notify_first_randomized_at_site
- allow_withdrawal_before_enrollment
- allow_display_signature_elements
- replace_subject_number_rand_number
- code_data_for_new_and_screen_failed_subjects
- blind_rand_number_enabled
- replace_randomisation_enabled
- replace_randomisation_prefix
- replace_randomisation_max_limit
- allow_rescreening
- number_of_rescreen_allowed
- lock_screen_data_on_failure
- user_enters_rescreening_visit_date
- user_edits_rescreening_visit_date
- notify_rescreening_failure_only
- replace_subject_number_enabled
- assign_subject_number
- allow_screen_fail_before_screened
- limit_country_AF_status
- limit_country_AF_scr
- limit_country_AF_alerts
- limit_country_AF_name
- limit_country_AF_rand
- limit_country_DZ_alerts
- limit_country_DZ_rand
- limit_country_DZ_status
- limit_country_DZ_name
- limit_country_DZ_scr
- minimum_subject_number
- allow_withdrawal_for_screen_failed
- allow_completion_for_screen_failed
- enable_assign_subject_number
Example: assign_subject_number
attributeValue(required): string

Value of the subject setting attribute.

Example: YES
comment: string

Minimum Length: 0

Maximum Length: 2048

Comments or additional notes for this operation.

Example: Enabled based on protocol
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) for the subject setting.

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
objectVersionNumber: integer (int32)

Object version number

Example: 1
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for this operation or audit action.

Example: Initial setup
versionStart: string (date-time)

The timestamp marking the beginning of the validity period for this record version within the system.

Example: 2023-01-01T00:00:00Z

{
    "required":[
        "attributeKey",
        "attributeValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for this operation or audit action.",
            "example":"Initial setup"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comments or additional notes for this operation.",
            "example":"Enabled based on protocol"
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "example":1
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the subject setting.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T00:00:00Z"
        },
        "attributeKey":{
            "type":"string",
            "description":"<b>Key of the subject setting attribute. Possible values:</b><br/><ul><li>sequential_across_study_or_site</li><li>limit_screened_subjects</li><li>withdraw_subject_codebreak</li><li>limit_randomize_subjects</li><li>user_enters_screening_visit_date</li><li>user_edits_screening_visit_date</li><li>user_enters_randomization_visit_date</li><li>user_edits_randomization_visit_date</li><li>user_enters_dispensation_visit_date</li><li>user_edits_dispensation_visit_date</li><li>user_enters_non_dispensation_visit_date</li><li>user_edits_non_dispensation_visit_date</li><li>user_enters_optional_visit_date</li><li>user_edits_optional_visit_date</li><li>user_enters_withdraw_visit_date</li><li>user_edits_withdraw_visit_date</li><li>randomization_visit_date_additional_setting</li><li>dispensation_visit_date_additional_setting</li><li>can_dispensation_visit_be_skipped</li><li>can_non_dispensation_visit_be_skipped</li><li>separate_siteid_and_subjectid_hyphen</li><li>limit_study_status</li><li>limit_site_scr</li><li>limit_site_rand</li><li>limit_site_alerts</li><li>limit_site_status</li><li>limit_country_scr</li><li>limit_country_rand</li><li>limit_country_alerts</li><li>limit_country_status</li><li>padding_for_subject_id</li><li>max_randomize_subject</li><li>subject_alerts</li><li>max_screened_subject</li><li>subject_addition_allowed</li><li>subject_number_selection_allowed</li><li>subject_number_format</li><li>retry_partial_sdv_selection</li><li>notify_unsched_visit_failure_only</li><li>notify_screening_failure_only</li><li>notify_optional_visit_failure_only</li><li>notify_nondisp_visit_failure_only</li><li>notify_randomization_failure_only</li><li>notify_dispensation_failure_only</li><li>notify_subjcomplete_visit_failure_only</li><li>show_visit_window</li><li>notify_first_screened_in_study</li><li>notify_first_screened_at_site</li><li>notify_first_randomized_in_study</li><li>notify_first_randomized_at_site</li><li>allow_withdrawal_before_enrollment</li><li>allow_display_signature_elements</li><li>replace_subject_number_rand_number</li><li>code_data_for_new_and_screen_failed_subjects</li><li>blind_rand_number_enabled</li><li>replace_randomisation_enabled</li><li>replace_randomisation_prefix</li><li>replace_randomisation_max_limit</li><li>allow_rescreening</li><li>number_of_rescreen_allowed</li><li>lock_screen_data_on_failure</li><li>user_enters_rescreening_visit_date</li><li>user_edits_rescreening_visit_date</li><li>notify_rescreening_failure_only</li><li>replace_subject_number_enabled</li><li>assign_subject_number</li><li>allow_screen_fail_before_screened</li><li>limit_country_AF_status</li><li>limit_country_AF_scr</li><li>limit_country_AF_alerts</li><li>limit_country_AF_name</li><li>limit_country_AF_rand</li><li>limit_country_DZ_alerts</li><li>limit_country_DZ_rand</li><li>limit_country_DZ_status</li><li>limit_country_DZ_name</li><li>limit_country_DZ_scr</li><li>minimum_subject_number</li><li>allow_withdrawal_for_screen_failed</li><li>allow_completion_for_screen_failed</li><li>enable_assign_subject_number</li></ul>",
            "example":"assign_subject_number"
        },
        "attributeValue":{
            "type":"string",
            "description":"Value of the subject setting attribute.",
            "example":"YES"
        }
    },
    "description":"Subject setting data including start version, key/value, and auditing info."
}

Examples

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: object details

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId