Jump to

• Request
• Response

V1.0

post

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

Process all unprocessed notification logs. It returns processed notifications details in response.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  active

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  6153170BDE5244A0BB3DF169C4168483

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request processed successfully, check the result

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object NotificationsBroadcast
  Notification broadcast record representing a user-targeted notification with audit and delivery metadata

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

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
  Audit trail field that represents the version number of the data.

  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 user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.

  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 user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "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"
        },
        "actionId":{
            "type":"string",
            "description":"Same value as notification id (UUID, 32-character uppercase hexadecimal string)",
            "example":"24C9C2B19F1B46ED964CD6653FC10791"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":2
        }
    },
    "description":"Notification broadcast record representing a user-targeted notification with audit and delivery metadata"
}

Examples

Select an example NotificationsBroadcastList

Back to Top