Categories:
Aura Configuration API channel module
Description of the channel module in aura-configuration-api
Channel module
The channel module defines services associated with channel management in aura-configuration-api server.
All these services are defined in the channel namespace (/channel).
Servers definition
By default, the servers defined in the swagger include the base path (for v2): /aura-services/v2/configuration.
Therefore, in order to access the services, the base path and service path must be used.
Examples:
- aura-services/v2/configuration/channels/
- aura-services/v2/configuration/channels/{channelId}/libraries
Endpoints
| Path | Method | Description |
|---|---|---|
| /channels/ | GET | Get all channels information |
| /channels/ | POST | Add a new channel |
| /channels/{channelId} | GET | Get channel information using channel id |
| /channels/{channelId} | PUT | Replace channel information associated to channel id |
| /channels/{channelId} | PATCH | Update some fields of channel information using channel id |
| /channels/{channelId} | DELETE | Delete channel information using channel id |
| /channels/{channelId}/libraries | POST | Add a new library configuration to channel id |
| /channels/{channelId}/libraries | DELETE | Remove all libraries configuration from channel id |
| /channels/{channelId}/libraries/{libraryId} | GET | Get library configuration from library id and channel id |
| /channels/{channelId}/libraries/{libraryId} | PUT | Replace library configuration associated to library and channel id |
| /channels/{channelId}/libraries/{libraryId} | DELETE | Delete library information using library and channel id |
You can read the complete documentation of each service in the aura-configuration-api swagger file.
Retrieving information from channels
Retrieving only some fields in channel information
It is possible to get only a specific list of fields for channel information, reducing the amount of data transmitted when necessary, using the includeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/channels?includeFields=name,prefix' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "45494a5b-835a-4fff-a813-b3d2be529dbe",
"name": "novum-mytelco",
"prefix": "nov"
}
]
Excluding fields in channel information
It is also possible to exclude channel information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/channels?excludeFields=dialogLibraries,nlp,requestOptions,responseOptions' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "45494a5b-835a-4fff-a813-b3d2be529dbe",
"name": "novum-mytelco",
"prefix": "nov",
"security": {
"authPurposes": "customer-self-service identify-customer aura-technical-problems-purpose",
"authScopes": "",
"channelId": "novum-mytelco"
},
"metadata": {
"updatedAt": "2022-09-06T09:58:19.543Z",
"version": "7.4.0",
"createdAt": "2022-09-06T09:58:19.543Z"
}
}
]
Database
The complete definition of the data model can be found in the channels collection section in the Administration module.