API Reference
Configuration
Update a RICAL configuration
PUT
/v1/ecosystems/{ecosystemId}/ricals/configurationUpdate 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
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/configuration" \ -H "Content-Type: application/json" \ -d '{ "ricalProvider": "string" }'{ "ricalProvider": "string", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2019-08-24T14:15:22Z" }}Retrieve a RICAL configuration
GET
/v1/ecosystems/{ecosystemId}/ricals/configurationRetrieve 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
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/configuration"{ "ricalProvider": "string", "autoPublish": { "enabled": true, "frequency": "Daily", "configuredAt": "2019-08-24T14:15:22Z" }}Delete RICAL configuration
DELETE
/v1/ecosystems/{ecosystemId}/ricals/configurationDelete 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
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
ecosystemId*string
The UUID of the ecosystem
Format
uuidResponse Body
application/json
curl -X DELETE "https://example.com/v1/ecosystems/497f6eca-6276-4993-bfeb-53cbbbba6f08/ricals/configuration"Empty
How would you rate this page?
Last updated on