Events API
Events API Reference
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance. If you are looking for a simple way to test our API you might prefer our Postman collection, the YAML runner or the Developers section of the web UI.
Additional YAML examples can be found in the articles in the Overview section.
Events API Examples
Create the bearer_token and store in a file in a secure local directory with 0600 permissions.
Event Creation
Define the Event parameters and store in /path/to/jsonfile:
{
"operation": "Record",
"behaviour": "RecordEvidence",
"event_attributes": {
"arc_display_type": "Safety Conformance",
"Safety Rating": "90",
"inspector": "spacetime"
},
"timestamp_declared": "2019-11-27T14:44:19Z",
"principal_declared": {
"issuer": "idp.synsation.io/1234",
"subject": "phil.b",
"email": "phil.b@synsation.io"
}
}
Note:RecordEvidenceis the primary, default behavior for creating Events.
Add the request to the Asset record by POSTing it to the resource:
curl -v -X POST \
-H "@$HOME/.datatrails/bearer-token.txt" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.datatrails.ai/archivist/v2/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events
The response is:
{
"identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"asset_identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"operation": "Record",
"behaviour": "RecordEvidence",
"event_attributes": {
"arc_display_type": "Safety Conformance",
"Safety Rating": "90",
"inspector": "spacetime"
},
"timestamp_accepted": "2019-11-27T15:13:21Z",
"timestamp_declared": "2019-11-27T14:44:19Z",
"timestamp_committed": "2019-11-27T15:15:02Z",
"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": "CONFIRMED",
"block_number": 12,
"transaction_index": 5,
"transaction_id": "0x07569"
}
Document Profile Event Creation
There are two
Document Profile Events that are available as part of the document lifecycle. These are to publish a new version and to withdraw the document from use.
Publish
Define the Event parameters and store in /path/to/jsonfile:
{
"behaviour": "RecordEvidence",
"operation": "Record",
"asset_attributes": {
"document_hash_value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"document_hash_alg":"sha256",
"document_status": "Published",
"document_version":"2"
},
"event_attributes": {
"arc_description":"Publish version 2 of Test Document",
"arc_display_type":"Publish",
"document_version_authors": [
{
"display_name": "George",
"email": "george@rainbow.tv"
},
{
"display_name": "Zippy",
"email": "zippy@rainbow.tv"
},
{
"display_name": "Bungle",
"email": "bungle@rainbow.tv"
}
]
}
}
Add the request to the Asset record by POSTing it to the resource:
curl -v -X POST \
-H "@datatrails-bearer.txt" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.datatrails.ai/archivist/v2/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events
The response is:
{
"identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"asset_identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"event_attributes": {
"document_version_authors": [
{
"display_name": "George",
"email": "george@rainbow.tv"
},
{
"display_name": "Zippy",
"email": "zippy@rainbow.tv"
},
{
"display_name": "Bungle",
"email": "bungle@rainbow.tv"
}
],
"arc_description": "Publish version 2 of Test Document",
"arc_display_type": "Publish"
},
"asset_attributes": {
"document_status": "Published",
"document_version": "2",
"document_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"document_hash_alg": "sha256"
},
"operation": "Record",
"behaviour": "RecordEvidence",
"timestamp_declared": "2023-09-27T12:55:16Z",
"timestamp_accepted": "2023-09-27T12:55:16Z",
"timestamp_committed": "1970-01-01T00:00:00Z",
"principal_declared": {
"issuer": "https://app.datatrails.ai/appidpv1",
"subject": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "CustomIntegration",
"email": ""
},
"principal_accepted": {
"issuer": "https://app.datatrails.ai/appidpv1",
"subject": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "CustomIntegration",
"email": ""
},
"confirmation_status": "PENDING",
"transaction_id": "",
"block_number": 0,
"transaction_index": 0,
"from": "",
"tenant_identity": ""
}
Withdraw
Define the Event parameters and store in /path/to/jsonfile:
{
"behaviour": "RecordEvidence",
"operation": "Record",
"asset_attributes": {
"document_status":"Withdrawn"
},
"event_attributes": {
"arc_description":"Withdraw the Test Document",
"arc_display_type":"Withdraw"
}
}
Add the request to the Asset record by POSTing it to the resource:
curl -v -X POST \
-H "@datatrails-bearer.txt" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.datatrails.ai/archivist/v2/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events
The response is:
{
"identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"asset_identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"event_attributes": {
"arc_description": "Withdraw the Test Document",
"arc_display_type": "Withdraw"
},
"asset_attributes": {
"document_status": "Withdrawn"
},
"operation": "Record",
"behaviour": "RecordEvidence",
"timestamp_declared": "2023-09-27T13:08:32Z",
"timestamp_accepted": "2023-09-27T13:08:32Z",
"timestamp_committed": "1970-01-01T00:00:00Z",
"principal_declared": {
"issuer": "https://app.datatrails.ai/appidpv1",
"subject": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "CustomIntegration",
"email": ""
},
"principal_accepted": {
"issuer": "https://app.datatrails.ai/appidpv1",
"subject": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "CustomIntegration",
"email": ""
},
"confirmation_status": "PENDING",
"transaction_id": "",
"block_number": 0,
"transaction_index": 0,
"from": "",
"tenant_identity": ""
}
Adding Attachments
The following assumes that an attachment has already been uploaded to DataTrails using the Blob API.
This attachment uuid is generically referred to as:
blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Each attachment has an associated hash value and the name of the hash algorithm used that you can also get from the Blob API response.
Once you’ve uploaded your file, you can use the "arc_attribute_type": "arc_attachment" key-value pair within a dictionary of blob information to add the attachment to either your Asset or Event.
The following example shows you usage with both the event_attributes and the asset_attributes:
{
"operation": "Record",
"behaviour": "RecordEvidence",
"event_attributes": {
"arc_display_type": "Safety Conformance",
"arc_description": "Safety conformance approved for version 1.6. See attached conformance report",
"arc_evidence": "DVA Conformance Report attached",
"conformance_report": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "safety_conformance.pdf",
"arc_display_name": "Conformance Report",
},
"arc_primary_image": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "photo.jpg",
"arc_display_name": "arc_primary_image",
},
},
"asset_attributes": {
"latest_conformance_report": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "safety_conformance.pdf",
"arc_display_name": "Latest Conformance Report",
},
},
"timestamp_declared": "2019-11-27T14:44:19Z",
"principal_declared": {
"issuer": "idp.synsation.io/1234",
"subject": "phil.b",
"email": "phil.b@synsation.io"
},
}
Add the request to the Asset Record by POSTing it to the resource:
curl -v -X POST \
-H "@$HOME/.datatrails/bearer-token.txt" \
-H "Content-type: application/json" \
-d "@/path/to/jsonfile" \
https://app.datatrails.ai/archivist/v2/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events
You should see the response:
{
"identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"asset_identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"operation": "Record",
"behaviour": "RecordEvidence",
"event_attributes": {
"arc_display_type": "Safety Conformance",
"arc_description": "Safety conformance approved for version 1.6. See attached conformance report",
"arc_evidence": "DVA Conformance Report attached",
"conformance_report": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "safety_conformance.pdf",
"arc_display_name": "Conformance Report",
},
"arc_primary_image": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "safety_conformance.pdf",
"arc_display_name": "Conformance Report",
},
},
"asset_attributes": {
"latest_conformance_report": {
"arc_attribute_type": "arc_attachment",
"arc_blob_hash_value": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"arc_blob_identity": "blobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"arc_blob_hash_alg": "SHA256",
"arc_file_name": "safety_conformance.pdf",
"arc_display_name": "Latest Conformance Report",
},
},
"timestamp_accepted": "2019-11-27T15:13:21Z",
"timestamp_declared": "2019-11-27T14:44:19Z",
"timestamp_committed": "2019-11-27T15:15:02Z",
"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": "CONFIRMED",
"block_number": 12,
"transaction_index": 5,
"transaction_id": "0x07569"
}
Events 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_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
],
"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"
},
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/2865ca31-d01f-5e6f-4621-de562470732e",
"arc_display_name": "Picture",
"arc_hash_alg": "sha256",
"arc_hash_value": "12bc4819d90b6fe911b091a7c05134b65edfce045e09b048caaa7916ecdd458c"
}
],
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/53165a2c-6054-dd68-f093-a0e1e21304fd"
},
"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_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
],
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"behaviours": [
"RecordEvidence"
],
"proof_mechanism": "SIMPLE_HASH",
"public": false
}| Parameter | Type | Description |
|---|---|---|
| attributes | object | key value mapping of event attributes |
| behaviours | array | list of behaviours enabled for this asset |
| chain_id | string | chain id of the blockchain associated with this asset |
| proof_mechanism | string | specify the mechanism used to provide evidential proof for Events on 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. |
| storage_integrity | string | DEPRECATED use proof_mechanism |
{
"at_time": "2019-11-27T14:44:19Z",
"attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
],
"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"
}| 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": {
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 12,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
]
},
"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_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
],
"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"
}| 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": {
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 12,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
]
},
"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",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"asset_identity": "assets/bf330235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 13,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
]
},
"identity": "assets/bf330235-1424-4fda-840a-d5ef82c4c96f/events/23c06c48-e0b8-42e0-8dcf-dc8c4fdad123",
"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. |
post /archivist/v2/assets/{uuid}/events
Description:
| Parameter | Type | Required | Description |
|---|---|---|---|
| uuid | string | true | 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 |
| body | true |
{
"asset_attributes": {
"arc_firmware_version": "3.2.1",
"arc_home_location_identity": "locations/42054f10-9952-4c10-a082-9fd0d10295ae"
},
"asset_identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f",
"behaviour": "RecordEvidence",
"block_number": 12,
"confirmation_status": "CONFIRMED",
"event_attributes": {
"arc_attachments": [
{
"arc_attachment_identity": "blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d",
"arc_display_name": "Picture from yesterday",
"arc_hash_alg": "sha256",
"arc_hash_value": "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
}
]
},
"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. |
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. |