REST API for Clinical One Cloud Service

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-doseholds

Retrieves the visits marked with dose hold for all subjects.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Supported Media Types

application/json

Root Schema : DoseholdSubjectsRequest v1.0

Type: object

Title: DoseholdSubjectsRequest v1.0

Contains a list of subjects to get dosehold details.

Show Source

subjects(required): array Subjects

Title: Subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of subject IDs.

{
    "title":"DoseholdSubjectsRequest v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "title":"Subjects",
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"List of subject IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains a list of subjects to get dosehold details."
}

Nested Schema : Subjects

Type: array

Title: Subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of subject IDs.

Show Source

Array of: string(uuid)

{
    "title":"Subjects",
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"List of subject IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DoseholdSubjectsResponse v1.0

Type: object

Title: DoseholdSubjectsResponse v1.0

Response containing dose hold visits for subjects.

Show Source

subjects: array Subjects

Title: Subjects

List of dose hold visits for subjects.

{
    "title":"DoseholdSubjectsResponse v1.0",
    "type":"object",
    "properties":{
        "subjects":{
            "title":"Subjects",
            "type":"array",
            "description":"List of dose hold visits for subjects.",
            "items":{
                "$ref":"#/components/schemas/DoseholdSubjectVisitsTO"
            }
        }
    },
    "description":"Response containing dose hold visits for subjects."
}

Nested Schema : Subjects

Type: array

Title: Subjects

List of dose hold visits for subjects.

Show Source

Array of: object DoseholdSubjectVisitsTO v1.0

Title: DoseholdSubjectVisitsTO v1.0

Contains dosehold visits for a subject.

{
    "title":"Subjects",
    "type":"array",
    "description":"List of dose hold visits for subjects.",
    "items":{
        "$ref":"#/components/schemas/DoseholdSubjectVisitsTO"
    }
}

Nested Schema : DoseholdSubjectVisitsTO v1.0

Type: object

Title: DoseholdSubjectVisitsTO v1.0

Contains dosehold visits for a subject.

Show Source

instanceNumber: number (BigDecimal)

Title: Instance Number

Minimum Value: 1

Visit instance number.

Example: 2
subjectId: string (uuid)

Title: Subject ID

Subject ID.
visitId: string (uuid)

Title: Visit ID

Visit ID.

{
    "title":"DoseholdSubjectVisitsTO v1.0",
    "type":"object",
    "properties":{
        "subjectId":{
            "title":"Subject ID",
            "type":"string",
            "description":"Subject ID.",
            "format":"uuid"
        },
        "visitId":{
            "title":"Visit ID",
            "type":"string",
            "description":"Visit ID.",
            "format":"uuid"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "format":"BigDecimal",
            "example":2
        }
    },
    "description":"Contains dosehold visits for a subject."
}

Examples