Skip to main content
PATCH
/
reports
/
v2
/
rs
/
pv
/
{reportId}
Update PV report
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/reports/v2/rs/pv/{reportId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "comment": "Comment on the report",
  "name": "Document Name"
}
'
{
  "report": {
    "id": 1,
    "ref": "RPT-2024-001",
    "type": 1,
    "status": 1,
    "comment": "Comment on the report",
    "confirmNonConfExtraction": true,
    "checkDate": "2024-12-01T12:34:56.000Z",
    "documentId": 1,
    "commissionId": 1,
    "interventionId": 1,
    "createdByUserId": 1,
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z",
    "counters": {
      "anomaly": 5
    },
    "archivedAt": "2024-12-10T10:00:00.000Z",
    "deletedAt": "2024-12-11T10:00:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to update report

​
comment
string

Comment on the report.

Maximum string length: 2500
Example:

"Comment on the report"

​
name
string

Name of the document.

Example:

"Document Name"

Response

200 - application/json

The report has been updated

​
report
object
required