Assets Swagger API

GET /archivist/v2/assets

List Archivist assets

Retrieves a list of Archivist assets

Query Parameters

• attributes.arc_display_name (string) – List only Assets with this friendly name

• attributes.arc_display_type (string) – List only Assets of this type

• page_size (integer) – Maximum results per page.

• page_token (string) – The next_page_token returned from a previous list request if any.

• order_by (string) – Specify the sort order for the results.

• tracked (string) – indicates whether asset is still being tracked in the system

• confirmation_status (string) – indicates if the asset has been succesfully committed to the blockchain

• storage_integrity (string) –

  XXX: #4483 DEPRECATED use proof_mechanism

  DEPRECATED use proof_mechanism

• proof_mechanism (string) –

  proof mechanism of the asset (and all its events)

  the mechanism used to provide evidential proof

• chain_id (string) – chain id of the blockchain associated with this asset

• privacy (string) –

  privacy filter of the asset (and all its events)

  the privacy status of the asset

Status Codes

• 200 OK – A successful response.

• 206 Partial Content – 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 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to list Assets.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• assets[].at_time (string) – indicates time the asset data is from (read only)

• assets[].attributes (object) – key value mapping of asset properties

• assets[].behaviours[] (string) –

• assets[].chain_id (string) – chain id of the blockchain associated with this asset (read only)

• assets[].confirmation_status (string) –

• assets[].identity (string) – relative resource address assets/{UUID} (read only)

• assets[].owner (string) – wallet address of the asset owner (read only)

• assets[].proof_mechanism (string) –

• assets[].public (boolean) – Public asset

• assets[].storage_integrity (string) – Specifies how the asset data will be stored. This is set once on creation and does not change.

• assets[].tenant_identity (string) – Identity of the tenant the that created this asset

• assets[].tracked (string) –

• next_page_token (string) – Token to retrieve the next page of results or empty if there are none.

POST /archivist/v2/assets

Create an Archivist asset

Creates an Archivist asset

Request JSON Object

• attributes (object) – key value mapping of asset attributes

• behaviours[] (string) –

• 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.

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 402 Payment Required – Returned when the user either has not enabled blockchain storage orthe number of assets would exceed the user’s quota

• 403 Forbidden – Returned when the user is not authorized to create an Asset.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• at_time (string) – indicates time the asset data is from (read only)

• attributes (object) – key value mapping of asset properties

• behaviours[] (string) –

• chain_id (string) – chain id of the blockchain associated with this asset (read only)

• confirmation_status (string) –

• identity (string) – relative resource address assets/{UUID} (read only)

• owner (string) – wallet address of the asset owner (read only)

• proof_mechanism (string) –

• public (boolean) – Public asset

• storage_integrity (string) – Specifies how the asset data will be stored. This is set once on creation and does not change.

• tenant_identity (string) – Identity of the tenant the that created this asset

• tracked (string) –

GET /archivist/v2/assets/{uuid}

Retrieves a specific Archivist asset

Retrieves a specific Archivist asset

Parameters

• uuid (string) – Specify the Asset UUID where assets/{uuid} is the Asset Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity assets/add30235-1424-4fda-840a-d5ef82c4c96f

Query Parameters

• at_time (string) – Specify time in the past to show asset data as it was at time specified

Status Codes

• 200 OK – A successful response.

• 401 Unauthorized – Returned when the user is not authenticated to the system.

• 403 Forbidden – Returned when the user is not authorized to view an Asset.

• 404 Not Found – Returned when the asset with the id does not exist.

• 429 Too Many Requests – Returned when a user exceeds their subscription’s rate limit for requests.

• default – An unexpected error response.

Response JSON Object

• at_time (string) – indicates time the asset data is from (read only)

• attributes (object) – key value mapping of asset properties

• behaviours[] (string) –

• chain_id (string) – chain id of the blockchain associated with this asset (read only)

• confirmation_status (string) –

• identity (string) – relative resource address assets/{UUID} (read only)

• owner (string) – wallet address of the asset owner (read only)

• proof_mechanism (string) –

• public (boolean) – Public asset

• storage_integrity (string) – Specifies how the asset data will be stored. This is set once on creation and does not change.

• tenant_identity (string) – Identity of the tenant the that created this asset

• tracked (string) –