Submit request for sending notifications
post
/ec-reporting-svc/rest/v1.0/notification/{notificationType}
Submits a request for sending notification on the given input, using the QueryParams parameter.
Right: ReportingPost.
Right: ReportingPost.
Request
Path Parameters
-
notificationType(required): string
Notification Type (e.g., Created, On, Off).Example:
Created
Query Parameters
-
mode: string
Mode of the study. Accepts test, active, or training.Example:
test -
studyId(required): string(uuid)
Study identifier as a UUID.Example:
AABB1234DD884FA1A9DC1AFDECBA1A35
Supported Media Types
- application/json
Root Schema : schema
Type:
objectRequest payload wrapper for notification: a map from notification field key to NotificationPayload.
Show Source
Nested Schema : notificationPayloads
Type:
Show Source
array-
Array of:
object NotificationPayload
Represents a notification detail with key and value.
Nested Schema : NotificationPayload
Type:
objectRepresents a notification detail with key and value.
Show Source
-
fieldKey: string
Unique field identifier/key for the notification.Example:
subjectId -
fieldName: string
Display name for the notification field.Example:
Subject ID -
fieldValue: string
Value for the notification field.Example:
SUBJ001
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Notification successfully triggered.
Root Schema : schema
Type:
stringExamples
400 Response
Input validation failed; error in the payload.
Examples
401 Response
Unauthorized access. The user is not allowed to send this notification.
Root Schema : BaseResponse
Type:
objectBase response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
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
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
-
status: string
Response status for the request; typically 'success' or 'error'.Example:
success
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:
objectGeneric result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Examples