Create a log entry and send it or schedule it
post
/ec-notifications-svc/rest/v5.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 anchor index which enables having multiple values for an anchor key.
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:
Show Source
object-
approvalFlag(required): string
Minimum Length:
0Maximum Length:1 -
attachment: string
(byte)
-
attachmentProviderVersion: string
-
attachmentUrl: string
-
attachmentUrlProvider: string
-
category(required): string
-
comment: string
Minimum Length:
0Maximum Length:2048 -
createdBy(required): string
-
createdDate: string
(date-time)
-
emailAddressList: string
Minimum Length:
0Maximum Length:4000 -
emailOnlyFlag: string
Minimum Length:
0Maximum Length:1 -
entityId: string
(uuid)
-
entityType(required): string
-
id: string
(uuid)
-
immediateFlag(required): string
Minimum Length:
0Maximum Length:1 -
messageDescription: string
Minimum Length:
0Maximum Length:32767 -
messageLanguageSupported: object
MessageLanguageSupportedDto2
-
messageSubject: string
Minimum Length:
0Maximum Length:1024 -
notificationDatetime: string
(date-time)
-
objectVersionNumber: number
-
operationType: string
-
priority(required): string
-
privilege: string
-
reason: string
Minimum Length:
0Maximum Length:255 -
serviceName(required): string
-
softwareVersionNumber: number
-
targetList: array
targetList
-
userId: string
(uuid)
-
userList: string
Minimum Length:
0Maximum Length:4000 -
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
Response
Supported Media Types
- application/json
200 Response
Success.
Root Schema : schema
Type:
Show Source
object-
approvalFlag(required): string
Minimum Length:
0Maximum Length:1 -
attachment: string
(byte)
-
attachmentProviderVersion: string
-
attachmentUrl: string
-
attachmentUrlProvider: string
-
category(required): string
-
comment: string
Minimum Length:
0Maximum Length:2048 -
createdBy(required): string
-
createdDate: string
(date-time)
-
emailAddressList: string
Minimum Length:
0Maximum Length:4000 -
emailOnlyFlag: string
Minimum Length:
0Maximum Length:1 -
entityId: string
(uuid)
-
entityType(required): string
-
id: string
(uuid)
-
immediateFlag(required): string
Minimum Length:
0Maximum Length:1 -
messageDescription: string
Minimum Length:
0Maximum Length:32767 -
messageLanguageSupported: object
MessageLanguageSupportedDto2
-
messageSubject: string
Minimum Length:
0Maximum Length:1024 -
notificationDatetime: string
(date-time)
-
objectVersionNumber: number
-
operationType: string
-
priority(required): string
-
privilege: string
-
reason: string
Minimum Length:
0Maximum Length:255 -
serviceName(required): string
-
softwareVersionNumber: number
-
targetList: array
targetList
-
userId: string
(uuid)
-
userList: string
Minimum Length:
0Maximum Length:4000 -
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
400 Response
Bad request.
Root Schema : NotificationResponse
Type:
Show Source
object-
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
Nested Schema : ErrorResponseData
Type:
objectStructure 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
Nested Schema : result
Type:
object500 Response
Internal server error.
Root Schema : NotificationResponse
Type:
Show Source
object-
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
Nested Schema : ErrorResponseData
Type:
objectStructure 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
Nested Schema : result
Type:
object