REST API for Clinical One Platform

Create enrollment settings

post

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

Creates an enrollment settings. This operation is needed to create enrollment settings based on item values.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study for which you want to get/update/delete enrollment settings.

Supported Media Types

Root Schema : schema

Type: object

Show Source

count: integer (int32)
description: string

Minimum Length: 0

Maximum Length: 2048
enableSetting: boolean
groupCriteria: array groupCriteria
groupTitle: string

Minimum Length: 0

Maximum Length: 255
id: string (uuid)
notificationLimit: integer (int32)

Minimum Value: 0

Maximum Value: 100
objectVersionNumber: number
settingType: string
subjectLimit: integer (int32)

Minimum Value: 0

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "groupTitle":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enableSetting":{
            "type":"boolean"
        },
        "subjectLimit":{
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "notificationLimit":{
            "maximum":100,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "description":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "settingType":{
            "type":"string"
        },
        "groupCriteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnrollmentGroupDto"
            }
        }
    }
}

Nested Schema : groupCriteria

Type: array

Show Source

Array of: object EnrollmentGroupDto

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

Nested Schema : EnrollmentGroupDto

Type: object

Show Source

choiceValue: string

Minimum Length: 0

Maximum Length: 2048
criteriaType: string

Minimum Length: 0

Maximum Length: 16
endRange: number (double)
formId: string
groupId: string (uuid)
id: string (uuid)
itemId: string
objectVersionNumber: number
startRange: number (double)
studyVersion: string

Minimum Length: 0

Maximum Length: 100
title: string

Minimum Length: 0

Maximum Length: 2048
visitId: string

{
    "type":"object",
    "properties":{
        "title":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "groupId":{
            "type":"string",
            "format":"uuid"
        },
        "visitId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "criteriaType":{
            "maxLength":16,
            "minLength":0,
            "type":"string"
        },
        "startRange":{
            "type":"number",
            "format":"double"
        },
        "endRange":{
            "type":"number",
            "format":"double"
        },
        "choiceValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object EnrollmentSetting

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

Nested Schema : EnrollmentSetting

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
description: string
enableSetting: boolean
groupTitle: string
id: string (uuid)
notificationLimit: integer (int32)
operationType: string

Minimum Length: 1

Maximum Length: 16
reason: string

Minimum Length: 0

Maximum Length: 255
subjectLimit: integer (int32)
userId: string (uuid)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "groupTitle":{
            "type":"string"
        },
        "subjectLimit":{
            "type":"integer",
            "format":"int32"
        },
        "notificationLimit":{
            "type":"integer",
            "format":"int32"
        },
        "description":{
            "type":"string"
        },
        "enableSetting":{
            "type":"boolean"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object