This request returns the current user inventory of vAtoms. The response includes the vAtoms as well as the configured Faces and Actions.
Content-Type: application/json
App-Id: {app_id}| Name | Type | Description |
|---|---|---|
parent_id | string | Allows you to specify a vAtom-ID of a folder vAtom to return the folder content. A dot
.
can be used to return non-folder vAtoms. |
limit | int | Defines the number of vAtoms per response page (up to 100). If omitted, it returns the max. number. |
page | int | The number of the page for which the vAtoms are returned. If omitted, the first page is returned. |
| Error | Type | Description |
|---|---|---|
200 | http | Everything is OK |
403 | http | Not Authorized |
| Name | Type | Description |
|---|---|---|
[
vatoms
] | array | An array of vAtom objects. |
faces | array | An array of Faces that are registered for the requested vAtoms. |
actions | array | An array of Actions that are registered for the requested vAtoms. |
{
"payload": {
"vatoms": [
{
"id": "4e6e53e8-06d3-4b6a-8a7a-bb26626e1a2a",
"in_sync": false,
"is_syncing": false,
"private": {},
"unpublished": false,
"vAtom::vAtomType": {
"acquirable": true,
"author": "001d0933-88e6-4e17-b147-0f672dc016d1",
"category": "",
"cloned_from": "",
"cloning_score": 0,
"commerce": {
"pricing": {
"pricingType": "Fixed",
"value": {
"currency": "",
"price": "0",
"valid_from": "*",
"valid_through": "*",
"vat_included": false
}
}
},
"description": "",
"disabled": false,
"dropped": false,
"geo_pos": {
"$reql_type$": "GEOMETRY",
"coordinates": [
0,
0
],
"type": "Point"
},
"in_contract": false,
"in_contract_with": "",
"notify_msg": "",
"num_direct_clones": 0,
"owner": "001d0933-88e6-4e17-b147-0f672dc016d1",
"parent_id": ".",
"publisher_fqdn": "publisher_fqdn",
"redeemable": true,
"resources": [
{
"name": "ActivatedImage",
"resourceType": "ResourceType::Image::PNG",
"value": {
"resourceValueType": "ResourceValueType::URI",
"value": "https://cdn.blockv.io/mypicture.png"
}
}
],
"root_type": "vAtom::vAtomType",
"states": [
{
"name": "Activated",
"on_state_change": {
"reactor": ""
},
"value": {
"type": "boolean",
"value": "true"
}
}
],
"tags": [],
"template": "publisher_fqdn::Template_Name::v1",
"template_variation": "publisher_fqdn::Template_Name::Variation",
"title": "My vAtom",
"tradeable": false,
"transferable": true,
"transferred_by": "",
"visibility": {
"type": "owner",
"value": "*"
}
},
"version": "v1::vAtomType",
"when_created": "2018-01-01T00:00:00Z",
"when_modified": "2018-01-01T00:00:00Z"
}
],
"actions": [
{
"name": "publisher_fqdn::Template_Name::v1::Action::Transfer",
"meta": {
"created_by": "001d0933-88e6-4e17-b147-0f672dc016d1",
"when_created": "2018-01-01T00:00:00Z",
"modified_by": "",
"when_modified": "",
"data_type": "v1::ActionType",
"in_sync": true,
"when_synced": "",
"is_syncing": false
},
"properties": {
"name": "publisher_fqdn::Template_Name::v1::Action::Transfer",
"reactor": "blockv://v1/Transfer",
"wait": true,
"rollback": false,
"abort_on_pre_error": true,
"abort_on_post_error": false,
"abort_on_main_error": true,
"timeout": 10000,
"guest_user": true,
"state_impact": [],
"policy": {
"pre": [],
"rule": "",
"post": []
},
"params": {
"input": [],
"output": []
},
"config": {
"auto_create_landing_page": "http://viewer.blockv.io/#",
"auto_create_mode": "claim",
"auto_create_non_existing_recipient": true
},
"limit_per_user": 0,
"action_notification": {
"on": true,
"msg": "You received a vAtom",
"custom": {}
}
}
}
],
"faces": [
{
"id": "00ad0f31-53c1-4b11-88fd-3fcb3f7e8f82",
"template": "publisher_fqdn::Template_Name::v1",
"meta": {
"created_by": "001d0933-88e6-4e17-b147-0f672dc016d1",
"when_created": "2018-01-01T00:00:00Z",
"modified_by": "",
"when_modified": "",
"data_type": "v1::FaceType",
"in_sync": false,
"when_synced": "",
"is_syncing": false
},
"properties": {
"display_url": "native://image",
"package_url": "native://image",
"constraints": {
"bluetooth_le": false,
"contact_list": false,
"gps": false,
"three_d": false,
"view_mode": "icon",
"platform": "generic",
"quality": "high"
},
"resources": [
"ActivatedImage"
]
}
}
]
}
}