/api/v1/item/fetch

GET

/api/v1/item/fetch

const url = 'https://dpg.example.com/api/v1/item/fetch?item_network=example&item_domain=example&limit=20&offset=0';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dpg.example.com/api/v1/item/fetch?item_network=example&item_domain=example&limit=20&offset=0' \
  --header 'x-api-key: <x-api-key>'

Authorizations

apiKeyAuth
sessionAuth

Parameters

Query Parameters

item_id

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

item_network

required

string

>= 1 characters

item_domain

required

string

>= 1 characters

item_type

string

>= 1 characters

item_instance_url

string format: uri

nullable

item_schema_url

string format: uri

nullable

item_state

object

key

additional properties

item_latitude

number

item_longitude

number

radius_meters

number

limit

integer

default: 20 >= 1 <= 1000

offset

integer

0 <= 9007199254740991

cache_ttl_seconds

integer

<= 9007199254740991

Responses

200

Default Response

application/json

object

meta

required

object

total

required

number

limit

required

number

offset

required

number

items

required

Array<object>

object

item_network

required

string

item_domain

required

string

item_type

required

string

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

item_instance_url

required

string

item_schema_url

required

string

item_state

required

Any of:

string

item_locations

required

Array<object>

object

lat

required

number

>= -90 <= 90

lng

required

number

>= -180 <= 180

label

string

created_by

required

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

lifecycle_status

string

Allowed values: draft live paused

Example

{
  "items": [
    {
      "item_state": null,
      "lifecycle_status": "draft"
    }
  ]
}