Skip to main content
GET
/
plan-items
/
v1
/
ad
/
{planItemId}
Get a plan item
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/plan-items/v1/ad/{planItemId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": {
    "id": 1,
    "name": "Plan Item 1",
    "type": 1,
    "entityType": 1,
    "xPercent": 1,
    "yPercent": 1,
    "rectPoint": [
      [
        1,
        1
      ],
      [
        2,
        2
      ]
    ],
    "planId": 1,
    "color": "#FF0000",
    "width": 2,
    "opacity": 0.5,
    "updatedAt": "2024-12-01T12:34:56.000Z",
    "createdAt": "2024-12-01T12:34:56.000Z",
    "actions": {
      "canBeUpdated": true,
      "canBeDeleted": true
    },
    "updatableFields": {
      "name": true,
      "xPercent": true,
      "yPercent": true,
      "rectPoint": true,
      "planId": true,
      "areaId": true,
      "color": true,
      "width": true,
      "opacity": true,
      "points": true
    },
    "anomaly": {
      "id": 1,
      "title": "Anomaly title",
      "risk": 1,
      "code": "A-12345"
    }
  }
}

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

​
planItemId
number
required

The id of the plan item

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

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

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

  • "anomaly": Get information about anomalies linked to the planItem

Available options:
actions-info,
updatable-fields,
anomaly

Response

200 - application/json

Success

​
data
object
required