Deployment API

The deployment functionality allows to transfer configurations of one BPC instance to another.

Method Endpoint

GET

/cxf/bpc-deployment/deployment/systems

Description

Get a list of all deployment systems (= backend connections of type 'deployment_system').

Returns

The requested data as JSON

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_GET_SYSTEMS

GET

/cxf/bpc-deployment/deployment/diff

Description

Get the diff of a source deployment system or snapshot and a target deployment system.

Query Parameters

source

the backend connection ID of the source deployment system. Not necessary when snapshot is used.

target

the backend connection ID of the target deployment system

snapshot

name of an OpenSearch snapshot that should be used instead of a source deployment system. Not necessary when source is used.

Returns

The requested data as JSON.

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_GET_DIFF

POST

/cxf/bpc-deployment/deployment/diff/settings

Description

Get the diff of deployment source and target settings provided in the body content.

Body:

{
  "source": [ BPC settings, ... ],
  "target": [ BPC settings, ... ]
}

Returns

The diff as JSON

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_GET_SETTINGS_DIFF

POST

/cxf/bpc-deployment/deployment/deploy

Description

Deploys the body content to the target system.

Consumes

  • application/json

Query Parameters

deploymentSourceId

the backend connection ID of the deployment source system

deploymentTargetId

the backend connection ID of the deployment target system

enableMaintenanceMode

true in case the maintenance mode should be enabled on the target system, false if not. Default is false.

validate

true in case the standard settings validation should be performed on the target system, false if it should be skipped. Default is true.

Returns

The deployment processing instructions as JSON file to download when the deploymentTargetId is set to @@@JSON@@@, otherwise the deployment response.

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

POST

/cxf/bpc-deployment/deployment/import

Description

Processes the deployment instructions provided by the body content.

Consumes

  • application/json

Query Parameters

enableMaintenanceMode

true in case the maintenance mode should be enabled, false if not. Default is false.

validate

true in case the standard settings validation should be performed, false if it should be skipped. Default is true.

Returns

HTTP Status Code

  • 200: Import done

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

POST

/cxf/bpc-deployment/deployment/bundles/download

Description

To download specific bundles (JAR/WAR files) by their IDs as mime multipart data.

Body:

[ IdOfBundle1, IdOfBundle2, ... ]

Consumes

  • application/json

Returns

The bundles as mime multipart data

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

GET

/cxf/bpc-deployment/deployment/bundles/download/{bundleId}

Description

To download a specific bundle (JAR/WAR files) by its ID.

Path Parameters

bundleId

the ID of the bundle to download

Returns

The bundle as data stream

HTTP Status Code

  • 200: OK

  • 404: Bundle was not found

  • 500: Bundle is not downloadable

Required Access Rights

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

  • Role : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

POST

/cxf/bpc-deployment/deployment/bundles/import

Description

Imports the bundles provided by multipart form data.

curl example
curl -X POST \
     -H 'X-APIKey: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' \
     -H 'X-InitiatedByUser: inubit' \
     -H 'X-InitiatedFromServerName: localhost' \
     -H 'X-InitiatedFromServerUUID: inubit-installer' \
     -F file=@test.jar \
     -F file=@test.war \
     'http://localhost:8181/cxf/bpc-deployment/deployment/bundles/import'

Consumes

  • multipart/form-data

Returns

HTTP Status Code

  • 200: Bundles import done

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

POST

/cxf/bpc-deployment/deployment/bundles/import/extjs

Description

Special endpoint to import a single bundle from ExtJS by using multipart form data.

Consumes

  • multipart/form-data

Returns

ExtJS conform status info with the filename

HTTP Status Code

  • 200: OK

  • 500: Upload not possible

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_EXECUTE

POST

/cxf/bpc-deployment/deployment/migrate

Description

Deployment diffs can only be done when both systems use the same model version. This endpoint converts the model configurations provided in the content body to the model version of this installation.

Consumes

  • application/json

Returns

The migrated module configurations as JSON

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_GET_MIGRATED_MODULES_CONFIG

POST

/cxf/bpc-deployment/deployment/index/{index}/copy

Description

Copy an index from one deployment system to another.

Path Parameters

index

the name of the index to copy

Query Parameters

source

the backend connection ID of the deployment source system

target

the backend connection ID of the deployment target system

blocksize

the block size used to read that number of documents from the source system at once (set too high = out of memory; too low = bad performance). Default is 2500.

deleteOnTarget

true to delete an existing index on the target system, false to fail if an index already exists. Default is false.

Returns

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_COPY_INDEX

GET

/cxf/bpc-deployment/deployment/indices

Description

Get a list of OpenSearch indices.

Returns

the index infos

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_LIST_INDICES

GET

/cxf/bpc-deployment/deployment/index/{index}/info

Description

Get some infos of an index to deploy.

Path Parameters

index

the real name of the index, no alias allowed

Returns

the index info with its settings and mapping

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_DOWNLOAD_INDEX

GET

/cxf/bpc-deployment/deployment/index/{index}/download

Description

Downloads the first block of data from the given index.

Path Parameters

index

the name of the index

Query Parameters

blocksize

the block size. Default is 2500.

Returns

the requested data

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_DOWNLOAD_INDEX

GET

/cxf/bpc-deployment/deployment/index/{index}/download/{scrollid}

Description

Downloads the subsequent block of data from the given index.

Path Parameters

index

the name of the index

scrollid

the scroll identifier

Returns

the requested data

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_DOWNLOAD_INDEX

DELETE

/cxf/bpc-deployment/deployment/index/{index}/download/{scrollid}

Description

To release a no longer used scroll identifier. This helps OpenSearch to release resources much faster.

Path Parameters

index

the index name

scrollid

the scroll identifier to release

Returns

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_DOWNLOAD_INDEX

POST

/cxf/bpc-deployment/deployment/index/{index}/prepare

Description

Prepares an index for upload. Creates it with the given settings and mapping.

Body:

{
  "settings": settings as JSON object,
  "mapping": mapping as JSON object
}

Consumes

  • application/json

Path Parameters

index

the name of the index (must be an alias)

Query Parameters

delete_existing

true to delete an existing index, false to throw an error when it already exists. Default is false.

Returns

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_UPLOAD_INDEX

POST

/cxf/bpc-deployment/deployment/index/{index}/upload

Description

Feed an index with the uploaded data.

Body:

[
  {"id": document id 1, "source": JSON data 1},
  {"id": document id 2, "source": JSON data 2},
  ...
]

Consumes

  • application/json

Parameters Path

index

the name of the index (must be an alias)

Returns

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 : DEPLOYMENT_USER

  • Right : DEPLOYMENT_UPLOAD_INDEX
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen