|
Http Verb |
POST |
|---|---|
|
Url |
assets/notifications/r1/notifications |
|
Permissions required |
Notification: Edit (fsm.notification.edit) |
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2026 W3 (FSM 24.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
multilanguage |
Business Logic
This API creates a new notification header.
The insertion task validates the input request checking all the mandatory fields, then
-
Checks whether the notification type permits creating a notification
-
validates the operation center/work center relation
-
check that the initial status is OPEN or IN_PROGRESS
-
generates the unique code for the notification
-
sets the generation date if not defined in input with the current instant
-
gets the catalog profile from the specified asset
-
saves the notification header with the associated history record
Date validation:
-
Breakdown start date must not be in the future
-
Breakdown end date must not be in the future
-
Closure date must not be in the future
-
Breakdown start date must precede breakdown end date
-
Breakdown start date must precede expected start date
-
Breakdown start date must precede expected end date
-
Generation date must precede closure date
Validation by status:
-
For IN_PROGRESS, VALIDATED, CLOSED: a valid position is required
-
For VALIDATED, CLOSED:
-
Closure date is mandatory
-
At least one notification fault is required
-
If downtime, breakdown start and end dates are mandatory
-
Header Parameters
Default.
Request Body Parameters
|
Field |
Validations |
Note |
|---|---|---|
|
externalCode |
|
|
|
description |
NotNull |
|
|
workCenterId |
NotNull |
|
|
operationCenterId |
NotNull |
|
|
priorityId |
NotNull |
|
|
typeId |
NotNull |
|
|
userId |
NotNull |
|
|
workOrderId |
|
|
|
assetId |
NotNull |
|
|
downtime |
|
default = false |
|
breakdownStartDate |
|
|
|
breakdownEndDate |
|
|
|
generationDate |
|
|
|
expectedStartDate |
|
|
|
expectedEndDate |
|
|
|
generationUserId |
|
|
|
workorderGeneratorId |
|
|
|
catalogProfileId |
|
|
|
externalSystemId |
|
|
|
parentNotificationId |
|
|
|
statusId |
NotNull |
|
|
externalSystemStatusId |
|
|
|
failureMode |
|
|
|
failureEffect |
|
|
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
Response error codes