Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : SubjectEventsInfoDto

Type: object

Show Source

• events: array events
• mode: string
  Allowed Values: [ "DESIGN", "TEST", "TRAINING", "ACTIVE", "ALL" ]
• studyId: string
• tenant: string

{
    "type":"object",
    "properties":{
        "tenant":{
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "mode":{
            "type":"string",
            "enum":[
                "DESIGN",
                "TEST",
                "TRAINING",
                "ACTIVE",
                "ALL"
            ]
        },
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectEventInfoDto"
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object SubjectEventInfoDto

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

Nested Schema : SubjectEventInfoDto

Type: object

Show Source

• eventId: string
• subjects: array subjects

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string"
        },
        "subjects":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : subjects

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

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

Nested Schema : details

Type: object

Back to Top