Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
event

/api/v1/event/store

POST
/api/v1/event/store
curl --request POST \
  --url https://dpg.example.com/api/v1/event/store \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "origin_instance_domain": "https://example.com", "action_type": "example", "action_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "action_status": "example", "update_count": 1, "source_item": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_instance_url": "https://example.com" }, "target_item": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_instance_url": "https://example.com" }, "source_item_owner": "example", "target_item_owner": "example", "source_item_locations": [ { "lat": 1, "lng": 1, "label": "example" } ], "target_item_locations": [ { "lat": 1, "lng": 1, "label": "example" } ], "event_payload": {}, "remarks": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
origin_instance_domain
required
string format: uri
action_type
required
string
>= 1 characters
action_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)$/
action_status
required
string
>= 1 characters
update_count
required
integer
<= 9007199254740991
source_item
required
object
item_network
required
string
>= 1 characters
item_domain
required
string
>= 1 characters
item_type
required
string
>= 1 characters
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 format: uri
target_item
required
object
item_network
required
string
>= 1 characters
item_domain
required
string
>= 1 characters
item_type
required
string
>= 1 characters
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 format: uri
source_item_owner
string
nullable >= 1 characters
target_item_owner
string
nullable >= 1 characters
source_item_locations
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
target_item_locations
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
event_payload
object
key
additional properties
remarks
string
>= 1 characters

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
event_id
required
string
nullable
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
Examplegenerated
{
  "event_id": "example",
  "action_id": "example",
  "action_type": "example",
  "action_status": "example",
  "update_count": 1
}