This page captures requirements for POMBA context builders to follow so they can plug into the POMBA framework and enable audit reports from new data sources. Context builders are standalone pieces of software that expose the context builder API.
API
All context builders must support a REST API with the following features.
GET http://<host>:<port>/<server.contextPath>/service/context?<parameters>
| Parameter | Description |
|---|---|
| ServiceInstanceId | Instance id of the service being audited |
| ModelVersionId | Model UUID as published in service model metadata |
| ModelInvariantId | SDC generated invariant id as published in service model metadata |
| Header Name | Mandatory? | Description |
|---|---|---|
| X-TransactionId | N | Unique transaction ID. If it is not sent it will be automatically generated by on a request receipt. |
| X-FromAppId | Y | For auditing purpose each component calling API should identify itself by sending its identity. If this header with non-null value is not supplied the HTTP Request will be rejected with '400 Bad Syntax’ response code. |
| Accept | N | Determines the format of the body of the response. Valid values are : “application/json” |
Inputs
service instance id
Outputs
JSON compliant to the following data model.
Error Handling
coming soon.