Events Swagger API

GET /archivist/v2/assets/{uuid}/events

List Archivist events

Lists Archivist events

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. Use - to list Events for all Assets

Query Parameters

  • attributes.arc_display_type (string) – Only list Events matching this event 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.

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

  • principal_declared.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • principal_declared.subject (string) – unique identifier of the principal (within issuer context)

  • principal_declared.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • principal_declared.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • principal_accepted.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • principal_accepted.subject (string) – unique identifier of the principal (within issuer context)

  • principal_accepted.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • principal_accepted.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • timestamp_accepted_since (string) –

    Filtering

    Only list events when timestamp_accepted is greater

  • timestamp_accepted_before (string) – Only list events when timestamp_accepted is lesser

  • timestamp_committed_since (string) – Only list events when timestamp_committed is greater

  • timestamp_committed_before (string) – Only list events when timestamp_committed is lesser

  • timestamp_declared_since (string) – Only list events when timestamp_declared is greater

  • timestamp_declared_before (string) – Only list events when timestamp_declared is lesser

  • operation (string) –

  • behaviour (string) –

  • proof_mechanism (string) –

    mechanism for evidential proof for Events on this Asset

    specify the mechanism used to provide evidential proof for Events on this Asset

Status Codes

  • 200 OK – A successful response.

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

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

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

  • default – An unexpected error response.

Response JSON Object

  • events[].asset_attributes (object) – key value mapping of asset attributes

  • events[].asset_identity (string) – identity of a related asset resource assets/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000 (read only)

  • events[].behaviour (string) – The behaviour used to create event. RecordEvidence (read only)

  • events[].block_number (string) – number of block event was commited on (read only)

  • events[].confirmation_status (string) –

  • events[].event_attributes (object) – key value mapping of event attributes

  • events[].from (string) – wallet address for the creator of this event (read only)

  • events[].identity (string) – identity of a event resource (read only)

  • events[].operation (string) – The operation represented by the event. Record (read only)

  • events[].principal_accepted.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • events[].principal_accepted.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • events[].principal_accepted.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • events[].principal_accepted.subject (string) – unique identifier of the principal (within issuer context)

  • events[].principal_declared.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • events[].principal_declared.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • events[].principal_declared.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • events[].principal_declared.subject (string) – unique identifier of the principal (within issuer context)

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

  • events[].timestamp_accepted (string) – time of event as recorded by the server (read only)

  • events[].timestamp_committed (string) – time of event as recorded on blockchain (read only)

  • events[].timestamp_declared (string) – time of event as declared by the user (read only)

  • events[].transaction_id (string) – hash of the transaction as a hex string 0x11bf5b37e0b842e08dcfdc8c4aefc000

  • events[].transaction_index (string) – index of event within commited block (read only)

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

GET /archivist/v2/assets/{asset_uuid}/events/{uuid}

Retrieves Archivist event

Retrieves a specific Archivist event

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

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.

  • 404 Not Found – Returned when the event 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

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

  • asset_identity (string) – identity of a related asset resource assets/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000 (read only)

  • behaviour (string) – The behaviour used to create event. RecordEvidence (read only)

  • block_number (string) – number of block event was commited on (read only)

  • confirmation_status (string) –

  • event_attributes (object) – key value mapping of event attributes

  • from (string) – wallet address for the creator of this event (read only)

  • identity (string) – identity of a event resource (read only)

  • operation (string) – The operation represented by the event. Record (read only)

  • principal_accepted.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • principal_accepted.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • principal_accepted.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • principal_accepted.subject (string) – unique identifier of the principal (within issuer context)

  • principal_declared.display_name (string) – The displayable name of the end-user. The name claim is prefered, followed by email claims, then a composite of given_name, middle_name, family_name

  • principal_declared.email (string) – The email for the end-user if available. If email_verified is available it is preferd. Empty if neither email_verified or email are provided by the IdP

  • principal_declared.issuer (string) – optional issuer of the principal identity. Where the issuer is not provided the subject is treated as a free string

  • principal_declared.subject (string) – unique identifier of the principal (within issuer context)

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

  • timestamp_accepted (string) – time of event as recorded by the server (read only)

  • timestamp_committed (string) – time of event as recorded on blockchain (read only)

  • timestamp_declared (string) – time of event as declared by the user (read only)

  • transaction_id (string) – hash of the transaction as a hex string 0x11bf5b37e0b842e08dcfdc8c4aefc000

  • transaction_index (string) – index of event within commited block (read only)

GET /archivist/v2/assets/{asset_uuid}/events/{uuid}:publicurl

Retrieves the public url for a specific Archivist event.

Retrieves the public url for a specific Archivist event.

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

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

  • publicurl (string) –