Configuration File API

These endpoints allow to set properties in the BPC related Karaf properties file: etc/de.virtimo.bpc.core.cfg

Method Endpoint

Method	Endpoint
`PUT`	`/cxf/bpc-core/configuration/local/{propertyName}`
Description Sets a property in the local BPC related Karaf properties file: `etc/de.virtimo.bpc.core.cfg`. Required Role and Right: Role : `SERVER_ADMIN` Right : `SERVER_SET_LOCAL_PROPERTY`
Path Parameters `propertyName` the name of the property
Query Parameters `value` the value of the property `type` the type of the property `force` by default only existing properties can be updated, set to `true` to add new ones
Returns HTTP Status Code `200`: OK Content-Type `application/json`
Required Access Rights Can be used without a user session.
`PUT`	`/cxf/bpc-core/configuration/server/{serverUUID}/{propertyName}`
Description Sets a property in the remote BPC related Karaf properties file: `etc/de.virtimo.bpc.core.cfg`.
Path Parameters `serverUUID` the UUID of the remote BPC server `propertyName` the name of the property
Query Parameters `value` the value of the property `type` the type of the property `force` by default only existing properties can be updated, set to `true` to add new ones
Returns The response of the remote BPC. HTTP Status Code `200`: OK Content-Type `application/json`
Required Access Rights The logged in user, API Key or access token must have either the following role or right. Role : `SERVER_ADMIN` Right : `SERVER_SET_REMOTE_PROPERTY`

/cxf/bpc-core/configuration/local/{propertyName}

Description

Sets a property in the local BPC related Karaf properties file: etc/de.virtimo.bpc.core.cfg.

Required Role and Right:

Path Parameters

Query Parameters

value: the value of the property
type: the type of the property
force: by default only existing properties can be updated, set to true to add new ones

Returns

HTTP Status Code

Content-Type

Required Access Rights

Can be used without a user session.

/cxf/bpc-core/configuration/server/{serverUUID}/{propertyName}