Get a list of events by type
get
/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/events
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.
Request
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.
Root Schema : RestResponse
Type:
Show Source
object
-
errorData: object
ErrorResponseData
Title:
ErrorResponseData
Error Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
object
Title:
ErrorResponseData
Error Response Details Information
Show Source
-
details: object
Object
Title:
Object
Object with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
object
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.