Skip to main content
GET
/
plan-items
/
v1
/
ad
List plan items
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/plan-items/v1/ad \
  --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",
      "anomaly": {
        "id": 1,
        "title": "Anomaly title",
        "risk": 1,
        "status": 0,
        "code": "A-12345"
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "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 information about anomalies linked to the planItem

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

Available options:
anomaly,
actions-info
​
whereName
string

Filter by name

Example:

"string"

​
whereType
integer[]

Filter by type

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

Filter by entityType

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

Filter by planId

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

1

​
createdAt
string

Filter by createdAt

Example:

"2021-01-01T00:00:00.000Z"

​
whereAnomalyRisk
integer[]

Filter by anomalyRisk

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

Filter by anomalyStatus

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

Filter anomalies with screenshot

Example:

true

​
whereAnomalyHasPicture
boolean

Filter anomalies with picture

Example:

true

​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

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

1

​
pageSize
integer
default:50

Page size.

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

50

​
findId
integer

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

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

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

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

10

Response

200 - application/json

List of plan items

​
data
object[]
required
​
totalCount
integer

Total count of items.

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

100

​
pagination
object

Pagination information.