Skip to main content
PATCH
/
anomalies
/
v3
/
rs
/
{anomalyId}
/
non-conformity
Update a non conformity anomaly
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/anomalies/v3/rs/{anomalyId}/non-conformity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>' \
  --data '
{
  "title": "Anomaly title",
  "description": "Anomaly description",
  "risk": 1,
  "siteId": 1,
  "technicalInstallationId": 1,
  "equipmentId": 1,
  "dueAt": "2024-12-01T12:34:56.000Z",
  "resolvedById": 1,
  "resolvedComment": "Anomaly resolved",
  "alreadyReported": false,
  "anomalyNumber": "A-12345",
  "pageNumber": 12,
  "index": 1
}
'
{
  "data": {
    "id": 1,
    "type": 1,
    "status": 1,
    "title": "Anomaly title",
    "description": "Anomaly description",
    "risk": 1,
    "siteId": 1,
    "technicalInstallationId": 1,
    "equipmentId": 1,
    "reportedById": 1,
    "positionId": 1,
    "resolvedComment": "Anomaly resolved",
    "resolvedById": 1,
    "reporter": "John Doe",
    "alreadyReported": false,
    "sortOrder": 1,
    "anomalyNumber": "A-12345",
    "pageNumber": 12,
    "reportId": 1,
    "dueAt": "2024-12-01T12:34:56.000Z",
    "observedAt": "2024-12-01T12:34:56.000Z",
    "resolvedAt": "2024-12-01T12:34:56.000Z",
    "deletedAt": "2024-01-15T08:45:00.000Z",
    "archivedAt": "2024-01-15T08:45:00.000Z",
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "ref": "E42-RI12-3",
    "metadata": {
      "location": {
        "floor": "1st floor",
        "room": "1st room"
      },
      "reporter": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "resolvedComment": "Anomaly resolved"
    },
    "imgs": [
      "image1",
      "image2"
    ],
    "images": [
      {
        "file": "image1",
        "size": 1024
      },
      {
        "file": "image2",
        "size": 2048
      }
    ],
    "priority": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

​
anomalyId
integer
required

Unique identifier of the anomaly.

Example:

1

Body

application/json

Details required to update an anomaly

​
title
string

Anomaly title.

Maximum string length: 250
Example:

"Anomaly title"

​
description
string

Anomaly description.

Maximum string length: 2500
Example:

"Anomaly description"

​
risk
enum<number>

Anomaly risk.

Available options:
0,
1,
2,
3
Example:

1

​
siteId
integer

Identifier of the associated site.

Example:

1

​
technicalInstallationId
integer

Identifier of the associated technical installation.

Example:

1

​
equipmentId
integer | null

Identifier of the associated equipment.

Example:

1

​
dueAt

Anomaly dueAt.

Example:

"2024-12-01T12:34:56.000Z"

​
resolvedById
integer

Identifier of the resolver.

Example:

1

​
resolvedComment
string

Comment of the resolver.

Maximum string length: 500
Example:

"Anomaly resolved"

​
alreadyReported
boolean

Indicates if the anomaly has already been reported (only for observation)

Example:

false

​
anomalyNumber
string | null

Anomaly number (only for compliance anomaly)

Maximum string length: 100
Example:

"A-12345"

​
pageNumber
integer | null

Page number (only for compliance anomaly)

Example:

12

​
index
integer

Index of the anomaly in the list of anomalies in the report.

Example:

1

Response

200 - application/json

The anomaly has been updated

​
data
object
required