Skip to main content
GET
/
interventions-anomalies
/
v1
/
rs
List intervention anomalies
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/interventions-anomalies/v1/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "anomalyId": 1,
      "interventionId": 1,
      "comment": "Comment on the interventionAnomaly",
      "providerAction": 1,
      "clientDecision": 1,
      "clientDecisionComment": "Comment on the decision",
      "anomaly": {
        "id": 1,
        "type": 1,
        "status": 1,
        "title": "Anomaly title",
        "description": "Anomaly description",
        "risk": 1,
        "anomalyNumber": "A-12345",
        "pageNumber": 12,
        "dueAt": "2024-12-01T12:34:56.000Z",
        "observedAt": "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",
        "onSiteObs": true,
        "technicalInstallation": {
          "id": 1,
          "name": "establishment_informations.installation_ascenseurs",
          "image": {
            "id": 1,
            "presignedUrl": "https://example.com/presigned-url"
          },
          "tradKey": "establishment_informations.installation_ascenseurs",
          "isDefault": false
        }
      },
      "intervention": {
        "id": 1,
        "status": 2,
        "type": 1,
        "subType": 1,
        "codePin": 123456,
        "description": "Description of the intervention",
        "scheduledStart": "2024-12-01T12:34:56.000Z",
        "scheduledEnd": "2024-12-05T14:56:23.000Z",
        "actualStart": "2024-12-01T12:34:56.000Z",
        "actualEnd": "2024-12-01T12:34:56.000Z",
        "archivedAt": "2024-12-09T14:23:00.000Z",
        "updatedAt": "2024-12-09T14:23:00.000Z",
        "createdAt": "2024-01-15T08:45:00.000Z",
        "assignedTo": {
          "type": 1,
          "id": 1,
          "name": "John Doe",
          "email": "[email protected]"
        }
      },
      "actions": {
        "canBeAdjudicated": true,
        "canBeHandled": true
      },
      "attachments": [
        {
          "id": 1,
          "name": "document.pdf",
          "storageKey": "attachments/2024/document-123.pdf",
          "presignedUrl": "https://example.com/presigned-url"
        }
      ]
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "anomaly": Get the anomalies with specific fields

  • "anomaly-technical-installation": Get information about technical installations linked to the anomalies

  • "intervention": Get the interventions with specific fields

  • "intervention-assigned-to": Get information about the assigned to (company contact or profile)

  • "actions-info": Give information about actions that can be done on anomalies

  • "attachments": Get the attachments with specific fields

Available options:
anomaly,
anomaly-technical-installation,
intervention,
intervention-assigned-to,
actions-info,
attachments
​
whereAnomalyId
integer

Filter by Anomaly ID

Example:

1

​
whereAnomalyIds
integer[]

Filter by multiple Anomaly IDs

Example:
[1, 2, 3]
​
whereInterventionId
integer

Filter by Intervention ID

Example:

1

​
whereInterventionIds
integer[]

Filter by multiple Intervention IDs

Example:
[1, 2, 3]
​
whereComment
string

Filter by Comment (case insensitive, partial match)

Example:

"string"

​
whereProviderAction
integer[]

Filter by Provider Action (case insensitive, partial match)

Example:
[1, 2, 3]
​
whereClientDecision
integer[]

Filter by Client Decision (case insensitive, partial match)

Example:
[1, 2, 3]
​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Example:

1

​
pageSize
integer
default:50

Page size.

Example:

50

​
findId
integer

Get the page where the item with this id is located.

Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

List site rules

​
data
object[]
required
​
totalCount
integer

Total count of items.

Example:

100

​
pagination
object

Pagination information.