Skip to main content
POST
/
reports
/
v2
/
rs
/
rvre
Create RVRE report
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/reports/v2/rs/rvre \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "document": {
    "name": "example.jpg",
    "mimeType": "image/jpeg",
    "size": 1024
  },
  "interventionId": 1,
  "siteIds": [
    1,
    2,
    3
  ],
  "ruleIds": [
    1,
    2,
    3
  ],
  "comment": "Comment on the report",
  "equipmentIds": [
    1,
    2
  ]
}
'
{
  "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"
  },
  "presignedUrl": "https://bucket.s3.amazonaws.com/1"
}

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 create report

​
document
object
required
​
interventionId
integer
required

Unique identifier of the intervention.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
siteIds
integer[]
required

Unique identifiers of the associated sites.

Minimum array length: 1
Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
ruleIds
integer[]
required

List of rule IDs to associate with the profile.

Minimum array length: 1

Unique identifier of the rule.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
comment
string

Comment on the report.

Maximum string length: 2500
Example:

"Comment on the report"

​
equipmentIds
number[]

Equipments identifiers.

Minimum array length: 1
Example:
[1, 2]

Response

201 - application/json

The report has been created

​
report
object
required
​
presignedUrl
string
required

The presigned URL to download the file from.

Example:

"https://bucket.s3.amazonaws.com/1"