REST API for Clinical One Platform

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Creates new enrollment settings for the specified study and mode. Validates the supplied configuration persists the settings, and returns the created enrollment setting record.

Request

Path Parameters

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

Supported Media Types

application/json

Root Schema : schema

Type: object

DTO representing enrollment setting details, including associated group criteria.

Show Source

count: integer (int32)

Count associated with this setting

Example: 1
description: string

Minimum Length: 0

Maximum Length: 2048

Description for this enrollment setting.

Example: This setting applies to test group.
enableSetting: boolean

Whether this enrollment setting is enabled.

Example: true
groupCriteria: object groupCriteria

DTO describing individual cohort/criteria group for enrollment settings.
groupTitle: string

Minimum Length: 0

Maximum Length: 255

Title or label for the group.

Example: Test Group
id: string

Unique Identfier (UUID, 32-character uppercase hexadecimal string) for this enrollment setting.

Example: AA11BB22CC33DD44EE55FF6677889900
notificationLimit: integer (int32)

Minimum Value: 0

Maximum Value: 100

Notification threshold for subject count.

Example: 60
objectVersionNumber: integer (int32)

Object version number

Example: 2
settingType: string

Type of setting. It can be Scr_limit , Rand_limit

Example: Rand_limit
subjectLimit: integer (int32)

Minimum Value: 0

Maximum number of subjects permitted.

Example: 100

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Identfier (UUID, 32-character uppercase hexadecimal string) for this enrollment setting.",
            "example":"AA11BB22CC33DD44EE55FF6677889900"
        },
        "groupTitle":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Title or label for the group.",
            "example":"Test Group"
        },
        "enableSetting":{
            "type":"boolean",
            "description":"Whether this enrollment setting is enabled.",
            "example":true
        },
        "subjectLimit":{
            "minimum":0,
            "type":"integer",
            "description":"Maximum number of subjects permitted.",
            "format":"int32",
            "example":100
        },
        "notificationLimit":{
            "maximum":100,
            "minimum":0,
            "type":"integer",
            "description":"Notification threshold for subject count.",
            "format":"int32",
            "example":60
        },
        "description":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Description for this enrollment setting.",
            "example":"This setting applies to test group."
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "example":2
        },
        "count":{
            "type":"integer",
            "description":"Count associated with this setting",
            "format":"int32",
            "example":1
        },
        "settingType":{
            "type":"string",
            "description":"Type of setting. It can be Scr_limit , Rand_limit",
            "example":"Rand_limit"
        },
        "groupCriteria":{
            "type":"object",
            "properties":{
                "title":{
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Title or description for the group criteria.",
                    "example":"Male subjects age 18-65"
                },
                "groupId":{
                    "type":"string",
                    "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the group this criteria belongs to.",
                    "example":"BEEF11223344556677889900AABBCCDD"
                },
                "visitId":{
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
                    "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
                },
                "formId":{
                    "type":"string",
                    "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
                    "example":"FORM1"
                },
                "itemId":{
                    "type":"string",
                    "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
                    "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
                },
                "criteriaType":{
                    "maxLength":16,
                    "minLength":0,
                    "type":"string",
                    "description":"Type of criteria applied Should match either numeric or choice.",
                    "example":"choice"
                },
                "startRange":{
                    "type":"number",
                    "description":"Lower bound for range-type group criteria.",
                    "format":"double",
                    "example":18
                },
                "endRange":{
                    "type":"number",
                    "description":"Upper bound for range-type group criteria.",
                    "format":"double",
                    "example":65
                },
                "choiceValue":{
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"List of choice value objects, if applicable for enumeration-type criteria.",
                    "example":"[{\"value\":\"1\",\"label\":\"Yes\"}]"
                },
                "studyVersion":{
                    "maxLength":100,
                    "minLength":0,
                    "type":"string",
                    "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
                    "example":"1.0.0.0"
                },
                "objectVersionNumber":{
                    "type":"integer",
                    "description":"Object version number",
                    "format":"int32",
                    "example":1
                },
                "id":{
                    "type":"string",
                    "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for this group criteria record.",
                    "example":"1234567890AABBCCDDEEFF1122334455"
                }
            },
            "description":"DTO describing individual cohort/criteria group for enrollment settings."
        }
    },
    "description":"DTO representing enrollment setting details, including associated group criteria."
}

