Skip to main content

Records

API docs by Redocly

Assetmanager Records (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 Records

GetByAddr

GetByAddr retrieves metadata given any address(es).

Authorizations:
bearerAuth
path Parameters
addrs
required
Array of strings (addrs)

ids are the metadata addresses of the things to look up.

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ],
  • "sessions": [
    ],
  • "records": [
    ],
  • "scopeSpecs": [
    ],
  • "contractSpecs": [
    ],
  • "recordSpecs": [
    ],
  • "notFound": [
    ]
}

Records

Records searches for records.

The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.

  • If only a record_addr is provided, that single record will be returned.
  • If only a scope_id is provided, all records in that scope will be returned.
  • If only a session_id (or scope_id/session_id), all records in that session will be returned.
  • If a name is provided with a scope_id and/or session_id, that single record will be returned.

A bad request is returned if:

  • The session_id is a uuid and no scope_id is provided.
  • There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
  • A name is provided, but not a scope_id and/or a session_id.
  • A name and record_addr are provided and the name doesn't match the record_addr.

By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.

Authorizations:
bearerAuth
path Parameters
record_addr
required
string (record_addr)

record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

query Parameters
scopeId
string (scope_id)

scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel.

sessionId
string (session_id)

session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided.

name
string (name)

name is the name of the record to look for

includeScope
boolean (include_scope)

include_scope is a flag for whether to include the the scope containing these records in the response.

includeSessions
boolean (include_sessions)

include_sessions is a flag for whether to include the sessions containing these records in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

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

RecordsAll

RecordsAll retrieves all records.

Authorizations:
bearerAuth
query Parameters
excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

pagination.key
string <byte> (key)

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offset
integer or string <int64> (offset)

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limit
integer or string <int64> (limit)

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.countTotal
boolean (count_total)

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverse
boolean (reverse)

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses

Response samples

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

Records

Records searches for records.

The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.

  • If only a record_addr is provided, that single record will be returned.
  • If only a scope_id is provided, all records in that scope will be returned.
  • If only a session_id (or scope_id/session_id), all records in that session will be returned.
  • If a name is provided with a scope_id and/or session_id, that single record will be returned.

A bad request is returned if:

  • The session_id is a uuid and no scope_id is provided.
  • There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
  • A name is provided, but not a scope_id and/or a session_id.
  • A name and record_addr are provided and the name doesn't match the record_addr.

By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.

Authorizations:
bearerAuth
path Parameters
scope_id
required
string (scope_id)

scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel.

name
required
string (name)

name is the name of the record to look for

query Parameters
recordAddr
string (record_addr)

record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

sessionId
string (session_id)

session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided.

includeScope
boolean (include_scope)

include_scope is a flag for whether to include the the scope containing these records in the response.

includeSessions
boolean (include_sessions)

include_sessions is a flag for whether to include the sessions containing these records in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

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

Records

Records searches for records.

The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.

  • If only a record_addr is provided, that single record will be returned.
  • If only a scope_id is provided, all records in that scope will be returned.
  • If only a session_id (or scope_id/session_id), all records in that session will be returned.
  • If a name is provided with a scope_id and/or session_id, that single record will be returned.

A bad request is returned if:

  • The session_id is a uuid and no scope_id is provided.
  • There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
  • A name is provided, but not a scope_id and/or a session_id.
  • A name and record_addr are provided and the name doesn't match the record_addr.

By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.

Authorizations:
bearerAuth
path Parameters
scope_id
required
string (scope_id)

scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel.

query Parameters
recordAddr
string (record_addr)

record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

sessionId
string (session_id)

session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided.

name
string (name)

name is the name of the record to look for

includeScope
boolean (include_scope)

include_scope is a flag for whether to include the the scope containing these records in the response.

includeSessions
boolean (include_sessions)

include_sessions is a flag for whether to include the sessions containing these records in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

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

Records

Records searches for records.

The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.

  • If only a record_addr is provided, that single record will be returned.
  • If only a scope_id is provided, all records in that scope will be returned.
  • If only a session_id (or scope_id/session_id), all records in that session will be returned.
  • If a name is provided with a scope_id and/or session_id, that single record will be returned.

A bad request is returned if:

  • The session_id is a uuid and no scope_id is provided.
  • There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
  • A name is provided, but not a scope_id and/or a session_id.
  • A name and record_addr are provided and the name doesn't match the record_addr.

By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.

Authorizations:
bearerAuth
path Parameters
session_id
required
string (session_id)

session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided.

query Parameters
recordAddr
string (record_addr)

record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.

scopeId
string (scope_id)

scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel.

name
string (name)

name is the name of the record to look for

includeScope
boolean (include_scope)

include_scope is a flag for whether to include the the scope containing these records in the response.

includeSessions
boolean (include_sessions)

include_sessions is a flag for whether to include the sessions containing these records in the response.

excludeIdInfo
boolean (exclude_id_info)

exclude_id_info is a flag for whether to exclude the id info from the response.

includeRequest
boolean (include_request)

include_request is a flag for whether to include this request in your result.

Responses

Response samples

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