Asset Record Retrieval¶
Create the bearer_token and store in a file in a secure local directory with 0600 permissions.
See API Request Authorization and Authentication.
Note
The following example shows use of the API over curl in a bash terminal. The concepts are fully portable to any other REST client (eg PostMan or python requests)
Set the URL (for example):
$ export URL=https://synsation.1234-5678.nodes.archivist.jitsuin.io
Asset records in Jitsuin Archivist are tokenized at creation time and referred to in all API calls and smart contracts throughout the system by a unique identity of the form:
assets/12345678-90ab-cdef-1234-567890abcdef.
If you do not know the asset’s identity you can fetch asset records using other information you do know, such as the asset’s name in your asset management or digital twin platform.
Fetch all assets¶
To fetch all asset records, simply GET the assets
resource:
$ curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets
Fetch specific asset by identity¶
If you know the unique identity of the Asset Record simply GET the resource:
$ curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets/6a951b62-0a26-4c22-a886-1082297b063b
Fetch specific asset at given point in time by identity¶
If you know the unique identity of an Asset Record and want to show its state at any given point in the past, simply GET with following query parameter
$ curl -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets/6a951b62-0a26-4c22-a886-1082297b063b?at_time=2021-01-13T12:34:21Z
This will return the Asset Record with the values it had on 2021-01-13T12:34:21Z
Fetch assets by name¶
To fetch all assets with a specific name, GET the assets
resource and filter on arc_display_name
:
$ curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets?attributes.arc_display_name=tcl.ccj.003
Fetch assets by type¶
To fetch all assets of a specific type, GET the assets
resource and filter on arc_display_type
:
$ curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets?attributes.arc_display_type=Traffic%20light
Each of these calls returns a list of matching asset records in the form:
{
"assets": [
{
"identity": "assets/6a951b62-0a26-4c22-a886-1082297b063b",
"behaviours": [
"Firmware",
"Maintenance",
"RecordEvidence",
"LocationUpdate",
"Attachments"
],
"attributes": {
"arc_display_type": "Traffic light",
"arc_firmware_version": "1.0",
"arc_home_location_identity": "locations/866790d8-4ed6-4cc9-8f60-07672609b331",
"arc_serial_number": "vtl-x4-07",
"arc_description": "Traffic flow control light at A603 North East",
"arc_display_name": "tcl.ccj.003",
"some_custom_attribute": "value",
"arc_attachments": [
{
"arc_display_name": "arc_primary_image",
"arc_attachment_identity": "blobs/87b1a84c-1c6f-442b-923e-a97516f4d275",
"arc_hash_alg": "SHA256",
"arc_hash_value": "246c316e2cd6971ce5c83a3e61f9880fa6e2f14ae2976ee03500eb282fd03a60"
}
]
},
"confirmation_status": "CONFIRMED",
"tracked": "TRACKED"
}
]
}
Fetch assets by filtering for presence of a field¶
To fetch all assets with a field set to any value, GET the assets
resource
and filter on most available fields. For example:
$ curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets?attributes.arc_display_name=*
Returns all assets which have arc_display_name that is not empty.
Fetch assets which are missing a field¶
To fetch all assets with a field which is not set to any value, GET the
assets
resource and filter on most available fields. For example:
$ curl -g -v -X GET \
-H "@$BEARER_TOKEN_FILE" \
$URL/archivist/v2/assets?attributes.arc_display_name!=*
Returns all assets which do not have arc_display_name or in which arc_display_name is empty.
Note
See Behaviours and LifeCycle for details of how to interpret
the system-reserved arc_*
attributes.
See Upload Blob and/or Location Creation for details
of how to handle the arc_home_location_identity
and arc_primary_image
attributes.
Note
The number of records returned has a maximum limit. If this limit is too small then one must use API Request Paging.
Note
The total number of assets that exist is returned in the response header field ‘x-total-count’ if the ‘x-request-total-count’ header on the request is set to ‘true’. The curl option ‘-i’ will emit this to stdout.
Note
A full API reference is available in Swagger GET API