API ReferenceConfiguration
Retrieve RICAL configuration
Roles
admindts-provider
Analytics Events
ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_STARTECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_SUCCESSECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_FAIL
GET
/v1/ecosystems/{ecosystemId}/ricals/configurationRetrieve the RICAL configuration from the requested ecosystem.
Analytic events
- ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_START
- ECOSYSTEM_RICAL_CONFIGURATION_RETRIEVE_SUCCESS
- ECOSYSTEM_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" }}How would you rate this page?
Update RICAL configuration PUT
Update the RICAL configuration for the requested ecosystem. A RICAL configuration is required in order for RICALs to be created. ### **Analytic events** * ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_START * ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_SUCCESS * ECOSYSTEM_RICAL_CONFIGURATION_UPSERT_FAIL
Delete RICAL configuration DELETE
Delete the RICAL configuration for the requested ecosystem. ### **Analytic events** * ECOSYSTEM_RICAL_CONFIGURATION_DELETE_START * ECOSYSTEM_RICAL_CONFIGURATION_DELETE_SUCCESS * ECOSYSTEM_RICAL_CONFIGURATION_DELETE_FAIL