| Table of Contents |
OOF/PCI Create/Update API
| Interface Defintion | Description |
|---|---|
URI | https://{host}:{port}/api/oof/v1/route |
Operation Type | POST |
Content-Type | application/json |
Request Header
| Header Name | Required? | Description |
|---|---|---|
Accept | N | Determines the format of the body of the response. Valid value is “application/json” |
Authorization | Y | Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned. |
Content-Type | Y | Determines the format of the request content. Only application/json is supported. |
Content-Length | N | Number of bytes in the body of the request. Note that content length is limited to 1 MB. |
Request Body
| Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
requestInfo | Y | 1 | RequestInfo Object | The content of the RequestInfo object. | |
RequestInfo Object
SDNC - OOF:
Calculate Route
Type : POST
URL : /v1/route
Payload:
{
"srcPort":
{
"src-access-topology-id": "Topo113",
"src-access-client-id": "clientU12",
"src-access-provider-id": "VDF1234",
"src-access-node-id": "Node123",
"src-access-ltp-id": "1345"
},
"dstPort":
{
"dst-access-topology-id": "Topo3421",
"dst-access-client-id": "clientD123",
"dst-access-provider-id": "VDF3214",
"dst-access-node-id": "node323",
"dst-access-ltp-id": "3452"
}
}
•Normal response codes:
-200,
-2XX
•Error response codes:
-badRequest(400),
-unauthorized (401),
-internalServerError(500)'
Response:
{
"VPNs":[
{
"access-topology-id": ”Topo123”,
"access-client-id": “client-123”,
"access-provider-id": “provider-123”,
"access-node-id": “node-123”,
"src-access-ltp-id": “ltp-src-123”,
"dst-access-ltp-id": “ltp-dst-123”
}
]
}
OOF- AAI for retrieving topology information:
1. Get the logical links as “operation-status = Up”
Method: GET URL: https://<AAI host>:<AAI port>/aai/v14/network/logical-links?operation-status="Up"
returns logical-links []
2. query for the name of the p-interface from the logical link.
logical-links [].get[0].relationship-list[0].relationship.relationship-key: "p-interface.interface-name"."relationship-value": "some name”
3. Search for the name of the pnffrom the urlof the p-interface and compare with the request from SDNC
4. Fill the corresponding ingress and e-gressof the TP info and send the response back to SDNC