Assets API
Assets API Reference
For more information on Assets and Asset creation, visit our Core Concepts and Creating an Asset guide.
Asset API Examples
Create the bearer_token and store in a file in a secure local directory with 0600 permissions.
Asset Record Creation
Define the asset parameters and store in /path/to/jsonfile:
{
"attributes": {
"picture_from_yesterday": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
"arc_blob_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "somepic.jpeg",
"arc_display_name": "Picture from yesterday",
},
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"behaviours": [
"RecordEvidence",
"Attachments"
],
"proof_mechanism": "SIMPLE_HASH",
"public": false
}
Create the Asset:
curl -v -X POST \
-H "@$BEARER_TOKEN_FILE" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.rkvst.io/archivist/v2/assets
The response is:
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"picture_from_yesterday": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b",
"arc_blob_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "somepic.jpeg",
"arc_display_name": "Picture from yesterday",
},
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"behaviours": [
"RecordEvidence"
],
"confirmation_status": "PENDING",
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"owner": "0x601f5A7D3e6dcB55e87bf2F17bC8A27AaCD3511",
"proof_mechanism": "SIMPLE_HASH",
"public": false,
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"tracked": "TRACKED"
}
Creating a Public Asset
Warning: Assets can only be made public at Asset creation and cannot be made private afterwards.
In most cases it is appropriate to create a standard Asset. These Assets can only be shared externally using Access Policies as described in Sharing Assets with OBAC or the IAM Policies API Reference.
However, it is also possible to create a Public Asset which can be shared with a read-only public url; similar to the link sharing you may have seen in file sharing services like Google Drive or DropBox.
Public Assets can be used for Public Attestation, where you may wish to publicly assert data you have published.
For example, the vulnerability reports against an OpenSource software package, or perhaps the maintenance records for a public building.
Creating a Public Asset just requires flipping the public value in the above request to true. From then on, only the creating Tenancy may update the Asset and Events on a Public Asset through their private, signed-in interface.
All Public Assets are then given a read-only public URL that can be retrieved using Fetch a Public Asset’s URL, any Events added to that Public Asset will also get their own unique Public URL that can be retrieved with Fetch a Public Asset’s Event URL.
This link can be shared with anyone to give them read-only access to the Asset or Event without the need to sign in.
To interact with the unauthenticated Public Interface for a Public Asset see the Public Assets API Reference. To update the Assets and Events as the creating Tenant on a Public Asset’s authenticated Private Interface, you would still use the standard Assets and Events API as normal.
Asset Record Retrieval
Asset records in RKVST are tokenized at creation time and referred to in all API calls and smart contracts throughout the system by a unique identity of the form:
assets/12345678-90ab-cdef-1234-567890abcdef
If you do not know the Asset’s identity you can fetch Asset records using other information you do know.
Fetch All Assets
To fetch all Asset records, simply GET the Assets resource:
curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
https://app.rkvst.io/archivist/v2/assets
Fetch Specific Asset by Identity
If you know the unique identity of the Asset record simply GET the resource:
curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
https://app.rkvst.io/archivist/v2/assets/6a951b62-0a26-4c22-a886-1082297b063b
Fetch Specific Asset at Given Point in Time by Identity
If you know the unique identity of an Asset record and want to show its state at any given point in the past, simply GET with the following query parameter:
curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets/6a951b62-0a26-4c22-a886-1082297b063b?at_time=2021-01-13T12:34:21Z"
This will return the Asset record with the values it had on 2021-01-13T12:34:21Z.
Fetch Assets by Name
To fetch all Assets with a specific name, GET the Assets resource and filter on arc_display_name:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets?attributes.arc_display_name=tcl.ccj.003"
Fetch Assets by Type
To fetch all Assets of a specific type, GET the Assets resource and filter on arc_display_type:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets?attributes.arc_display_type=Traffic%20light"
Fetch Assets by Proof Mechanism
To fetch all Assets that use a specific Proof Mechanism, GET the Assets resource and filter on proof_mechanism:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets?attributes.proof_mechanism=simple_hash"
Fetch Events Ordered for SIMPLEHASHV1 Schema
To fetch Simple Hash Events in the order needed for the SIMPLEHASHV1 schema, GET the Assets resource, specifying a specific Asset ID or using assets/-/events to fetch Events for all Assets:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets/-/events?order_by=SIMPLEHASHV1"
Fetch Assets by Filtering for Presence of a Field
To fetch all Assets with a field set to any value, GET the Assets resource and filter on most available fields. For example:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets?attributes.arc_display_name=*"
Returns all Assets which have arc_display_name that is not empty.
Fetch Assets Which are Missing a Field
To fetch all Assets with a field which is not set to any value, GET the Assets resource and filter on most available fields. For example:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
"https://app.rkvst.io/archivist/v2/assets?attributes.arc_display_name!=*"
Returns all Assets which do not have arc_display_name or in which arc_display_name is empty.
Fetch a Public Asset’s URL
Fetch the Public URL of a Public Asset:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
https://app.rkvst.io/archivist/v2/assets/86b61c4b-030e-4c07-9400-463612e6cee4:publicurl
{
"publicurl":"https://app.rkvst.io/archivist/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4"
}
Fetch a Public Asset’s Event URL
Fetch the Public URL of an Event on a Public Asset:
curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
https://app.rkvst.io/archivist/v2/assets/86b61c4b-030e-4c07-9400-463612e6cee4/events/7da272ad-19d5-4106-b4af-2980a84c2721:publicurl
{
"publicurl":"https://app.rkvst.io/archivist/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4/events/7da272ad-19d5-4106-b4af-2980a84c2721"
}
Tracking and Untracking Assets
While deleting Assets is not possible, it is possible to hide them from default searches so that old or obsolete records don’t crowd out the tenant estate or show up in partner tenancies when they shouldn’t.
Untracking an Asset
Untracking is actually an Event in the Asset lifecycle, so it is necessary to know the Asset identity and POST to it directly. Here we assume we are working with an Asset with identity assets/add30235-1424-4fda-840a-d5ef82c4c96f.
Define the Event parameters and store in /path/to/jsonfile:
{
"operation": "StopTracking",
"behaviour": "Builtin"
}
Untrack the Asset:
curl -v -X POST \
-H "@$BEARER_TOKEN_FILE" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.rkvst.io/archivist/v2/assets/add30235-1424-4fda-840a-d5ef82c4c96f/events
The response is:
{
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/a5e68a57-c5c2-42db-b2a6-e361ba2a7b4a",
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"event_attributes": {},
"asset_attributes": {},
"operation": "StopTracking",
"behaviour": "Builtin",
"timestamp_declared": "2023-02-23T19:55:44Z",
"timestamp_accepted": "2023-02-23T19:55:44Z",
"timestamp_committed": "1970-01-01T00:00:00Z",
"principal_declared": {
"issuer": "idp.synsation.io/1234",
"subject": "phil.b",
"email": "phil.b@synsation.io"
},
"principal_accepted": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"confirmation_status": "PENDING",
"transaction_id": "",
"block_number": 0,
"transaction_index": 0,
"from": "",
"tenant_identity": ""
}
(Re-)Tracking an Asset
It is possible to reverse an untracking Event by tracking the Asset again, assuming you know the Asset identity. Here we assume we are working with an Asset with identity assets/add30235-1424-4fda-840a-d5ef82c4c96f.
Define the Event parameters and store in /path/to/jsonfile:
{
"operation": "StartTracking",
"behaviour": "Builtin"
}
Track the Asset:
curl -v -X POST \
-H "@$BEARER_TOKEN_FILE" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.rkvst.io/archivist/v2/assets/add30235-1424-4fda-840a-d5ef82c4c96f/events
The response is:
{
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/a5e68a57-c5c2-42db-b2a6-e361ba2a7b4a",
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"event_attributes": {},
"asset_attributes": {},
"operation": "StartTracking",
"behaviour": "Builtin",
"timestamp_declared": "2023-02-23T19:55:44Z",
"timestamp_accepted": "2023-02-23T19:55:44Z",
"timestamp_committed": "1970-01-01T00:00:00Z",
"principal_declared": {
"issuer": "idp.synsation.io/1234",
"subject": "phil.b",
"email": "phil.b@synsation.io"
},
"principal_accepted": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"confirmation_status": "PENDING",
"transaction_id": "",
"block_number": 0,
"transaction_index": 0,
"from": "",
"tenant_identity": ""
}
Asset OpenAPI Docs
API for asset and event management.
get /archivist/v2/assets
List Archivist assets
Description: Retrieves a list of Archivist assets
{
"assets": [
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_display_name": "My Garden Fence",
"arc_display_type": "Garden Fence",
"colour": "Plain wood"
},
"confirmation_status": "PENDING",
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"owner": "0x601f5A7D3e6dcB55e87bf2F17bC8A27AaCD3511",
"proof_mechanism": "SIMPLE_HASH",
"public": false,
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"tracked": "TRACKED"
},
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_display_name": "My IoT Device",
"arc_display_type": "IoT Device",
"arc_firmware_version": "3.2.1"
},
"behaviours": [
"RecordEvidence"
],
"confirmation_status": "PENDING",
"identity": "assets/cef61346-2453-5aeb-921c-e6fa93d5b032",
"owner": "0x601f5A7D3e6dcB55e87bf2F17bC8A27AaCD3511",
"proof_mechanism": "KHIPU",
"public": false,
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"tracked": "TRACKED"
}
],
"next_page_token": "abcd"
}| Response Parameter | Type | Description |
|---|---|---|
| assets | array | This describes RKVST Asset. |
| next_page_token | string | Token to retrieve the next page of results or empty if there are none. |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 206 | The number of assets exceeds the servers limit. The approximate number of matching results is provided by the x-total-count header if the ‘x-request-total-count’ header on the request is set to ’true’. The exact limit is available in the content-range header. The value format is ‘items 0-LIMIT/TOTAL’. Note that x-total-count is always present for 200 and 206 responses. It is the servers best available approximation. Similarly, in any result set, you may get a few more than LIMIT items. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to list Assets. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
post /archivist/v2/assets
Create an Archivist asset
Description: Creates an Archivist asset
{
"attributes": {
"arc_display_name": "My Garden Fence",
"arc_display_type": "Garden Fence",
"colour": "Plain wood"
},
"behaviours": [
"RecordEvidence",
"Attachments"
],
"proof_mechanism": "SIMPLE_HASH",
"public": false
}| Parameter | Type | Description |
|---|---|---|
| attributes | object | key value mapping of asset attributes |
| behaviours | array | list of behaviours enabled for this asset |
| public | boolean | Public asset. A public asset and all its events are visible to the general public.Sharing to specific organisations is not available for public assets. |
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_display_name": "My Garden Fence",
"arc_display_type": "Garden Fence",
"colour": "Plain wood"
},
"behaviours": [
"RecordEvidence"
],
"confirmation_status": "PENDING",
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"owner": "0x601f5A7D3e6dcB55e87bf2F17bC8A27AaCD3511",
"proof_mechanism": "SIMPLE_HASH",
"public": false,
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"tracked": "TRACKED"
}| Response Parameter | Type | Description |
|---|---|---|
| at_time | string | indicates time the asset data is from |
| attributes | object | key value mapping of asset properties |
| behaviours | array | list of behaviours enabled for this asset |
| chain_id | string | chain id of the blockchain associated with this asset |
| confirmation_status | string | indicates if the asset has been succesfully committed to the blockchain |
| identity | string | relative resource address assets/{UUID} |
| owner | string | wallet address of the asset owner |
| proof_mechanism | string | the mechanism used to provide evidential proof |
| public | boolean | Public asset |
| storage_integrity | string | DEPRECATED use proof_mechanism |
| tenant_identity | string | Identity of the tenant the that created this asset |
| tracked | string | indicates whether asset is still being tracked in the system |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 401 | Returned when the user is not authenticated to the system. |
| 402 | Returned when the user either has not enabled blockchain storage orthe number of assets would exceed the user’s quota |
| 403 | Returned when the user is not authorized to create an Asset. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
get /archivist/v2/assets/{asset_uuid}/events/{uuid}
Retrieves Archivist event
Description: Retrieves a specific Archivist event
{
"asset_attributes": {
"colour": "Midnight Blue"
},
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 12,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_description": "Painted the fence",
"arc_display_type": "Paint"
},
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000",
"operation": "Record",
"principal_accepted": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"principal_declared": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"timestamp_accepted": "2019-11-27T14:44:19Z",
"timestamp_committed": "2019-11-27T14:44:19Z",
"timestamp_declared": "2019-11-27T14:44:19Z",
"transaction_id": "0x07569",
"transaction_index": 5
}| Response Parameter | Type | Description |
|---|---|---|
| asset_attributes | object | key value mapping of asset attributes |
| asset_identity | string | identity of a related asset resource assets/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000 |
| behaviour | string | The behaviour used to create event. RecordEvidence |
| block_number | string | number of block event was commited on |
| confirmation_status | string | indicates if the event has been succesfully committed to the blockchain |
| event_attributes | object | key value mapping of event attributes |
| from | string | wallet address for the creator of this event |
| identity | string | identity of a event resource |
| operation | string | The operation represented by the event. Record |
| principal_accepted | object | principal recorded by the server |
| principal_declared | object | principal provided by the user |
| tenant_identity | string | Identity of the tenant the that created this event |
| timestamp_accepted | string | time of event as recorded by the server |
| timestamp_committed | string | time of event as recorded on blockchain |
| timestamp_declared | string | time of event as declared by the user |
| transaction_id | string | hash of the transaction as a hex string 0x11bf5b37e0b842e08dcfdc8c4aefc000 |
| transaction_index | string | index of event within commited block |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to view Event. |
| 404 | Returned when the event does not exist. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
get /archivist/v2/assets/{asset_uuid}/events/{uuid}:publicurl
Retrieves the public url for a specific Archivist event.
Description: Retrieves the public url for a specific Archivist event.
{
"publicurl": "https://app.rkvst.io/archivist/publicassets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000"
}| Response Parameter | Type | Description |
|---|---|---|
| publicurl | string |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to view an Asset. |
| 404 | Returned when the asset with the id does not exist. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
get /archivist/v2/assets/{uuid}
Retrieves a specific Archivist asset
Description: Retrieves a specific Archivist asset
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_display_name": "My Garden Fence",
"arc_display_type": "Garden Fence",
"colour": "Plain wood"
},
"behaviours": [
"RecordEvidence"
],
"confirmation_status": "PENDING",
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"owner": "0x601f5A7D3e6dcB55e87bf2F17bC8A27AaCD3511",
"proof_mechanism": "SIMPLE_HASH",
"public": false,
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"tracked": "TRACKED"
}| Response Parameter | Type | Description |
|---|---|---|
| at_time | string | indicates time the asset data is from |
| attributes | object | key value mapping of asset properties |
| behaviours | array | list of behaviours enabled for this asset |
| chain_id | string | chain id of the blockchain associated with this asset |
| confirmation_status | string | indicates if the asset has been succesfully committed to the blockchain |
| identity | string | relative resource address assets/{UUID} |
| owner | string | wallet address of the asset owner |
| proof_mechanism | string | the mechanism used to provide evidential proof |
| public | boolean | Public asset |
| storage_integrity | string | DEPRECATED use proof_mechanism |
| tenant_identity | string | Identity of the tenant the that created this asset |
| tracked | string | indicates whether asset is still being tracked in the system |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to view an Asset. |
| 404 | Returned when the asset with the id does not exist. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
get /archivist/v2/assets/{uuid}/events
List Archivist events
Description: Lists Archivist events
{
"events": [
{
"asset_attributes": {
"colour": "Midnight Blue"
},
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 12,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_description": "Painted the fence",
"arc_display_type": "Paint"
},
"identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000",
"operation": "Record",
"principal_accepted": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"principal_declared": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"timestamp_accepted": "2019-11-27T14:44:19Z",
"timestamp_committed": "2019-11-27T14:44:19Z",
"timestamp_declared": "2019-11-27T14:44:19Z",
"transaction_id": "0x07569",
"transaction_index": 5
},
{
"asset_attributes": {
"arc_firmware_version": "3.2.1"
},
"asset_identity": "assets/cef61346-2453-5aeb-921c-e6fa93d5b032",
"behaviour": "RecordEvidence",
"block_number": 13,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_display_type": "Update Firmware"
},
"identity": "assets/cef61346-2453-5aeb-921c-e6fa93d5b032/events/589bc700-4b04-4bf2-911e-d4ee4821f55e",
"operation": "Record",
"principal_accepted": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"principal_declared": {
"issuer": "job.idp.server/1234",
"subject": "bob@job"
},
"tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9",
"timestamp_accepted": "2019-07-27T14:44:19Z",
"timestamp_committed": "2019-07-27T14:44:19Z",
"timestamp_declared": "2019-07-27T14:44:19Z",
"transaction_id": "0x12569",
"transaction_index": 6
}
],
"next_page_token": "abcd"
}| Response Parameter | Type | Description |
|---|---|---|
| events | array | This describes RKVST Event. |
| next_page_token | string | Token to retrieve the next page of results or empty if there are none. |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 206 | The number of events exceeds the servers limit. The approximate number of matching results is provided by the x-total-count header, the exact limit is available in the content-range header. The value format is ‘items 0-LIMIT/TOTAL’. Note that x-total-count is always present for 200 and 206 responses. It is the servers best available approximation. Similarly, in any result set, you may get a few more than LIMIT items. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to list Events. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |
get /archivist/v2/assets/{uuid}:publicurl
Retrieves the public url for a specific Archivist asset.
Description: Retrieves the public url for a specific Archivist asset.
{
"publicurl": "https://app.rkvst.io/archivist/publicassets/add30235-1424-4fda-840a-d5ef82c4c96f"
}| Response Parameter | Type | Description |
|---|---|---|
| publicurl | string |
| Responses | Description |
|---|---|
| 200 | A successful response. |
| 401 | Returned when the user is not authenticated to the system. |
| 403 | Returned when the user is not authorized to view an Asset. |
| 404 | Returned when the asset with the id does not exist. |
| 429 | Returned when a user exceeds their subscription’s rate limit for requests. |