REST API for Clinical One Platform

Get list of events in a study

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

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

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.
events: array[string]

List of the events
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.

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

Object for event details.

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

Nested Schema : EventsByType

Type: object

Object for 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":"IDs of the events",
                "format":"uuid"
            }
        }
    },
    "description":"Object for event details."
}

Nested Schema : ids

Type: array

Show Source

Array of: string(uuid)

IDs of the events

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"IDs of the events",
        "format":"uuid"
    }
}

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response 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

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

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

Result Object