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

List Templates

GET

https://api.blockv.io/v1/templates

Overview

Returns a list of templates. Admin users are able to see templates with the FQDN of their publisher.

Get Templates Request

URL parameters

The following URL parameters are available (they are not documented url-encoded form, in practice those parameters have to be url-encoded).

Sparse fields

Per default only the template name is returned. The returned content can be changed by providing a fields parameter. Nested fields are referenced by (), for example: fields=name,properties(publisher_fqdn) returns the top level fields name and properties, but for the properties object, only the publisher_fqdn is returned.

Sample Response

{
    "payload": [
        {
            "name": "publisher_fqdn::v1::vAtom::HelloWorld",
            "properties": {
                "publisher_fqdn": "publisher_fqdn"
            }
        },
        {
            "name": "publisher_fqdn::v1::vAtom::SampleTemplate",
            "properties": {
                "publisher_fqdn": "publisher_fqdn"
            }
        }
    ]
}

Available top level fields: name, meta and properties.

Paging

The response is paged, by default 10 templates are returned per page. The number of templates per page can be changed by providing a page[size] query parameter with a value between 1 and 50.

The current page can be selected via the page[number] parameter.

HTTP Headers

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

Sample Request

Body intentionally left blank.

Get Templates Response

Return & Error Codes

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

payload Object

Name	Type	Description
[ `template` ]	array	An array of template objects.
`links`	object	Paging links.

Link object

Name	Type	Description
`first`	string	Path to the first page.
`last`	string	Path to the last page.
`next`	string	Path to the next page.
`previous`	string	Path to the previous page.

Sample Response

{
    "payload": [
        {
            "name": "publisher_fqdn::v1::vAtom::HelloWorld",
            "properties": {
                "publisher_fqdn": "publisher_fqdn"
            }
        },
        {
            "name": "publisher_fqdn::v1::vAtom::SampleTemplate",
            "properties": {
                "publisher_fqdn": "publisher_fqdn"
            }
        }
    ],
    "links": {
        "first": "/v1/templates?fields=name%2Cproperties%28publisher_fqdn%29&page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "last": "/v1/templates?fields=name%2Cproperties%28publisher_fqdn%29&page%5Bnumber%5D=2&page%5Bsize%5D=2",
        "next": "/v1/templates?fields=name%2Cproperties%28publisher_fqdn%29&page%5Bnumber%5D=2&page%5Bsize%5D=2"
    }
}

Info