/api/v1/item/{itemId} (PATCH)

PATCH

/api/v1/item/{itemId}

curl --request PATCH \
  --url https://dpg.example.com/api/v1/item/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "item_instance_url": "example", "item_schema_url": "example", "item_state": { "additionalProperty": "example" }, "item_locations": [ { "lat": 1, "lng": 1, "label": "example" } ] }'

• Your deployment's public host (set per network instance)
• Local development

Authorizations

• apiKeyAuth
• sessionAuth

Parameters

Path Parameters

itemId

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)$/

Request Body^required

Media typeapplication/json

object

item_instance_url

string

item_schema_url

string

item_state

Any of:

unknown

Any of:

string

string

number

number

boolean

boolean

string

string

nullable

object

object

key

additional properties

Array

Array

item_locations

Array<object>

object

lat

required

number

>= -90 <= 90

lng

required

number

>= -180 <= 180

label

string

Responses

200

Default Response

Media typeapplication/json

object

item

required

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:

unknown

Any of:

string

string

number

number

boolean

boolean

string

string

nullable

object

object

key

additional properties

Array

Array

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

{
  "item": {
    "item_state": null,
    "lifecycle_status": "draft"
  }
}