Categories:
TV section plugin
TV section plugin description for aura-configuration-api
Introduction
The tv-section plugin defines services associated with the management of TV sections in aura-configuration-api server.
All these services are defined in the tv-sections namespace (/tv/sections).
Servers definition
By default, the servers defined in the swagger include the base path (for v1): /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/tv/sections
- aura-services/v2/configuration/tv/sections/{tvSectionId}
Endpoints
| Path | Method | Description |
|---|---|---|
| /tv/sections/ | GET | Get all TV section information |
| /tv/sections/ | POST | Add a new TV section |
| /tv/sections/{tvSectionId} | GET | Get TV section information using TV section id |
| /tv/sections/{tvSectionId} | PUT | Replace TV section information associated to TV section id |
| /tv/sections/{tvSectionId} | PATCH | Update some fields of TV section information using TV section id |
| /tv/sections/{tvSectionId} | DELETE | Delete TV section information using TV section id |
You can read the complete documentation of each service in the aura-configuration-api swagger file.
Retrieving information from TV sections
Retrieving specific fields from TV section information
It is possible to get only a specific list of fields for TV section 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/tv/sections?includeFields=id,name,canon' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "ab744582-c5a6-48e1-95bb-f509bdb55512",
"name": "tv-section-pid-1",
"canon": "tv-section-canon"
}
]
Excluding fields in TV sections information
It is also possible to exclude TV section information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/tv/sections?excludeFields=metadata,name' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "ab744582-c5a6-48e1-95bb-f509bdb55512",
"pid": "tv-section-pid-1"
}
]
Database
The complete definition of the data model can be found in TV section collection section within the administration module.