1. REST API for Clinical One Platform
  2. Tasks
  3. Notifications
  4. Log
  5. Create a log entry and broadcast immediately or schedule notifications

V5.0

post

/ec-notifications-svc/rest/v5.0/studies/{studyId}/{mode}/notificationlog

Creates a log entry and immediately broadcast it or schedules it. This version supports anchor index which enables having multiple values for an anchor key. Relative to v4.0: adds anchorIndex on body anchors to disambiguate repeated keys.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "Y", "N" ]
    Approval flag indicating if approval is required
    Example: Y
  • Attachment content as base64 encoded bytes
    Example: SGVsbG8gd29ybGQh11
  • Provider API version used to generate the attachment URL
    Example: null
  • Attachment URL reference when content is not embedded
    Example: null
  • Provider of the attachment URL
    Example: null
  • Functional category of the notification. Some examples: Shipment Failure, Site state Change, Report Generation etc.
    Example: Report Generation
  • Minimum Length: 0
    Maximum Length: 2048
    Comment
    Example: Shipment Failure Notification
  • User or process that created the notification
    Example: Eva, Hulshagen
  • Creation timestamp of the notification
    Example: 2025-03-21T10:20:30Z
  • Minimum Length: 0
    Maximum Length: 4000
    Comma separated list of email addresses
    Example: john.doe@oracle.com,jane.doe@oracle.com
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "y", "n" ]
    Send only email without in-app notification
    Example: n
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Entity type associated with the notification. Some examples: Study, Site, Subject.
    Example: Site
  • Unique identifier of the notification log record (UUID, 32-character uppercase hexadecimal string)
    Example: 33D0D74837F6454B836AAB5BA2574D28
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "y", "n" ]
    Immediate processing flag
    Example: n
  • Minimum Length: 0
    Maximum Length: 32767
    Detailed message body of the notification
    Example: Drug Order ID:09009Original Request Date: Eastern Time (US & Cananda): 21-May-2012 9:45 PManual Request Date: Eastern Time (US & Canada): 19-Jul-2016 3:56 PSite ID: 50Site Name: UAT, Claudia DabijaSite Address: 12 West RD, Phoenix, ARequestor Name: Eva, HulshageEmail: eva.hulshagen@oracle.coPlease complete the Manual request here. If you do not have the access to the drg supply system, please contact the Sponsor to verify you have received the cancel request and the drugs listed in this shipment have not left the possession of the depot.
  • MessageLanguageSupportedDto2
    Structure holding localized message subject and body with indexed anchors for deterministic replacement order
  • Minimum Length: 0
    Maximum Length: 1024
    Subject/title of the notification
    Example: Cancellation Shipment Request
  • Time when the notification was sent or scheduled
    Example: 2025-03-21T10:20:30.000Z
  • Object version number used for concurrency control.
    Example: 1
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: CREATED
  • Allowed Values: [ "LOW", "HIGH", "0", "1" ]
    Priority of the notification
    Example: HIGH
  • Business right or privilege associated with this notification. Some examples: SiteStatusChangeNotification, ReportNotification
    Example: SiteStatusChangeNotification
  • Minimum Length: 0
    Maximum Length: 255
    Reason
    Example: Inventory control system failure
  • Allowed Values: [ "dc", "ors", "reporting", "ruledesigner", "sites" ]
    Service name that generated the notification
    Example: dc
  • Software version number used when the record was generated.
    Example: 1
  • targetList
    List on ORS site information
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user
    Example: D79F8A8A1B9E4F9A9A25E3B3B1C2D3E4
  • Minimum Length: 0
    Maximum Length: 4000
    Comma separated list of user identifiers targeted by this notification
    Example: 1BC29B36F5D64B1B95F4B987CEA481BE,1BC29B36F5D64B1B95F4BD234EA481BE
  • The end date until which the data is applicable or valid.
    Example: 2025-03-21T10:20:30.000Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-03-20T10:20:30.000Z
Nested Schema : MessageLanguageSupportedDto2
Type: object
Structure holding localized message subject and body with indexed anchors for deterministic replacement order
Show Source
Nested Schema : targetList
Type: array
List on ORS site information
Show Source
Nested Schema : BodyDto2
Type: object
Notification body template for v5 including HTML content and indexed anchors for deterministic replacement
Show Source
Nested Schema : SubjectDto
Type: object
Subject anchor and associated value entries
Show Source
  • Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.
    Example: NTF_ORS_DEPOT_LOW_KIT
  • values
    Collection of key-type-name entries for this subject
Example:
{
    "anchorKey":"NTF_ORS_DEPOT_LOW_KIT",
    "values":[
        {
            "key":"101",
            "keyType":"VISIT",
            "name":"Visit 1"
        }
    ]
}
Nested Schema : anchors
Type: array
List of body anchors with index and their substitution values
Show Source
Nested Schema : NotificationAnchorDto2
Type: object
Anchor replacement entry for localized message body with indexed anchors.
Show Source
  • 0-based index of the anchor occurrence within the message body.
    Example: 0
  • Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.
    Example: NTF_ORS_BODY_STUDY_NAME
  • values
    List of substitution values for this anchor
Nested Schema : values
Type: array
List of substitution values for this anchor
Show Source
Nested Schema : ValueDto
Type: object
Key, type, and display name entry for a subject
Show Source
Nested Schema : values
Type: array
Collection of key-type-name entries for this subject
Show Source
Nested Schema : NotificationLogTargetDto
Type: object
Target mapping linking a notification to an entity such as a site or depot
Show Source
Examples

