REST API for Clinical One Platform

Perform code break on a subject

put

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak

Perform code break for the specified subject. Caution: This operation unblinds subject information. Also, depending on subject settings, this action might also withdraw the subject. This API version includes mHealthSubject ID and SourceTimeStamp Value.

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 the list of subjects.
subjectId(required): string(uuid)

ID of the subject on which you want to perform code break.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
reason: string

Minimum Length: 0

Maximum Length: 255
sourceTimeStamp: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object SubjectDto40

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

Nested Schema : SubjectDto40

Type: object

Show Source

codeBreak: string
comment: string

Minimum Length: 0

Maximum Length: 2048
description: string

Minimum Length: 0

Maximum Length: 500
dob: string (date-time)
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255
eventType: string
gender: string

Minimum Length: 0

Maximum Length: 10
id: string (uuid)
informedConsentDate: string (date-time)
mhealthSubjectId: string (uuid)
objectVersionNumber: number
reason: string

Minimum Length: 0

Maximum Length: 255
screeningDate: string (date-time)
screeningFailure: string

Minimum Length: 0

Maximum Length: 255
siteId: string
sourceTimeStamp: string (date-time)
state(required): string

Minimum Length: 0

Maximum Length: 100
stateDate: string (date-time)
studyId: string
studyVersion(required): string
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500
subjectTransferId: string (uuid)
userId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "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