Skip to main content
API docs by Redocly

Blockvault Core Scope Operations (v1.0.0)

Download OpenAPI specification:Download

NUVA Labs: inbound@nuvalabs.com URL: https://nuvalabs.com/ License: Apache 2.0 Terms of Service

API Documentation for Blockvault Core Scope Operations

List scopes by specification

Authorizations:
BearerAuth
path Parameters
required
string or string (ScopeSpecificationId)

Scope specification identifier

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}

Create scope

Authorizations:
BearerAuth
path Parameters
required
string or string (ScopeSpecificationId)

Scope specification identifier

Request Body schema: application/json
required
data_access
Array of strings or null

Addresses in this list are authorized to receive off-chain data associated with this scope

null or (ScopeId (ScopeId (string) or ScopeId (string)))
Array of objects or null (Party)

These parties represent top level owners of the records within. These parties must sign any requests that modify the data within the scope. These addresses are in union with parties listed on the sessions.

usd_mills
integer or null <int64> >= 0

Value of scope in usd mills (1234 = $1.234) used for net asset value

value_owner_address
string or null

An address that controls the value associated with this scope. Standard blockchain accounts and marker accounts are supported for this value. This attribute may only be changed by the entity indicated once it is set.

Responses

Request samples

Content type
application/json
{
  • "owners": [
    ],
  • "data_access": [
    ],
  • "value_owner_address": "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22",
  • "usd_mills": 1000000
}

Response samples

Content type
application/json
{
  • "tx_hash": "3ea1b237f303455d1e7c04fc128168cf9a6b903759b8b06bc05315e9333da1ae",
  • "height": 18621414,
  • "id": "scope1qrx6trnp5eq5wxve49crgevg36nsp05nc3",
  • "uuid": "464a9b4d-956d-4946-9469-a6bfdc2923a1"
}

Get scope

Authorizations:
BearerAuth
path Parameters
required
string or string (ScopeId)

Scope identifier

query Parameters
hydrate
Array of strings or null

A list of record names to hydrate and return raw data for, defaults to hydrating all records when not provided. Hydration of records is a time consuming process so it is recommended to not hydrate more than is needed for improved response times.

block_height
integer or null <int64> >= 0

When provided, fetches a scope's state based on a previous block height. Defaults to the current (head) chain state.

Responses

Response samples

Content type
application/json
{
  • "scope": {
    },
  • "records": [
    ]
}

Patch scope

Authorizations:
BearerAuth
path Parameters
required
string or string (ScopeId)

Scope identifier

Request Body schema: application/json
required
        Patch scope level fields. All fields are optional. Any omitted field will retain its current value.

        * NOTE: There's currently a Provenance protocol bug where existing records cannot be updated by new scope owners without the previous record writers signature.
        This is slated to be fixed in 1.21.
data_access
Array of strings or null

Addresses in this list are authorized to receive off-chain data associated with this scope

Array of objects or null (Party)

These parties represent top level owners of the records within. These parties must sign any requests that modify the data within the scope. These addresses are in union with parties listed on the sessions.

specification_uuid
string or null <uuid>

If the owners of a scope are changed, it is often the case that the "scope_specification" must be changed as well.

usd_mills
integer or null <int64> >= 0

Value of scope in usd mills (1234 = $1.234) used for net asset value

value_owner_address
string or null

An address that controls the value associated with this scope. Standard blockchain accounts and marker accounts are supported for this value. This attribute may only be changed by the entity indicated once it is set.

Responses

Request samples

Content type
application/json
{
  • "specification_uuid": "6459fb07-d662-482d-860b-b69bf2255960",
  • "owners": [
    ],
  • "data_access": [
    ],
  • "value_owner_address": "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22",
  • "usd_mills": 1000000
}

Response samples

Content type
application/json
{
  • "tx_hash": "3ea1b237f303455d1e7c04fc128168cf9a6b903759b8b06bc05315e9333da1ae",
  • "height": 18621389
}