Jump to

• Request
• Response

V1.0

get

/ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}

Retrieves notification broadcast details by notification broadcast ID.

Request

Path Parameters

• id(required): string(uuid)
  ID of the notification to retrieve (UUID, 32-character uppercase hexadecimal string)

  Example:

  24C9C2B19F1B46ED964CD6653FC10791

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

  Example:

  active

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

  Example:

  6153170BDE5244A0BB3DF169C4168483

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully retrieved broadcast emails. status: success and errorData: null

Body ()

Root Schema : NotificationsDetailResponse

Type: object

Aggregated notification broadcast details combined with notification log metadata

Show Source

• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 6153170BDE5244A0BB3DF169C4168483
• entityType: string
  Type of entity associated with this notification. Some examples: STUDY, SUBJECT, SITE

  Example: STUDY
• messageDescription: string
  Detailed notification message text.

  Example: Study Design Report is now ready in Clinical One.
• messageSubject: string
  Subject or title of the notification message.

  Example: S4-Copy | Study Design Report is ready in Clinical One
• notificationsBroadcast: object NotificationsBroadcast
  Notification broadcast record representing a user-targeted notification with audit and delivery metadata

{
    "type":"object",
    "properties":{
        "messageDescription":{
            "type":"string",
            "description":"Detailed notification message text.",
            "example":"Study Design Report is now ready in Clinical One."
        },
        "messageSubject":{
            "type":"string",
            "description":"Subject or title of the notification message.",
            "example":"S4-Copy | Study Design Report is ready in Clinical One"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"6153170BDE5244A0BB3DF169C4168483"
        },
        "entityType":{
            "type":"string",
            "description":"Type of entity associated with this notification. Some examples: STUDY, SUBJECT, SITE",
            "example":"STUDY"
        },
        "notificationsBroadcast":{
            "$ref":"#/components/schemas/NotificationsBroadcast"
        }
    },
    "description":"Aggregated notification broadcast details combined with notification log metadata"
}

Nested Schema : NotificationsBroadcast

Type: object

Notification broadcast record representing a user-targeted notification with audit and delivery metadata

Show Source

• actionId: string
  Same value as notification id (UUID, 32-character uppercase hexadecimal string)

  Example: 24C9C2B19F1B46ED964CD6653FC10791
• approvalFlag: string
  Allowed Values: [ "Y", "N" ]

  Approval flag indicating if approval is required.

  Example: N
• archiveDateTime(required): string
  Timestamp when the message was archived.

  Example: Sun Dec 31 00:00:00 GMT 3099
• category: string
  Functional category of the notification. Some examples: Shipment Failure, Site state Change, Report Generation etc.

  Example: Report Generation
• comments: string
  Additional comments for the notification event.

  Example: New Report
• emailAttemptDateTime: string (date-time)
  Timestamp of the last email delivery attempt.

  Example: 2025-11-13T08:28:02.345Z
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing broadcast notification id.

  Example: 24C9C2B19F1B46ED964CD6653FC10791
• messageReadDateTime(required): string
  Timestamp when the message was read.

  Example: Sun Dec 31 00:00:00 GMT 3099
• notificationDateTime: string
  Time when the notification was sent or scheduled.

  Example: Thu Nov 13 08:28:02 GMT 2025
• notificationLogId: string
  Unique id (UUID, 32-character uppercase hexadecimal string) linked to notification log.

  Example: AB16747FB7DC4F26863979B26F58CBCD
• objectVersionNumber: number
  Object version number

  Example: 2
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• reason: string
  Reason

  Example: New Report
• softwareVersionNumber: number
  Software version number

  Example: 1
• subscription: string
  Allowed Values: [ "YES", "NO" ]

  Subscription status for the user to this notification type

  Example: YES
• updatedBy: string
  The user who last updated the record (UUID, 32-character uppercase hexadecimal string)

  Example: 225B79C982104415886DE02BC73C1E1E
• userEmailAddress: string (email)
  Target user's email address.

  Example: [e-mail]
• userId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user

  Example: D79F8A8A1B9E4F9A9A25E3B3B1C2D3E4
• userName: string
  Target user's display name.

  Example: system ClinicalOne
• versionEnd: string (date-time)
  Version end timestamp for this record.

  Example: 3099-12-31T00:00:00Z
• versionStart: string (date-time)
  Version start timestamp for this record.

  Example: 2025-11-13T08:28:02.345Z

