Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

devices

Search Devices

post/app/v1/devices/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'status' | 'type_id'
sort_direction'asc' | 'desc'

sort direction

Example request

{
  "page_size": 20,
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "facility.name": "WellSite1"
      }
    ],
    "custom_attributes.hint": "View schema for all supported fields",
    "custom_attributes.operator": "bob",
    "name": {
      "$like": "wind"
    }
  }
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "attributes": {
        "height": 10,
        "location": [
          43.65107,
          -79.347015
        ],
        "provider": "provider"
      },
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      },
      "facility": {
        "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
        "name": "Facility 1"
      },
      "measurement_types": [
        "volume"
      ]
    }
  ]
}