Configurations

Management of the configuration files.

Configurations Settings Model

Field	Type	Description	Example	Required
path	String	Path of the configuration file.	/opt/test.json	True
format	Enum(String)[json,yaml]	Format of the configuration file.	yaml	True
history	List(ActionModel)	History of configuration updates.		True

Configurations Output Model

Merge to Configurations Settings Model with the following model:

Field	Type	Description	Example	Required
content	Any	Content of configuration file.		True

Read

Read the data of all tbe available configurations with the following REST call:

GET /configurations

without request body.

The output is a JSON dictionary with the following mappings:

• key: Configuration ID;

• value: Configurations Output Model.

Read a single configuration with the following REST call:

GET /configurations/{string:id}

without the request body.

Parameters

• id – indentifies the configuration to read.

Response Headers

• Content-Type – application/json

The output is the Configurations Output Model in JSON format.

Update

To update the values of multiple configurations at the same time it is possible to use the following REST call:

POST /configurations

with the request body as a JSON dictionary with the following mappings:

• key: Configuration ID;

• value: any possible value.

Request Headers

• Content-Type – application/json

Response Headers

• Content-Type – application/json

The output is the a JSON dictionary with the following mappings:

• key: Configuration ID

• value: Action Model

To update a single configuration use the following REST call:

POST /configurations/{string:id}

with the request body as JSON dictionary of any possible value.

Parameters

• id – indentifies the configuration to update.

Request Headers

• Content-Type – application/json

Response Headers

• Content-Type – application/json

The output is the Action Model in JSON format.