REST API for Clinical One Platform

Create a log entry and send it or schedule it

post

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

Creates a log entry and immediately sends it or schedules it to be sent with the Scheduler service. This version supports multiple language. This version of the API take input a message with Subject and body and replaces the keys in it based on the user selected language. This API includes added support for attachment and list of email addresses. This version supports site/depot level access.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts active, test, or training.
studyId(required): string

ID of the study.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

approvalFlag(required): string

Minimum Length: 0

Maximum Length: 1
attachment: string (byte)
attachmentProviderVersion: string
attachmentUrl: string
attachmentUrlProvider: string
category(required): string
comment: string

Minimum Length: 0

Maximum Length: 2048
createdBy(required): string
createdDate: string (date-time)
emailAddressList: string

Minimum Length: 0

Maximum Length: 4000
emailOnlyFlag: string

Minimum Length: 0

Maximum Length: 1
entityId: string (uuid)
entityType(required): string
id: string (uuid)
immediateFlag(required): string

Minimum Length: 0

Maximum Length: 1
messageDescription: string

Minimum Length: 0

Maximum Length: 32767
messageLanguageSupported: object MessageLanguageSupportedDto
messageSubject: string

Minimum Length: 0

Maximum Length: 1024
notificationDatetime: string (date-time)
objectVersionNumber: number
operationType: string
priority(required): string
privilege: string
reason: string

Minimum Length: 0

Maximum Length: 255
serviceName(required): string
softwareVersionNumber: number
targetList: array targetList
userId: string (uuid)
userList: string

Minimum Length: 0

Maximum Length: 4000
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "required":[
        "approvalFlag",
        "category",
        "createdBy",
        "entityType",
        "immediateFlag",
        "priority",
        "serviceName"
    ],
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string"
        },
        "messageSubject":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        },
        "messageDescription":{
            "maxLength":32767,
            "minLength":0,
            "type":"string"
        },
        "priority":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "privilege":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "approvalFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "userList":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "immediateFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "emailAddressList":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "attachment":{
            "type":"string",
            "format":"byte"
        },
        "emailOnlyFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "attachmentUrl":{
            "type":"string"
        },
        "attachmentUrlProvider":{
            "type":"string"
        },
        "attachmentProviderVersion":{
            "type":"string"
        },
        "targetList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationLogTargetDto"
            }
        },
        "messageLanguageSupported":{
            "$ref":"#/components/schemas/MessageLanguageSupportedDto"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "notificationDatetime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : MessageLanguageSupportedDto

Type: object

Show Source

body(required): object BodyDto
subject(required): object SubjectDto

{
    "required":[
        "body",
        "subject"
    ],
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto"
        },
        "body":{
            "$ref":"#/components/schemas/BodyDto"
        }
    }
}

Nested Schema : targetList

Type: array

Show Source

Array of: object NotificationLogTargetDto

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

Nested Schema : BodyDto

Type: object

Show Source

anchors(required): array anchors
htmlContent: string

{
    "required":[
        "anchors"
    ],
    "type":"object",
    "properties":{
        "htmlContent":{
            "type":"string"
        },
        "anchors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationAnchorDto"
            }
        }
    }
}

Nested Schema : SubjectDto

Type: object

Show Source

anchorKey: string
values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : anchors

Type: array

Show Source

Array of: object NotificationAnchorDto

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

Nested Schema : NotificationAnchorDto

Type: object

Show Source

anchorKey: string
values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

key: string
keyType(required): string
name: string

{
    "required":[
        "keyType"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object ValueDto

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

Nested Schema : NotificationLogTargetDto

Type: object

Show Source

targetId(required): string (uuid)
targetType(required): string

{
    "required":[
        "targetId",
        "targetType"
    ],
    "type":"object",
    "properties":{
        "targetType":{
            "type":"string"
        },
        "targetId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success.

Root Schema : schema

Type: object

Show Source

approvalFlag(required): string

Minimum Length: 0

Maximum Length: 1
attachment: string (byte)
attachmentProviderVersion: string
attachmentUrl: string
attachmentUrlProvider: string
category(required): string
comment: string

Minimum Length: 0

Maximum Length: 2048
createdBy(required): string
createdDate: string (date-time)
emailAddressList: string

Minimum Length: 0

Maximum Length: 4000
emailOnlyFlag: string

Minimum Length: 0

Maximum Length: 1
entityId: string (uuid)
entityType(required): string
id: string (uuid)
immediateFlag(required): string

Minimum Length: 0

Maximum Length: 1
messageDescription: string

Minimum Length: 0

Maximum Length: 32767
messageLanguageSupported: object MessageLanguageSupportedDto
messageSubject: string

Minimum Length: 0

Maximum Length: 1024
notificationDatetime: string (date-time)
objectVersionNumber: number
operationType: string
priority(required): string
privilege: string
reason: string

Minimum Length: 0

Maximum Length: 255
serviceName(required): string
softwareVersionNumber: number
targetList: array targetList
userId: string (uuid)
userList: string

Minimum Length: 0

Maximum Length: 4000
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "required":[
        "approvalFlag",
        "category",
        "createdBy",
        "entityType",
        "immediateFlag",
        "priority",
        "serviceName"
    ],
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string"
        },
        "messageSubject":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        },
        "messageDescription":{
            "maxLength":32767,
            "minLength":0,
            "type":"string"
        },
        "priority":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "privilege":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "approvalFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "userList":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "immediateFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "emailAddressList":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "attachment":{
            "type":"string",
            "format":"byte"
        },
        "emailOnlyFlag":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "attachmentUrl":{
            "type":"string"
        },
        "attachmentUrlProvider":{
            "type":"string"
        },
        "attachmentProviderVersion":{
            "type":"string"
        },
        "targetList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationLogTargetDto"
            }
        },
        "messageLanguageSupported":{
            "$ref":"#/components/schemas/MessageLanguageSupportedDto"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "notificationDatetime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : MessageLanguageSupportedDto

Type: object

Show Source

body(required): object BodyDto
subject(required): object SubjectDto

{
    "required":[
        "body",
        "subject"
    ],
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/SubjectDto"
        },
        "body":{
            "$ref":"#/components/schemas/BodyDto"
        }
    }
}

Nested Schema : targetList

Type: array

Show Source

Array of: object NotificationLogTargetDto

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

Nested Schema : BodyDto

Type: object

Show Source

anchors(required): array anchors
htmlContent: string

{
    "required":[
        "anchors"
    ],
    "type":"object",
    "properties":{
        "htmlContent":{
            "type":"string"
        },
        "anchors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NotificationAnchorDto"
            }
        }
    }
}

Nested Schema : SubjectDto

Type: object

Show Source

anchorKey: string
values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : anchors

Type: array

Show Source

Array of: object NotificationAnchorDto

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

Nested Schema : NotificationAnchorDto

Type: object

Show Source

anchorKey: string
values: array values

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValueDto"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object ValueDto

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

Nested Schema : ValueDto

Type: object

Show Source

key: string
keyType(required): string
name: string

{
    "required":[
        "keyType"
    ],
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "keyType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : values

Type: array

Show Source

Array of: object ValueDto

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

Nested Schema : NotificationLogTargetDto

Type: object

Show Source

targetId(required): string (uuid)
targetType(required): string

{
    "required":[
        "targetId",
        "targetType"
    ],
    "type":"object",
    "properties":{
        "targetType":{
            "type":"string"
        },
        "targetId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

400 Response

Bad request.

Root Schema : NotificationResponse

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "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: string

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
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":"string",
            "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

500 Response

Internal server error.

Root Schema : NotificationResponse

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "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: string

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
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":"string",
            "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