Common

Getting Started

User

Logout

Refresh Access Token

Get User Profile

Update Profile

Upload Avatar

Delete User

Reset Password

Reset Password by ID

User Token

List User Tokens

Add User Token

Update Default User Token

Delete User Token

Verify User Token

Reset Verification Code

User vAtom

Get vAtom

Get vAtoms by Ids

Get vAtom Inventory

Search vAtoms

Geo Discover Groups

Geo Discover vAtoms

Update vAtoms

Perform Action

Trash vAtom

User Activity

Get My Threads

Get My Thread Messages

Template

List Templates

Get Template

Create Template

Update Template

Delete Template

Template Variation

List Variations

Get Variation

Create Variation

Update Variation

Delete Variation

vAtom

Emit vAtom

Template Action

List Actions

Get Action

Update Action

Delete Action

Template Face

List Faces

Update Face

Delete Face

Asset

Upload Assets

Get Assets

Delete Assets

Get vAtom

GET

https://api.blockv.io/v1/vatoms/:id

Overview

Request a single vAtom. Public vAtoms can be requested without being logged in.

Get vAtom Request

HTTP Headers

Content-Type: application/x-www-form-urlencoded
App-Id: {app_id}

Sample Request

Body intentionally left blank.

Get vAtom Response

Return & Error Codes

Error	Type	Description
`200`	http	Everything is OK
`403`	http	Not Authorized
`404`	http	Not Found

payload Object

Name	Type	Description
`id`	string	The vAtoms unique identifier.
`vAtom::vAtomType`	object	In the `vAtom::vAtomType` section the built in properties are defined
`private`	object	In the private section you can define custom properties, states and resources. Built-in action will not modify private
`unpublished`	boolean	Flag to indicate if the vAtom is unpublished.
`version`	string	The version of the vAtom.
`when_created`	date	Timestamp when the vAtom was created.
`when_modified`	date	Timestamp when the vAtom was last modified.

Sample Response

{
    "payload": {
        "id": "4e6e53e8-06d3-4b6a-8a7a-bb26626e1a2a",
        "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": "*"
            }
        },
        "private": {},
        "unpublished": false,
        "version": "v1::vAtomType",
        "when_created": "2018-01-01T00:00:00Z",
        "when_modified": "2018-01-01T00:00:00Z"
    }
}

Info