REST API for Clinical One Platform

~~[Deprecated]: Get all subjects for a specific study version~~

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sitestudyversion

Deprecated: Lists all subjects for sites in a specific study version that you have access to and that have a study version. Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.

Request

Path Parameters

mode(required): string

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

ID of the study to which the subject belongs.

Query Parameters

limit: integer(int32)

Minimum Value: 0

The number of subjects, beginning with the offset, that you want to retrieve. Offset must be provided to use this parameter. For example, if you want to retrieve subjects in multiple batches of 10, you can start with an offset of 0 and limit of 10, then repeat calls to this endpoint and increase the offset value by 10 each time.
offset: integer(int32)

Minimum Value: 0

An order number to specify with which subject you want to start retrieving subjects. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter.
order(required): string

The sorting order for subjects. Sorting is done by subject number. If you don't specify a value, the order is ascending by default. Accepts asc or desc.
siteId: string(uuid)

ID of the site for which you want to retrieve subjects. The site must have a study version to return any results.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object SubjectDto

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

Nested Schema : SubjectDto

Type: object

Show Source

anchorKey: string
values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

key: string
keyType(required): string
name: string

{
    "required":[
        "keyType"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

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