BOM API

The Bill-of-Materials (BOM) is an aggregation of all software dependencies the BPC modules/bundles have. These endpoints allow to list, retrieve, download and force-reload all available BOMs.

To get listed the modules/bundles must place their BOM to the file /META-INF/bom.json.

Method Endpoint

Method	Endpoint
`DELETE`	`/cxf/bpc-core/bom`
Description Forces a re-load of the BOMs.
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 : `BOMS_ADMIN` Right : `BOMS_RELOAD`
`GET`	`/cxf/bpc-core/bom/all`
Description Get the BOMs of all BPC bundles.
Returns The requested BOMs. Example response: `{ "SYMBOLIC_NAME_BUNDLE_1": BOM_FILE_CONTENT_1, "SYMBOLIC_NAME_BUNDLE_2": BOM_FILE_CONTENT_2, "SYMBOLIC_NAME_BUNDLE_n": BOM_FILE_CONTENT_n }` `SYMBOLIC_NAME_BUNDLE_1` etc. is the symbolic name of the BPC bundle `BOM_FILE_CONTENT_1` etc. is the content of the `/META-INF/bom.json` file HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`GET`	`/cxf/bpc-core/bom/bundles`
Description Get just the symbolic names of BPC bundles with BOMs.
Returns The requested list. Example response: `[ "SYMBOLIC_NAME_BUNDLE_1", "SYMBOLIC_NAME_BUNDLE_2", "SYMBOLIC_NAME_BUNDLE_n" ]` HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`GET`	`/cxf/bpc-core/bom/bundle/{symbolicNameOfBundle}`
Description Get the BOM of a specific BPC bundle by its symbolic name.
Path Parameter `symbolicNameOfBundle` the symbolic name of the bundle to get the BOM for
Returns The content of the `/META-INF/bom.json` file HTTP Status Code `200` : OK `404` : Requested BOM not found Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.
`GET`	`/cxf/bpc-core/bom/bundle/download/{symbolicNameOfBundle}`
Description Download the BOM of a specific BPC bundle by its symbolic name.
Path Parameter `symbolicNameOfBundle` the symbolic name of the bundle to download the BOM for
Returns The content of the `/META-INF/bom.json` file HTTP Status Code `200` : OK `404` : Requested BOM not found Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.

DELETE

/cxf/bpc-core/bom

Description

Forces a re-load of the BOMs.

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 : BOMS_ADMIN
Right : BOMS_RELOAD

GET

/cxf/bpc-core/bom/all

Description

Get the BOMs of all BPC bundles.

Returns

The requested BOMs. Example response:

{
  "SYMBOLIC_NAME_BUNDLE_1": BOM_FILE_CONTENT_1,
  "SYMBOLIC_NAME_BUNDLE_2": BOM_FILE_CONTENT_2,
  "SYMBOLIC_NAME_BUNDLE_n": BOM_FILE_CONTENT_n
}

SYMBOLIC_NAME_BUNDLE_1 etc. is the symbolic name of the BPC bundle
BOM_FILE_CONTENT_1 etc. is the content of the /META-INF/bom.json file

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

GET

/cxf/bpc-core/bom/bundles

Description

Get just the symbolic names of BPC bundles with BOMs.

Returns

The requested list. Example response:

[
  "SYMBOLIC_NAME_BUNDLE_1",
  "SYMBOLIC_NAME_BUNDLE_2",
  "SYMBOLIC_NAME_BUNDLE_n"
]

HTTP Status Code

200 : OK

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

GET

/cxf/bpc-core/bom/bundle/{symbolicNameOfBundle}

Description

Get the BOM of a specific BPC bundle by its symbolic name.

Path Parameter

symbolicNameOfBundle: the symbolic name of the bundle to get the BOM for

Returns

The content of the /META-INF/bom.json file

HTTP Status Code

200 : OK
404 : Requested BOM not found

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.

GET

/cxf/bpc-core/bom/bundle/download/{symbolicNameOfBundle}

Description

Download the BOM of a specific BPC bundle by its symbolic name.

Path Parameter

symbolicNameOfBundle: the symbolic name of the bundle to download the BOM for

Returns

The content of the /META-INF/bom.json file

HTTP Status Code

200 : OK
404 : Requested BOM not found

Content-Type

application/json

Required Access Rights

A logged in user or API Key is required.