REST API for Clinical One Platform

~~[Deprecated]: Update subject details~~

put

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

Deprecated: Returns the mHealth subject ID as part of the response. All values listed in the 'body' of the API below are required fields to be completed as part of this API request. Please note that the following values have to be specified, however, these changes won't be applied (or these changes will take the current date for the timestamp), such as the field for 'dob','eventType','gender','informedConsentDate','screeningDate','stateDate','subjectTransferId','userId','versionStart'.

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

Subject ID to update.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

subject: object SubjectDto3

Subject details including object version number for optimistic locking

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto3"
        }
    }
}

Nested Schema : SubjectDto3

Type: object

Subject details including object version number for optimistic locking

Show Source

codeBreak: string

Code break note if applicable

Example: N
comment: string

Minimum Length: 0

Maximum Length: 2048

Comment for latest subject update

Example: Initial enrollment
description: string

Minimum Length: 0

Maximum Length: 500

Free text description for the subject

Example: Screened subject
dob: string (date-time)

Date of birth
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255

Reason for enrollment failure, if any

Example: Consent withdrawn
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255

Enrollment override note if applied

Example: Subject Enrollment Overridden
eventType: string

Type of event associated with the subject

Example: Screened
gender: string

Minimum Length: 0

Maximum Length: 10

Gender value

Example: [{"value":"1","label":"male"}]
id: string (uuid)

Unique identifier of the subject
informedConsentDate: string (date-time)

Informed consent date

Example: 2025-09-25T09:00:00Z
objectVersionNumber: number

Object version number used for concurrency control

Example: 14
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for latest subject update

Example: Protocol break happened
screeningDate: string (date-time)

Screening date if applicable

Example: 2025-10-01T10:00:00Z
screeningFailure: string

Minimum Length: 0

Maximum Length: 255

Reason for screening failure, if any

Example: Inclusion criteria not met
siteId: string

Site identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
state(required): string

Minimum Length: 0

Maximum Length: 100

Lifecycle state of the subject

Example: ACTIVE
stateDate: string (date-time)

Timestamp when the subject transitioned to current state

Example: 2025-10-16T14:30:31.892Z
studyId: string

Study identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
studyVersion(required): string

Study version string

Example: 3.0.0.1
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500

Human readable subject number

Example: SUBJ-0001
subjectTransferId: string (uuid)

Identifier of a subject transfer if applicable
userId: string (uuid)

User identifier associated with the subject modification
versionStart: string (date-time)

Start timestamp of the subject version

Example: 2025-10-16T14:30:31.892Z

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "description":"Screening date if applicable",
            "format":"date-time",
            "example":"2025-10-01T10:00:00Z"
        },
        "codeBreak":{
            "type":"string",
            "description":"Code break note if applicable",
            "example":"N"
        },
        "userId":{
            "type":"string",
            "description":"User identifier associated with the subject modification",
            "format":"uuid"
        },
        "eventType":{
            "type":"string",
            "description":"Type of event associated with the subject",
            "example":"Screened"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"Identifier of a subject transfer if applicable",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control",
            "example":14
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the subject",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the subject version",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Free text description for the subject",
            "example":"Screened subject"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Human readable subject number",
            "example":"SUBJ-0001"
        },
        "studyId":{
            "type":"string",
            "description":"Study identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Site identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject",
            "example":"ACTIVE"
        },
        "stateDate":{
            "type":"string",
            "description":"Timestamp when the subject transitioned to current state",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for screening failure, if any",
            "example":"Inclusion criteria not met"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for enrollment failure, if any",
            "example":"Consent withdrawn"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Enrollment override note if applied",
            "example":"Subject Enrollment Overridden"
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Informed consent date",
            "format":"date-time",
            "example":"2025-09-25T09:00:00Z"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Gender value",
            "example":"[{\"value\":\"1\",\"label\":\"male\"}]"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for latest subject update",
            "example":"Protocol break happened"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for latest subject update",
            "example":"Initial enrollment"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version string",
            "example":"3.0.0.1"
        }
    },
    "description":"Subject details including object version number for optimistic locking"
}

Response

Supported Media Types

application/json

200 Response

Success

Root 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

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: string

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
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":"string",
            "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