Skip to main content
GET
/
anomalies
/
v3
/
rs
/
{anomalyId}
Get anomaly by Id
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/anomalies/v3/rs/{anomalyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": {
    "id": 1,
    "type": 1,
    "status": 1,
    "title": "Anomaly title",
    "description": "Anomaly description",
    "risk": 1,
    "anomalyNumber": "A-12345",
    "pageNumber": 12,
    "alreadyReported": false,
    "technicalInstallationId": 1,
    "siteId": 1,
    "equipmentId": 1,
    "dueAt": "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,
    "observedAt": "2024-12-01T12:34:56.000Z",
    "technicalInstallation": {
      "id": 1,
      "name": "establishment_informations.installation_ascenseurs",
      "image": {
        "id": 1,
        "presignedUrl": "https://example.com/presigned-url"
      },
      "tradKey": "establishment_informations.installation_ascenseurs",
      "isDefault": false
    },
    "establishmentCell": {
      "establishment": {
        "id": 1,
        "name": "Main site",
        "count": 123
      },
      "cell": {
        "id": 1,
        "name": "Main site",
        "count": 123
      }
    },
    "position": {
      "id": 1,
      "xPercent": 1,
      "yPercent": 1
    },
    "plan": {
      "id": 1,
      "name": "Main Plan"
    },
    "building": {
      "id": 1,
      "name": "Main Building"
    },
    "isPositioned": true,
    "containedIn": [
      {
        "id": 1,
        "name": "Plan Item 1"
      }
    ],
    "reportedBy": {
      "id": 1,
      "name": "John Doe",
      "presignedUrl": "https://example.com/presigned-url"
    },
    "commission": {
      "id": 1,
      "visitType": 1,
      "signedBy": "Signatory",
      "commissionDate": "2024-12-01T12:34:56.000Z",
      "decision": 1,
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    },
    "intervention": {
      "id": 1,
      "providerName": "Provider name",
      "actualStart": "2024-12-01T12:34:56.000Z",
      "assignedTo": {
        "type": 1,
        "id": 1,
        "name": "John Doe",
        "email": "[email protected]"
      },
      "rule": {
        "id": 1,
        "name": "Annual Safety Check"
      },
      "rulesCount": 123
    },
    "report": {
      "status": 1,
      "id": 1,
      "name": "Document Name",
      "presignedUrl": "https://example.com/presigned-url",
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    },
    "resolution": {
      "isDone": true,
      "interventionId": 1,
      "resolvedAt": "2024-12-01T12:34:56.000Z",
      "comment": "Comment on the interventionAnomaly",
      "resolvedByProfile": {
        "id": 1,
        "name": "John Doe",
        "group": 2
      },
      "resolvedByCompany": {
        "companyId": 1,
        "companyName": "Company Name",
        "providerName": "Provider name"
      }
    },
    "equipment": {
      "id": 1,
      "name": "Equipment Name",
      "archivedAt": "2024-12-01T12:34:56.000Z"
    },
    "updatableFields": {
      "title": true,
      "description": true,
      "risk": true,
      "technicalInstallationId": true,
      "siteId": true,
      "equipmentId": true,
      "dueAt": true,
      "resolvedById": true,
      "resolvedComment": true,
      "anomalyNumber": true,
      "pageNumber": true,
      "index": true,
      "planId": true,
      "areaId": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true,
      "canBeRestored": true,
      "canBeResolved": true,
      "canBeUnresolved": true,
      "canBePositioned": true
    }
  }
}

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"

Path Parameters

​
anomalyId
integer
required

Unique identifier of the anomaly.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

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

  • "establishment-cell": Get information about the establishment cell

  • "position": Get information about the position related to the anomaly

  • "origin": Provides anomaly origin information based on the type

  • "report": Provides anomaly report information

  • "resolution": Get information about the last intervention

  • "equipment": Get information about the equipment linked to the intervention

  • "updatable-fields": Get information about the field that can be updated

  • "actions-info": Give information about the origin of the anomaly (commission or intervention)

Available options:
technical-installation,
establishment-cell,
position,
origin,
report,
resolution,
equipment,
updatable-fields,
actions-info

Response

200 - application/json

Get the anomaly information

​
data
object
required