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.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals"{ "vicalIssueID": 0, "date": "2019-08-24T14:15:22Z"}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.
Range
1 <= value <= 1000Default
100cursor?string
Starting point for the list of entries.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/public"{ "data": [ { "vicalIssueID": 0, "date": "2019-08-24T14:15:22Z", "filename": "string", "isAutoPublished": true } ], "nextCursor": "string"}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.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/public/0""string"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.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/public/latest""string"Delete a VICAL
DELETE
/v1/ecosystems/{ecosystemId}/vicals/{vicalIssueId}Authorization
bearerAuth AuthorizationBearer <token>
In: header
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/json
application/json
curl -X DELETE "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/vicals/0"Empty
How would you rate this page?
Last updated on