Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
network

/api/v1/network/item/fetch_local

POST
/api/v1/network/item/fetch_local
curl --request POST \
  --url https://dpg.example.com/api/v1/network/item/fetch_local \
  --header 'Content-Type: application/json' \
  --header 'x-instance-token: <x-instance-token>' \
  --data '{ "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_network": "example", "item_domain": "example", "item_type": "example", "item_instance_url": "https://example.com", "item_schema_url": "https://example.com", "item_state": { "additionalProperty": "example" }, "item_latitude": 1, "item_longitude": 1, "radius_meters": 1, "limit": 1, "offset": 1, "cache_ttl_seconds": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
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
required
integer
>= 1 <= 1000
offset
required
integer
<= 9007199254740991
cache_ttl_seconds
integer
<= 9007199254740991
Examplegenerated
{
  "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "item_network": "example",
  "item_domain": "example",
  "item_type": "example",
  "item_instance_url": "https://example.com",
  "item_schema_url": "https://example.com",
  "item_state": {
    "additionalProperty": "example"
  },
  "item_latitude": 1,
  "item_longitude": 1,
  "radius_meters": 1,
  "limit": 1,
  "offset": 1,
  "cache_ttl_seconds": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/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:
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"
    }
  ]
}