Nested Schema : groupCriteria

Type: object

DTO describing individual cohort/criteria group for enrollment settings.

Show Source

choiceValue: string

Minimum Length: 0

Maximum Length: 2048

List of choice value objects, if applicable for enumeration-type criteria.

Example: [{"value":"1","label":"Yes"}]
criteriaType: string

Minimum Length: 0

Maximum Length: 16

Type of criteria applied Should match either numeric or choice.

Example: choice
endRange: number (double)

Upper bound for range-type group criteria.

Example: 65
formId: string

Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

Example: FORM1
groupId: string

Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the group this criteria belongs to.

Example: BEEF11223344556677889900AABBCCDD
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) for this group criteria record.

Example: 1234567890AABBCCDDEEFF1122334455
itemId: string

Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
objectVersionNumber: integer (int32)

Object version number

Example: 1
startRange: number (double)

Lower bound for range-type group criteria.

Example: 18
studyVersion: string

Minimum Length: 0

Maximum Length: 100

String representing the version of the study configuration or protocol. Helps track changes in form or study design.

Example: 1.0.0.0
title: string

Minimum Length: 0

Maximum Length: 2048

Title or description for the group criteria.

Example: Male subjects age 18-65
visitId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE

{
    "type":"object",
    "properties":{
        "title":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Title or description for the group criteria.",
            "example":"Male subjects age 18-65"
        },
        "groupId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the group this criteria belongs to.",
            "example":"BEEF11223344556677889900AABBCCDD"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"FORM1"
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "criteriaType":{
            "maxLength":16,
            "minLength":0,
            "type":"string",
            "description":"Type of criteria applied Should match either numeric or choice.",
            "example":"choice"
        },
        "startRange":{
            "type":"number",
            "description":"Lower bound for range-type group criteria.",
            "format":"double",
            "example":18
        },
        "endRange":{
            "type":"number",
            "description":"Upper bound for range-type group criteria.",
            "format":"double",
            "example":65
        },
        "choiceValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"List of choice value objects, if applicable for enumeration-type criteria.",
            "example":"[{\"value\":\"1\",\"label\":\"Yes\"}]"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.0"
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "example":1
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for this group criteria record.",
            "example":"1234567890AABBCCDDEEFF1122334455"
        }
    },
    "description":"DTO describing individual cohort/criteria group for enrollment settings."
}

Examples

Response

Supported Media Types

application/json

200 Response

Success: The enrollment setting was created. Returns the created enrollment setting(s).

Root Schema : EnrollmentSetting

Type: object

Represents the persisted enrollment setting for a study group.

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment regarding the last change made to the entity.

Example: Imported via migration tool.
description: string

Brief description of the enrollment setting.

Example: Phase 1 - First cohort group
enableSetting: boolean

Indicates if the enrollment setting is enabled.

Example: true
groupTitle: string

Title of the group receiving this setting.

Example: Cohort A
id: string

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

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
notificationLimit: integer (int32)

Notification threshold for approaching subject limit.

Example: 80
operationType: string

Minimum Length: 1

Maximum Length: 16

Operation type on the record, can have values CREATED, MODIFIED or REMOVED

Example: REMOVED
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for the entity creation or latest modification.

Example: Initial import.
subjectLimit: integer (int32)

Maximum number of subjects allowed in this group.

Example: 100
versionStart: string (date-time)

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

Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the enrollment 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-01T09:00:00Z"
        },
        "groupTitle":{
            "type":"string",
            "description":"Title of the group receiving this setting.",
            "example":"Cohort A"
        },
        "subjectLimit":{
            "type":"integer",
            "description":"Maximum number of subjects allowed in this group.",
            "format":"int32",
            "example":100
        },
        "notificationLimit":{
            "type":"integer",
            "description":"Notification threshold for approaching subject limit.",
            "format":"int32",
            "example":80
        },
        "description":{
            "type":"string",
            "description":"Brief description of the enrollment setting.",
            "example":"Phase 1 - First cohort group"
        },
        "enableSetting":{
            "type":"boolean",
            "description":"Indicates if the enrollment setting is enabled.",
            "example":true
        }
    },
    "description":"Represents the persisted enrollment setting for a study group."
}

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