Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
action

/api/v1/action/perform

POST
/api/v1/action/perform
curl --request POST \
  --url https://dpg.example.com/api/v1/action/perform \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "action_type": "example", "source_item": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "target_item": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_instance_url": "https://example.com" }, "requirements_snapshot": { "additionalProperty": "example" }, "acting_as_user_id": "example", "consent": { "acknowledged": true, "version": 1, "brand": "example" }, "guardian_otp": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-acting-org-id
string

Organization this request acts on behalf of. Optional: a non-admin actor can perform an action without acting for an org.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
action_type
required
string
>= 1 characters
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)$/
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
requirements_snapshot
required
object
key
additional properties
acting_as_user_id
string
>= 1 characters
consent
object
acknowledged
required
boolean
version
required
integer
>= 1 <= 9007199254740991
brand
string
nullable >= 1 characters
guardian_otp
string
>= 6 characters <= 6 characters

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
results
required
Array
Any of:
object
index
required
integer
<= 9007199254740991
status
required
string
Allowed values: success
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
source_item_id
required
string
target_item_id
required
string
summary
required
object
total
required
integer
<= 9007199254740991
succeeded
required
integer
<= 9007199254740991
failed
required
integer
<= 9007199254740991
Example
{
  "results": [
    {
      "status": "success"
    }
  ]
}

422

Section titled “422”

Default Response

Media typeapplication/json
object
results
required
Array
Any of:
object
index
required
integer
<= 9007199254740991
status
required
string
Allowed values: success
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
source_item_id
required
string
target_item_id
required
string
summary
required
object
total
required
integer
<= 9007199254740991
succeeded
required
integer
<= 9007199254740991
failed
required
integer
<= 9007199254740991
Example
{
  "results": [
    {
      "status": "success"
    }
  ]
}