1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Subjects
  5. Update subject

[Deprecated]: V3.0
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
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : SubjectDto_3
Type: object
Subject details including object version number for optimistic locking
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for latest subject update
    Example: Initial enrollment
  • Minimum Length: 0
    Maximum Length: 500
    Free text description for the subject
    Example: Screened subject
  • Date of birth
  • Minimum Length: 0
    Maximum Length: 255
    Reason for enrollment failure, if any
    Example: Consent withdrawn
  • Minimum Length: 0
    Maximum Length: 255
    If subject enrollment is overridden.
    Example: Subject Enrollment Overridden
  • Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.
    Example: Screened
  • Minimum Length: 0
    Maximum Length: 10
    Gender value
    Example: [{"value":"1","label":"male"}]
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Informed consent date
    Example: 2025-09-25T09:00:00Z
  • Object version number
    Example: 14
  • Minimum Length: 0
    Maximum Length: 255
    Reason for latest subject update
    Example: Protocol break happened
  • Screening date if applicable
    Example: 2025-10-01T10:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for screening failure, if any
    Example: Inclusion criteria not met
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.
    Example: Active
  • Timestamp when the subject transitioned to current state
    Example: 2025-10-16T14:30:31.892Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 500
    Unique subject Number representing the patient/participant enrolled in the study.
    Example: SUBJ-0001
  • Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : SubjectDto1
Type: object
Base subject details including identity, demographics, study and site context, and state transitions
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for latest subject update
    Example: Initial enrollment
  • Minimum Length: 0
    Maximum Length: 500
    Free text description for the subject
    Example: Screened subject
  • Date of birth
  • Minimum Length: 0
    Maximum Length: 255
    Reason for enrollment failure, if any
    Example: Consent withdrawn
  • Minimum Length: 0
    Maximum Length: 255
    If subject enrollment is overridden.
    Example: Subject Enrollment Overridden
  • Minimum Length: 0
    Maximum Length: 10
    Gender value
    Example: [{"value":"1","label":"male"}]
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Informed consent date
    Example: 2025-09-25T09:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for latest subject update
    Example: Protocol break happened
  • Screening date if applicable
    Example: 2025-10-01T10:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for screening failure, if any
    Example: Inclusion criteria not met
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.
    Example: Active
  • Timestamp when the subject transitioned to current state
    Example: 2025-10-16T14:30:31.892Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 500
    Unique subject Number representing the patient/participant enrolled in the study.
    Example: SUBJ-0001
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
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
Back to Top