Skip to main content
GET
/
anomalies
/
v3
/
ad
/
{anomalyId}
Get anomaly by Id
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/anomalies/v3/ad/{anomalyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "status": 0,
    "title": "Anomaly title",
    "description": "Anomaly description",
    "risk": 1,
    "comment": "Anomaly comment",
    "resolutionDelay": "P7D",
    "location": "1st Floor, Room 101",
    "projectId": 1,
    "reportedByUserId": 1,
    "resolvedByUserId": 1,
    "hasScreenshot": true,
    "hasPicture": true,
    "code": "A-12345",
    "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",
    "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"
      }
    ],
    "updatableFields": {
      "title": true,
      "description": true,
      "risk": true,
      "comment": true,
      "resolutionDelay": true,
      "location": true,
      "resolve": true
    },
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": 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.

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

1

Query Parameters

extend
enum<string>[]

Extend options:

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

  • "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:
position,
updatable-fields,
actions-info

Response

200 - application/json

Get the anomaly information

data
object
required