API Reference
General
Create a VICAL
POST
/v1/ecosystems/{ecosystemId}/vicalsAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals"{
"vicalIssueID": 1337,
"date": "2024-07-28T23:01:13.000Z"
}Empty
Retrieve all VICALs
GET
/v1/ecosystems/{ecosystemId}/vicals/publicPath Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidQuery Parameters
limit?number
Range size of returned list.
Default
100Range
1 <= value <= 1000cursor?string
Starting point for the list of entries.
Response Body
application/json
application/json
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public"{
"data": [
{
"vicalIssueID": 1337,
"date": "2024-07-28T23:01:13.000Z",
"filename": "vical-2024-07-28-1722164473000.cbor",
"isAutoPublished": false
}
],
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Retrieve a VICAL
GET
/v1/ecosystems/{ecosystemId}/vicals/public/{vicalIssueId}Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidvicalIssueId*integer
Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created.
Format
int32Response Body
application/cbor
application/json
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/1337""string"{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}Retrieve latest VICAL
GET
/v1/ecosystems/{ecosystemId}/vicals/public/latestPath Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/cbor
application/json
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/public/latest""string"{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}How would you rate this page?