API Reference
Configuration
Update a VICAL configuration
PUT
Update the VICAL configuration for the requested ecosystem
Roles
admindts-provider
bearerAuthheader
AuthorizationBearer <JWT>ecosystemId*stringThe UUID of the ecosystem
Format
uuidapplication/json- body
vicalProvider*stringVICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of VICALs.
VICAL configuration updated
application/json- response
vicalProvider*stringVICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of VICALs.
curl -X PUT 'https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration' \ -H 'Content-Type: application/json' \ -d '{ "vicalProvider": "Mattr"}'Example Response
{ "vicalProvider": "Mattr", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Retrieve VICAL configurations
GET
Retrieve the VICAL configuration from the requested ecosystem
Roles
admindts-provider
bearerAuthheader
AuthorizationBearer <JWT>ecosystemId*stringThe UUID of the ecosystem
Format
uuidVICAL configuration retrieved
application/json- response
vicalProvider*stringVICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of VICALs.
curl -X GET 'https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration'Example Response
{ "vicalProvider": "Mattr", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Delete VICAL configuration
DELETE
Delete the VICAL configuration for the requested ecosystem
Roles
admindts-provider
bearerAuthheader
AuthorizationBearer <JWT>ecosystemId*stringThe UUID of the ecosystem
Format
uuidVICAL configuration deleted
curl -X DELETE 'https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/vicals/configuration'Example Response
Empty
How would you rate this page?
Last updated on