Skip to main content

Scope Lifecycle (Tx)

API docs by Redocly

Assetmanager Scope Lifecycle (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 Assetmanager Scope Lifecycle

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"
}

Update value owners

Authorizations:
BearerAuth
Request Body schema: application/json
required

Update value owners for one or more scopes at a time

scope_uuids
required
Array of strings <uuid> [ items <uuid > ]

Scope uuids in which the value owner will be changed for

value_owner_address
required
string

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
{
  • "scope_uuids": [
    ],
  • "value_owner_address": "tp1tledwnl9zsgcqynmjzmp8f3j25l0rj7hvx4g22"
}

Response samples

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

Add data access

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

Scope identifier

Request Body schema: application/json
required

Add addresses to data access list for scope

data_access
required
Array of strings

Account addresses to be added to the scope

Responses

Request samples

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

Response samples

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