Assets API

Assets API Reference

get  /archivist/v2/assets

Description:

null
Response Parameter Type Description
assets array This describes Jitsuin Asset.
next_page_token string Token to retrieve the next page of results or empty if there are none.
Responses Description
200A successful response.
206The 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.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to list Assets.
defaultAn unexpected error response.

post  /archivist/v2/assets

Description:

{
  "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": [
    "Firmware",
    "Location"
  ]
}
Parameter Type Description
attributes object key value mapping of event attributes
behaviours array list of behaviours enabled for this asset
storage_integrity specify the asset storage integrity level

{
  "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": [
    "Firmware",
    "Location"
  ],
  "identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f"
}
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
confirmation_status 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
storage_integrity the asset storage integrity level
tracked indicates whether asset is still being tracked in the system
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to create an Asset.
defaultAn unexpected error response.

get  /archivist/v2/{asset_identity}

Description:

{
  "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": [
    "Firmware",
    "Location"
  ],
  "identity": "assets/add30235-1424-4fda-840a-d5ef82c4c96f"
}
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
confirmation_status 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
storage_integrity the asset storage integrity level
tracked indicates whether asset is still being tracked in the system
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view an Asset.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

get  /archivist/v2/{asset_identity}/events

Description:

null
Response Parameter Type Description
events array This describes Jitsuin Event.
next_page_token string Token to retrieve the next page of results or empty if there are none.
Responses Description
200A successful response.
206The 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.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to list Events.
defaultAn unexpected error response.

get  /archivist/v2/{event_identity}

Description:

{
  "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": "Firmware",
  "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": "Update",
  "principal_accepted": {
    "issuer": "job.idp.server/1234",
    "subject": "bob@job"
  },
  "principal_declared": {
    "issuer": "job.idp.server/1234",
    "subject": "bob@job"
  },
  "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. Firmware
block_number string number of block event was commited on
confirmation_status 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. Update
principal_accepted principal recorded by the server
principal_declared principal provided by the user
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
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to view Event.
404Returned when the event does not exist.
defaultAn unexpected error response.

Edit this page on GitHub