API Reference
Configuration
Update a RICAL configuration
PUT
Update the RICAL configuration for the requested ecosystem.
A RICAL configuration is required in order for RICALs to be created.
Roles
admindts-provider
Analytics Events
ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_STARTECOSYSTEM_RICAL_CONFIGURATION_UPSERT_SUCCESSECOSYSTEM_RICAL_CONFIGURATION_UPSERT_FAIL
bearerAuthheader
AuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
Format
uuidapplication/json- body
ricalProvider*stringRICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of RICALs.
RICAL configuration updated
application/json- response
ricalProvider*stringRICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of RICALs.
curl -X PUT "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/configuration" \ -H "Content-Type: application/json" \ -d '{ "ricalProvider": "MATTR" }'{ "ricalProvider": "MATTR", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Retrieve a RICAL configuration
GET
Retrieve the RICAL configuration from the requested ecosystem.
Roles
admindts-provider
Analytics Events
ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_STARTECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_SUCCESSECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_FAIL
bearerAuthheader
AuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
Format
uuidRICAL configuration retrieved
application/json- response
ricalProvider*stringRICAL provider name.
autoPublish?Configuration for automatic scheduled publishing of RICALs.
curl -X GET "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/configuration"{ "ricalProvider": "MATTR", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2025-07-01T00:00:00.000Z" }}Delete RICAL configuration
DELETE
Delete the RICAL configuration for the requested ecosystem.
Roles
admindts-provider
Analytics Events
ECOSYSTEM_RICAL_CONFIGURATION_DELETE_STARTECOSYSTEM_RICAL_CONFIGURATION_DELETE_SUCCESSECOSYSTEM_RICAL_CONFIGURATION_DELETE_FAIL
bearerAuthheader
AuthorizationBearer <token>ecosystemId*stringThe UUID of the ecosystem
Format
uuidRICAL configuration deleted
curl -X DELETE "https://example.com/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/configuration"Empty
How would you rate this page?
Last updated on