[Deprecated]: Get a list of events by type
get
/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/events
Deprecated: Retrieves all events for all subjects within the specified study and mode. Can restrict to events of a particular type that occurred within a specified date range. For example, you can retrieve a list of all screening events that took place in the previous month. Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/events
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
studyId(required): string
ID of the study to which the subject belongs.
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.
-
events: array[string]
The type of event you want to retrieve. Accepts (case-sensitive): New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Transferred, Screen_Failed, Code_Break, Complete, Undo_Complete, Undo_ScrFailed, Visit_Complete, or DataElement_Change. You can specify more than one event type by repeating this parameter with different values.
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Subjects success.
Root Schema : SubjectEventsInfoDto
Type:
Show Source
object
-
events: array
events
-
mode: string
Allowed Values:
[ "DESIGN", "TEST", "TRAINING", "ACTIVE", "ALL" ]
-
studyId: string
-
tenant: string
400 Response
Bad request.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object