Replication API

These endpoints allow to control the replication from a Database to OpenSearch.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-core/replication/jobs/usingindex/{dataIndex}/monitor`
Description Get the replication jobs with runtime stats indexing into the given OpenSearch index. The response will be compact and used by the BPC monitor frontend. This endpoint has no access rights check currently, because it gets called from the frontend monitor.
Path Parameter `dataIndex` the name of the OpenSearch index
Returns The requested data as JSON HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights Can be used without a user session.
`PUT`	`/cxf/bpc-core/replication/{replicationJobId}/restart`
Description Restarts a replication job.
Path Parameter `replicationJobId` the ID of the replication job
Returns HTTP Status Code `200` : OK
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `REPLICATION_ADMIN` Right : `REPLICATION_JOB_RESTART`
`PUT`	`/cxf/bpc-core/replication/{replicationJobId}/start`
Description Forced start of a replication job.
Path Parameter `replicationJobId` the ID of the replication job
Returns HTTP Status Code `200` : OK
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `REPLICATION_ADMIN` Right : `REPLICATION_JOB_FORCED_START`
`PUT`	`/cxf/bpc-core/replication/{replicationJobId}/tailsync/start`
Description Manual start of a tail sync job.
Path Parameter `replicationJobId` the ID of the replication job
Returns HTTP Status Code `200` : OK
Required Access Rights The logged in user or API Key must have either the following role or right. Role : `REPLICATION_ADMIN` Right : `REPLICATION_JOB_TAILSYNC_START`

GET

/cxf/bpc-core/replication/jobs/usingindex/{dataIndex}/monitor

Description

Get the replication jobs with runtime stats indexing into the given OpenSearch index. The response will be compact and used by the BPC monitor frontend.

This endpoint has no access rights check currently, because it gets called from the frontend monitor.

Path Parameter

dataIndex: the name of the OpenSearch index

Returns

The requested data as JSON

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

Can be used without a user session.

PUT

/cxf/bpc-core/replication/{replicationJobId}/restart

Description

Restarts a replication job.

Path Parameter

replicationJobId: the ID of the replication job

Returns

HTTP Status Code

200 : OK

Required Access Rights

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

Role : REPLICATION_ADMIN
Right : REPLICATION_JOB_RESTART

PUT

/cxf/bpc-core/replication/{replicationJobId}/start

Description

Forced start of a replication job.

Path Parameter

replicationJobId: the ID of the replication job

Returns

HTTP Status Code

200 : OK

Required Access Rights

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

Role : REPLICATION_ADMIN
Right : REPLICATION_JOB_FORCED_START

PUT

/cxf/bpc-core/replication/{replicationJobId}/tailsync/start

Description

Manual start of a tail sync job.

Path Parameter

replicationJobId: the ID of the replication job

Returns

HTTP Status Code

200 : OK

Required Access Rights

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

Role : REPLICATION_ADMIN
Right : REPLICATION_JOB_TAILSYNC_START