Back to Top

Response

Supported Media Types

202 Response

Request processed successfully, check the result
Body ()
Root Schema : schema
Type: object
Show Source
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "Y", "N" ]
    Approval flag indicating if approval is required
    Example: Y
  • Attachment content as base64 encoded bytes
    Example: SGVsbG8gd29ybGQh11
  • Provider API version used to generate the attachment URL
    Example: null
  • Attachment URL reference when content is not embedded
    Example: null
  • Provider of the attachment URL
    Example: null
  • Functional category of the notification. Some examples: Shipment Failure, Site state Change, Report Generation etc.
    Example: Report Generation
  • Minimum Length: 0
    Maximum Length: 2048
    Comment
    Example: Shipment Failure Notification
  • User or process that created the notification
    Example: Eva, Hulshagen
  • Creation timestamp of the notification
    Example: 2025-03-21T10:20:30Z
  • Minimum Length: 0
    Maximum Length: 4000
    Comma separated list of email addresses
    Example: john.doe@oracle.com,jane.doe@oracle.com
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "y", "n" ]
    Send only email without in-app notification
    Example: n
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Entity type associated with the notification. Some examples: Study, Site, Subject.
    Example: Site
  • Unique identifier of the notification log record (UUID, 32-character uppercase hexadecimal string)
    Example: 33D0D74837F6454B836AAB5BA2574D28
  • Minimum Length: 0
    Maximum Length: 1
    Allowed Values: [ "y", "n" ]
    Immediate processing flag
    Example: n
  • Minimum Length: 0
    Maximum Length: 32767
    Detailed message body of the notification
    Example: Drug Order ID:09009Original Request Date: Eastern Time (US & Cananda): 21-May-2012 9:45 PManual Request Date: Eastern Time (US & Canada): 19-Jul-2016 3:56 PSite ID: 50Site Name: UAT, Claudia DabijaSite Address: 12 West RD, Phoenix, ARequestor Name: Eva, HulshageEmail: eva.hulshagen@oracle.coPlease complete the Manual request here. If you do not have the access to the drg supply system, please contact the Sponsor to verify you have received the cancel request and the drugs listed in this shipment have not left the possession of the depot.
  • MessageLanguageSupportedDto2
    Structure holding localized message subject and body with indexed anchors for deterministic replacement order
  • Minimum Length: 0
    Maximum Length: 1024
    Subject/title of the notification
    Example: Cancellation Shipment Request
  • Time when the notification was sent or scheduled
    Example: 2025-03-21T10:20:30.000Z
  • Object version number used for concurrency control.
    Example: 1
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: CREATED
  • Allowed Values: [ "LOW", "HIGH", "0", "1" ]
    Priority of the notification
    Example: HIGH
  • Business right or privilege associated with this notification. Some examples: SiteStatusChangeNotification, ReportNotification
    Example: SiteStatusChangeNotification
  • Minimum Length: 0
    Maximum Length: 255
    Reason
    Example: Inventory control system failure
  • Allowed Values: [ "dc", "ors", "reporting", "ruledesigner", "sites" ]
    Service name that generated the notification
    Example: dc
  • Software version number used when the record was generated.
    Example: 1
  • targetList
    List on ORS site information
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the user
    Example: D79F8A8A1B9E4F9A9A25E3B3B1C2D3E4
  • Minimum Length: 0
    Maximum Length: 4000
    Comma separated list of user identifiers targeted by this notification
    Example: 1BC29B36F5D64B1B95F4B987CEA481BE,1BC29B36F5D64B1B95F4BD234EA481BE
  • The end date until which the data is applicable or valid.
    Example: 2025-03-21T10:20:30.000Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-03-20T10:20:30.000Z
Nested Schema : MessageLanguageSupportedDto2
Type: object
Structure holding localized message subject and body with indexed anchors for deterministic replacement order
Show Source
Nested Schema : targetList
Type: array
List on ORS site information
Show Source
Nested Schema : BodyDto2
Type: object
Notification body template for v5 including HTML content and indexed anchors for deterministic replacement
Show Source
Nested Schema : SubjectDto
Type: object
Subject anchor and associated value entries
Show Source
  • Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.
    Example: NTF_ORS_DEPOT_LOW_KIT
  • values
    Collection of key-type-name entries for this subject
Example:
{
    "anchorKey":"NTF_ORS_DEPOT_LOW_KIT",
    "values":[
        {
            "key":"101",
            "keyType":"VISIT",
            "name":"Visit 1"
        }
    ]
}
Nested Schema : anchors
Type: array
List of body anchors with index and their substitution values
Show Source
Nested Schema : NotificationAnchorDto2
Type: object
Anchor replacement entry for localized message body with indexed anchors.
Show Source
  • 0-based index of the anchor occurrence within the message body.
    Example: 0
  • Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.
    Example: NTF_ORS_BODY_STUDY_NAME
  • values
    List of substitution values for this anchor
Nested Schema : values
Type: array
List of substitution values for this anchor
Show Source
Nested Schema : ValueDto
Type: object
Key, type, and display name entry for a subject
Show Source
Nested Schema : values
Type: array
Collection of key-type-name entries for this subject
Show Source
Nested Schema : NotificationLogTargetDto
Type: object
Target mapping linking a notification to an entity such as a site or depot
Show Source
Examples

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
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
  • Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.
    Example: success
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
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
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
Examples

Back to Top