Jump to

• Request
• Response

v1.0

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.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  3F2504E04F8911D39A0C0305E82C3301

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.

  Example:

  26-Oct-2023 14:30:45.123

• 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.

  Example:

  [
      "Screened"
  ]

• 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.

  Example:

  25-Oct-2023 14:30:45.123

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

Container for subject event details within a study and mode, including a list of event entries per subject.

Show Source

• events: array events
  List of event entries including event id and associated subjects
• mode: string
  Mode of the study, accepts: test, active, or training.

  Example: active
• studyId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: ABCDEF1234567890ABCDEF1234567890
• tenant: string
  Tenant identifier

  Example: TENANT-A

{
    "type":"object",
    "properties":{
        "tenant":{
            "type":"string",
            "description":"Tenant identifier",
            "example":"TENANT-A"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "mode":{
            "type":"string",
            "description":"Mode of the study, accepts: test, active, or training.",
            "example":"active"
        },
        "events":{
            "type":"array",
            "description":"List of event entries including event id and associated subjects",
            "items":{
                "$ref":"#/components/schemas/SubjectEventInfoDto"
            }
        }
    },
    "description":"Container for subject event details within a study and mode, including a list of event entries per subject."
}

Nested Schema : events

Type: array

List of event entries including event id and associated subjects

Show Source

• Array of: object SubjectEventInfoDto
  Event summary including the event identifier and the list of associated subject identifiers.

{
    "type":"array",
    "description":"List of event entries including event id and associated subjects",
    "items":{
        "$ref":"#/components/schemas/SubjectEventInfoDto"
    }
}

Nested Schema : SubjectEventInfoDto

Type: object

Event summary including the event identifier and the list of associated subject identifiers.

Show Source

• eventId: string
  Event associated with the Subject. The acceptable values are - SubjectNumberReplaced, SubjectNumberChanged, Enrolled, New, Randomized, Complete, Undo_Withdrawn, Screened, Transferred, Screen_Failed, Visit_Complete, VisitDispensed, VisitRandomized and VisitScreened

  Example: SubjectNumberReplaced
• subjects: array subjects
  List of subject identifiers associated with the event

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Event associated with the Subject. The acceptable values are - SubjectNumberReplaced, SubjectNumberChanged, Enrolled, New, Randomized, Complete, Undo_Withdrawn, Screened, Transferred, Screen_Failed, Visit_Complete, VisitDispensed, VisitRandomized  and VisitScreened ",
            "example":"SubjectNumberReplaced"
        },
        "subjects":{
            "type":"array",
            "description":"List of subject identifiers associated with the event",
            "example":[
                "1BC29B36F5D64B1B95F4BDBBCEA481BE",
                "93CC828113AC439181071CB44D2C6FE5"
            ],
            "items":{
                "type":"string",
                "description":"List of subject identifiers associated with the event",
                "format":"uuid"
            }
        }
    },
    "description":"Event summary including the event identifier and the list of associated subject identifiers."
}

Nested Schema : subjects

Type: array

List of subject identifiers associated with the event

Show Source

• Array of: string(uuid)
  List of subject identifiers associated with the event

{
    "type":"array",
    "description":"List of subject identifiers associated with the event",
    "example":[
        "1BC29B36F5D64B1B95F4BDBBCEA481BE",
        "93CC828113AC439181071CB44D2C6FE5"
    ],
    "items":{
        "type":"string",
        "description":"List of subject identifiers associated with the event",
        "format":"uuid"
    }
}

Example:

[
    "1BC29B36F5D64B1B95F4BDBBCEA481BE",
    "93CC828113AC439181071CB44D2C6FE5"
]

Examples

Select an example SubjectEventsInfoDto

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: 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
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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":"object",
            "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

Nested Schema : details

Type: object

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

Back to Top