Lookup Joins API

Lookup joins are used in the replication process to replicate data from Databases, where the replicated data lies in multiple tables.

Method Endpoint

Method	Endpoint
`POST`	`/cxf/bpc-core/configuration/lookupjoins/refresh`
Description Refresh the lookup joins data of all replication jobs and log services related indices.
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 : `LOOKUP_JOINS_ADMIN` Right : `LOOKUP_JOINS_REFRESH_ALL`
`POST`	`/cxf/bpc-core/configuration/lookupjoins/refresh/replicationjob/{replicationJobId}`
Description Refresh the lookup joins data of a replication job related index.
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 : `LOOKUP_JOINS_ADMIN` Right : `LOOKUP_JOINS_REFRESH`
`POST`	`/cxf/bpc-core/configuration/lookupjoins/refresh/logservice/{logServiceId}`
Description Refresh the lookup joins data of a log service related index.
Path Parameter `logServiceId` the ID of the log service
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 : `LOOKUP_JOINS_ADMIN` Right : `LOOKUP_JOINS_REFRESH`
`GET`	`/cxf/bpc-core/configuration/lookupjoins/clearcaches`
Description Clears the internally used lookup joins caches.
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 : `LOOKUP_JOINS_ADMIN` Right : `LOOKUP_JOINS_CLEAR_CACHE`

POST

/cxf/bpc-core/configuration/lookupjoins/refresh

Description

Refresh the lookup joins data of all replication jobs and log services related indices.

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 : LOOKUP_JOINS_ADMIN
Right : LOOKUP_JOINS_REFRESH_ALL

POST

/cxf/bpc-core/configuration/lookupjoins/refresh/replicationjob/{replicationJobId}

Description

Refresh the lookup joins data of a replication job related index.

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 : LOOKUP_JOINS_ADMIN
Right : LOOKUP_JOINS_REFRESH

POST

/cxf/bpc-core/configuration/lookupjoins/refresh/logservice/{logServiceId}

Description

Refresh the lookup joins data of a log service related index.

Path Parameter

logServiceId: the ID of the log service

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 : LOOKUP_JOINS_ADMIN
Right : LOOKUP_JOINS_REFRESH

GET

/cxf/bpc-core/configuration/lookupjoins/clearcaches

Description

Clears the internally used lookup joins caches.

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 : LOOKUP_JOINS_ADMIN
Right : LOOKUP_JOINS_CLEAR_CACHE