{
    "required":[
        "archiveDateTime",
        "messageReadDateTime"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing broadcast notification id.",
            "example":"24C9C2B19F1B46ED964CD6653FC10791"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start timestamp for this record.",
            "format":"date-time",
            "example":"2025-11-13T08:28:02.345Z"
        },
        "notificationLogId":{
            "type":"string",
            "description":"Unique id (UUID, 32-character uppercase hexadecimal string) linked to notification log.",
            "example":"AB16747FB7DC4F26863979B26F58CBCD"
        },
        "userId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user",
            "example":"D79F8A8A1B9E4F9A9A25E3B3B1C2D3E4"
        },
        "userName":{
            "type":"string",
            "description":"Target user's display name.",
            "example":"system ClinicalOne"
        },
        "userEmailAddress":{
            "type":"string",
            "description":"Target user's email address.",
            "format":"email",
            "example":"[e-mail]"
        },
        "subscription":{
            "type":"string",
            "description":"Subscription status for the user to this notification type",
            "example":"YES",
            "enum":[
                "YES",
                "NO"
            ]
        },
        "messageReadDateTime":{
            "type":"string",
            "description":"Timestamp when the message was read.",
            "example":"Sun Dec 31 00:00:00 GMT 3099"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end timestamp for this record.",
            "format":"date-time",
            "example":"3099-12-31T00:00:00Z"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "reason":{
            "type":"string",
            "description":"Reason",
            "example":"New Report"
        },
        "archiveDateTime":{
            "type":"string",
            "description":"Timestamp when the message was archived.",
            "example":"Sun Dec 31 00:00:00 GMT 3099"
        },
        "category":{
            "type":"string",
            "description":"Functional category of the notification. Some examples: Shipment Failure, Site state Change, Report Generation etc.",
            "example":"Report Generation"
        },
        "emailAttemptDateTime":{
            "type":"string",
            "description":"Timestamp of the last email delivery attempt.",
            "format":"date-time",
            "example":"2025-11-13T08:28:02.345Z"
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the record (UUID, 32-character uppercase hexadecimal string)",
            "example":"225B79C982104415886DE02BC73C1E1E"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":1
        },
        "approvalFlag":{
            "type":"string",
            "description":"Approval flag indicating if approval is required.",
            "example":"N",
            "enum":[
                "Y",
                "N"
            ]
        },
        "notificationDateTime":{
            "type":"string",
            "description":"Time when the notification was sent or scheduled.",
            "example":"Thu Nov 13 08:28:02 GMT 2025"
        },
        "comments":{
            "type":"string",
            "description":"Additional comments for the notification event.",
            "example":"New Report"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number",
            "example":2
        },
        "actionId":{
            "type":"string",
            "description":"Same value as notification id (UUID, 32-character uppercase hexadecimal string)",
            "example":"24C9C2B19F1B46ED964CD6653FC10791"
        }
    },
    "description":"Notification broadcast record representing a user-targeted notification with audit and delivery metadata"
}

Examples

Select an example NotificationsDetailResponse

400 Response

Error in request, check the request

Body ()

Root Schema : NotificationResponse

Type: object

Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails.

Show Source

• errorData: object Error Response
  Read Only: true

  Standard error body containing code, message and optional details.
• result: object result
  Read Only: true

  Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
• status: string
  Read Only: true

  Allowed Values: [ "success, Failed" ]

  Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success, Failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error Response"
        }
    },
    "description":"Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails."
}

Nested Schema : Error Response

Type: object

Read Only: true

Standard error body containing code, message and optional details.

Show Source

• details: object details
  Read Only: true

  Optional additional details about the error for diagnostics.
• errorCode: string
  Read Only: true

  Application-specific error code representing the failure reason.

  Example: VALIDATION_ERROR
• errorMessage: string
  Read Only: true

  Human-readable message describing the error.

  Example: Request payload validation failed

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code representing the failure reason.",
            "readOnly":true,
            "example":"VALIDATION_ERROR"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable message describing the error.",
            "readOnly":true,
            "example":"Request payload validation failed"
        },
        "details":{
            "type":"object",
            "description":"Optional additional details about the error for diagnostics.",
            "nullable":true,
            "readOnly":true
        }
    },
    "description":"Standard error body containing code, message and optional details.",
    "nullable":true,
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.

Nested Schema : details

Type: object

Read Only: true

Optional additional details about the error for diagnostics.

Examples

Select an example NotificationResponse

Back to Top