REST API for Clinical One Platform

V1

get

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

Lists changes related to any subjects in the specified in a date range

Request

Path Parameters

mode(required): string
Mode of the study, accepts: test, active, or training.
Example:
```
test
```
studyId(required): string
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
Example:
```
ABCDEF1234567890ABCDEF1234567890
```

Query Parameters

endDate: string(date-time)
The ending date and time (optional) for which you want to get events. If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
Example:
```
2025-DEC-31
```
startDate: string(date-time)
The starting date and time (optional) for which you want to get events. If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
Example:
```
2025-JUN-01
```

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 SubjectEventDto

Base subject event details including event type and transfer identifier

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

Nested Schema : SubjectEventDto

Type: object

Base subject event details including event type and transfer identifier

Show Source

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

If subject enrollment is overridden.

Example: Subject Enrollment Overridden
eventType: string

Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.

Example: Screened
gender: string

Minimum Length: 0

Maximum Length: 10

Gender value

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

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
informedConsentDate: string (date-time)

Informed consent date

Example: 2025-09-25T09:00:00Z
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

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

Example: ABCDEF1234567890ABCDEF1234567890
state(required): string

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
stateDate: string (date-time)

Timestamp when the subject transitioned to current state

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

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Example: ABCDEF1234567890ABCDEF1234567890
studyVersion(required): string

String representing the version of the study configuration or protocol. Helps track changes in form or study design.

Example: 3.0.0.1
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500

Unique subject Number representing the patient/participant enrolled in the study.

Example: SUBJ-0001
subjectTransferId: string

Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
versionStart: string (date-time)

The timestamp marking the beginning of the validity period for this record version within the system.

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"
        },
        "eventType":{
            "type":"string",
            "description":"Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.",
            "example":"Screened"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "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":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0001"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "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.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.",
            "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":"If subject enrollment is overridden.",
            "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":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        }
    },
    "description":"Base subject event details including event type and transfer identifier"
}

Examples

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: object details

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
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":"object",
            "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

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