REST API for Clinical One Cloud Service

v1.0

get

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

Retrieves a list of events in a study based on start date and end date. Rights: OrsSubjectVisitGet. If no events are specified, all the events in action types are returned. If event types are specified, but none of them are valid, an empty list is returned.

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:
```
A1B2C3D4E5F6478899AABBCCDDEEFF00
```

Query Parameters

endDate(required): string
The ending date and time (optional). 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, or dd-MMM-yyyy HH:mm.
Example:
```
2026-01-31T23:59:59Z
```
events: array[string]
List of events.
Example:
```
New
```
startDate(required): string
The starting date and time (optional). 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, or dd-MMM-yyyy HH:mm.
Example:
```
2026-01-01T00:00:00Z
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : EventsDTO

Type: object

Response object for Events API.

Show Source

events: array events

{
    "type":"object",
    "properties":{
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EventsByType"
            }
        }
    },
    "description":"Response object for Events API."
}

Nested Schema : events

Type: array

Show Source

Array of: object EventsByType

Event details.

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

Nested Schema : EventsByType

Type: object

Event details.

Show Source

eventType: string

Allowed Values: [ "New", "Screened", "Randomized" ]

Event type.

Example: New
ids: array ids

{
    "type":"object",
    "properties":{
        "eventType":{
            "type":"string",
            "description":"Event type.",
            "example":"New",
            "enum":[
                "New",
                "Screened",
                "Randomized"
            ]
        },
        "ids":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Event IDs.",
                "format":"uuid"
            }
        }
    },
    "description":"Event details.",
    "example":{
        "eventType":"New",
        "ids":[
            "B1B8327AFAA6412287106192AB5984EF"
        ]
    }
}

Example:

{
    "eventType":"New",
    "ids":[
        "B1B8327AFAA6412287106192AB5984EF"
    ]
}

Nested Schema : ids

Type: array

Show Source

Array of: string(uuid)

Event IDs.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Event IDs.",
        "format":"uuid"
    }
}

Examples

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Examples