#Swagger Specification for POMBA Common Model ## HTTP://host:port/XXXcontextbuilder POMBA Audit Context Builder API **Version** 1.4.0-SNAPSHOT [**Terms of Service**]() # APIs ## /service/context ### GET <a id="getContext">Get Common model context from Context Builder</a> #### Request ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>X-FromAppId</th> <td>header</td> <td>yes</td> <td> ID that identifies calling application </td> <td> - </td> <td>string </td> </tr> <tr> <th>X-TransactionId</th> <td>header</td> <td>no</td> <td> Transaction ID published by the calling application </td> <td> - </td> <td>string </td> </tr> <tr> <th>serviceInstanceId</th> <td>query</td> <td>yes</td> <td> Instance ID of the audited service </td> <td> - </td> <td>string </td> </tr> <tr> <th>modelVersionId</th> <td>query</td> <td>no</td> <td> Unique identifier of a SDC model version </td> <td> - </td> <td>string </td> </tr> <tr> <th>modelInvariantId</th> <td>query</td> <td>no</td> <td> Global identifier of each SDC asset </td> <td> - </td> <td>string </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | successful operation | <a href="#/definitions/ModelContext">ModelContext</a>| | 400 | Bad request | - | | 401 | Unauthorized | - | | 404 | Service not available | - | | 500 | Unexpected Runtime error | - | # Definitions ## <a name="/definitions/Attribute">Attribute</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>Name of the attribute</td> <td></td> </tr> <tr> <td>value</td> <td> string </td> <td>optional</td> <td>Value of the attribute</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>Data Quality indicator of the attribute</td> <td></td> </tr> </table> ## <a name="/definitions/DataQuality">DataQuality</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>status</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>errorText</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LInterface">LInterface</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>port</td> <td> <a href="#/definitions/Port">Port</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/LogicalLink">LogicalLink</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ModelContext">ModelContext</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>service</td> <td> <a href="#/definitions/Service">Service</a> </td> <td>optional</td> <td>Service object of the model</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>Data Quality indicator</td> <td></td> </tr> <tr> <td>networkList</td> <td> array[<a href="#/definitions/Network">Network</a>] </td> <td>optional</td> <td>List of networks associated with the service instance</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>List of attributes</td> <td></td> </tr> <tr> <td>vnfs</td> <td> array[<a href="#/definitions/VNF">VNF</a>] </td> <td>optional</td> <td>List of VNF associated with the service instance</td> <td></td> </tr> <tr> <td>pnfs</td> <td> array[<a href="#/definitions/PNF">PNF</a>] </td> <td>optional</td> <td>List of PNF associated with the service instance</td> <td></td> </tr> </table> ## <a name="/definitions/Network">Network</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>networkPolicies</td> <td> array[<a href="#/definitions/NetworkPolicy">NetworkPolicy</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/NetworkPolicy">NetworkPolicy</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PInterface">PInterface</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>physicalLinkList</td> <td> array[<a href="#/definitions/PhysicalLink">PhysicalLink</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>port</td> <td> <a href="#/definitions/Port">Port</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PNF">PNF</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>networks</td> <td> array[<a href="#/definitions/Network">Network</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pinterfaceList</td> <td> array[<a href="#/definitions/PInterface">PInterface</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PhysicalLink">PhysicalLink</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Port">Port</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Pserver">Pserver</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>logicalLinkList</td> <td> array[<a href="#/definitions/LogicalLink">LogicalLink</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pinterfaceList</td> <td> array[<a href="#/definitions/PInterface">PInterface</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Service">Service</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/VFModule">VFModule</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelCustomizationUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>maxInstances</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>minInstances</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>vms</td> <td> array[<a href="#/definitions/VM">VM</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>networks</td> <td> array[<a href="#/definitions/Network">Network</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/VM">VM</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>linterfaceList</td> <td> array[<a href="#/definitions/LInterface">LInterface</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pserver</td> <td> <a href="#/definitions/Pserver">Pserver</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/VNF">VNF</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>vfModules</td> <td> array[<a href="#/definitions/VFModule">VFModule</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>vnfcs</td> <td> array[<a href="#/definitions/VNFC">VNFC</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>networks</td> <td> array[<a href="#/definitions/Network">Network</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/VNFC">VNFC</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>uuid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelVersionID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>modelInvariantUUID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dataQuality</td> <td> <a href="#/definitions/DataQuality">DataQuality</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>attributes</td> <td> array[<a href="#/definitions/Attribute">Attribute</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table>