Server API

These endpoints allow to list all BPC instances in a cluster and to retrieve information about a specific instance.

Please be sure that every BPC server in the cluster uses a unique UUID. This is done by the setting de.virtimo.bpc.core.karaf.uuid which can found in the config file [karaf]/etc/de.virtimo.bpc.core.cfg.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-core/server/list`
Description Get the UUIDs of the BPC servers in the cluster.
Returns The requested data as JSON. HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `SERVER_ADMIN` Right : `SERVER_GET_UUIDS`
`GET`	`/cxf/bpc-core/server/{uuid}/info`
Description Get detailed info of a BPC server in the cluster.
Path Parameter `uuid` the UUID of the BPC server to get the infos for
Returns The requested data as JSON. HTTP Status Code `200` : OK `404` : Requested server not found Content-Type `application/json`
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `SERVER_ADMIN` Right : `SERVER_GET_INFO`

GET

/cxf/bpc-core/server/list

Description

Get the UUIDs of the BPC servers in the cluster.

Returns

The requested data as JSON.

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : SERVER_ADMIN
Right : SERVER_GET_UUIDS