Blockchain Swagger API

GET /archivist/v1alpha2/blockchain/assets/{asset_uuid}/events/{uuid}

List of Blockchain Transactions associated with an event.

List of Blockchain Transactions associated with an event. If the event’s asset has a proof mechanism of khipu, this will be a list of transactions that compose the event. If the event’s asset has a proof mecahnism of simple hash, this will be a list containing one transaction, that describes the simple hash anchor transaction. If the list is empty, the event has not been anchored yet.

Parameters

  • asset_uuid (string) – Specify the Asset UUID where assets/{asset_uuid}/events/{uuid} is the Event Identity e.g. add30235-1424-4fda-840a-d5ef82c4c96f from Identity assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

  • uuid (string) – Specify the Event UUID where assets/{asset_uuid}/events/{uuid} is the Event Identity e.g. 11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000 from Identity assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000

Query Parameters

  • page_size (integer) – Maximum entries per page

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

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 event’s blockchain transactions.

  • 404 Not Found – Returned when the asset with the id does not exist. or the event 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

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

  • transactions[].khipu_details (object) –

  • transactions[].kind (string) –

  • transactions[].simple_hash_details.anchor_hash (string) –

  • transactions[].simple_hash_details.api_query (string) –

  • transactions[].simple_hash_details.end_time (string) –

  • transactions[].simple_hash_details.event_count (integer) –

  • transactions[].simple_hash_details.hash_schema_version (integer) –

  • transactions[].simple_hash_details.start_time (string) –

  • transactions[].transaction.block_number (string) – Block number

  • transactions[].transaction.blockhash (string) – Block Hash

  • transactions[].transaction.from (string) – From…

  • transactions[].transaction.gas (string) – Gas left

  • transactions[].transaction.gas_price (string) – Gas Price

  • transactions[].transaction.hash (string) – Transaction hash

  • transactions[].transaction.input (string) – Input…

  • transactions[].transaction.nonce (string) – Nonce

  • transactions[].transaction.r (string) – Signature: R value

  • transactions[].transaction.s (string) – Signature: S Value

  • transactions[].transaction.to (string) – To…

  • transactions[].transaction.transaction_index (integer) – Transaction Index

  • transactions[].transaction.v (string) – Signature: V value

  • transactions[].transaction.value (string) – Value

GET /archivist/v1alpha2/blockchain:openapi

Get OpenAPI spec for Blockchain

Get OpenAPI v2.0 spec for Blockchain

Status Codes

  • 200 OK – A successful response.

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

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

  • default – An unexpected error response.

GET /archivist/v1alpha2/blockchain:openapi-ui

Get OpenAPI UI for Blockchain

Get OpenAPI v2.0 UI for Blockchain

Status Codes

  • 200 OK – A successful response.

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

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

  • default – An unexpected error response.