This section will show how to view the main API's used for vCPE configuration at the Service and VNF level through DG builder and then test with them using the SLI-API: Execute-Graph API.

Overview of GENERIC-RESOURCE-APIs

The GENERIC-RESOURCE-APIs are the rpc's described in the SDNC yang model GENERIC-RESOURCE-API.yang. These API's allow interaction with SDNC for generic services and vnfs where the payload is an array of name/value pairs that can be processed by SDNC directed graphs. Since they are generic they are very flexible but can be a bit more complex to deal with. A custom yang model can define rpc that fine tune the input parameters and include a network data model that is more logical.

Service-Topology-Operation

The service-topology-operation rpc is used to create an initial service instance ID and do varous service level resource assignments. There are several sub-graphs used in the directed graph

Service-Topology-Operation (main)

Notice that this DG has 4 sub DG's

validate-service-input
service-topology-operation-assign
service-topology-operation-deactivate
service-topology-operation-delete

Here are json string forms of the directed graphs that can be imported into DGBuilder. You can use them for testing if your instance doesn't have them loaded yet. Simply SAVE , Upload xml and Activate the DG. You will need the main DG, the validate-service-input and the service-toplogy-operation-assign DG to test the sunny day thread through the API.

GENERIC-RESOURCE-API:service-topology-operation

GENERIC-RESOURCE-API:validate-service-input

GENERCI-RESOURCE-API:service-topology-assign

VNF-Toplogy-Operation

VNF-Toplogy-Operation (Main)

The vnf-topology-operation has several sub DGs. These DGs also have sub DGs that are called for re-useable functions like generate-unique-name that is used for assigning resource names according to engineering rules like encoded hostnames.

validate-vnf-input
vnf-topology-operation-assign
vnf-topology-operation-activate
vnf-topology-operation-deactivate
vnf-topology-operation-delete

vnf-topology-operation

Testing the Directed Graphs

Testing Service-Topology-Operation with SLI-API

Use the SLI-API if your SDNC instance doesn't have the GENERIC-RESOURCE-API karaf feature bundle loaded (it will be on apidoc/explorer if it is loaded). Pre-Amsterdam release versions of ONAP SDNC don't have the GENERIC-RESOURCE-API.

Copy the following json body and use in the apidoc/explorer interface on the SDNC

http://10.0.7.1:8282/apidoc/explorer/index.html#!/SLI-API(2016-11-10)/

Paste the string into the input box for the SLI-API:execute-graph

service-topology-operation:sli-api-input

{
"input": {
"mode": "sync",
"module-name": "GENERIC-RESOURCE-API",
"rpc-name": "service-topology-operation",
"sli-parameter": [
{
"parameter-name": "service-data.request-information.order-version",
"string-value": "1.0"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[1].key.name",
"string-value": "Some name1"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-instance-name",
"string-value": "0003"
},
{
"parameter-name": "service-topology-operation-input.request-information.order-number",
"string-value": "0001"
},
{
"parameter-name": "service-data.service-information.global-customer-id",
"string-value": "0001"
},
{
"parameter-name": "service-data.sdnc-request-header.svc-request-id",
"string-value": "10001"
},
{
"parameter-name": "service-topology-operation-input.request-information.request-id",
"string-value": "10001"
},
{
"parameter-name": "service-data.service-information.ecomp-model-information.model-uuid",
"string-value": "0000-0000-0000000"
},
{
"parameter-name":1.0"
},
{
"parameter-name": "service-data.request-information.order-number",
"string-value": "10001"
},
{
"parameter-name": "service-topology-operation-input.request-information.request-action",
"string-value": "CreateServiceInstance"
},
{
"parameter-name": "service-topology-operation-input.sdnc-request-header.svc-notification-url",
"string-value": "Some svc-notification-url"
},
{
"parameter-name": "service-data.service-request-input.service-input-parameters.param_length",
"string-value": "1"
},
{
"parameter-name": "service-topology-operation-input.request-information.order-version",
"string-value": "1.0"
},
{
"parameter-name": "service-topology-operation-input.service-information.ecomp-model-information.model-invariant-uuid",
"string-value": "S000-000-00000"
},
{
"parameter-name": "service-topology-operation-input.service-information.ecomp-model-information.model-customization-uuid",
"string-value": "S000-000-00000"
},
{
"parameter-name": "service-topology-operation-input.service-information.ecomp-model-information.model-name",
"string-value": "Some model-name"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param_length",
"string-value": "2"
},
{
"parameter-name": "service-topology-operation-input.service-information.global-customer-id",
"string-value": "10001"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[0].key.name",
"string-value": "Some name"
},
{
"parameter-name": "service-topology-operation-input.sdnc-request-header.svc-action",
"string-value": "assign"
},
{
"parameter-name": "service-topology-operation-input.request-information.source",
"string-value": "so"
},
{
"parameter-name": "service-data.service-request-input.service-instance-name",
"string-value": "Some service-instance-name"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[0].value",
"string-value": "Some value"
},
{
"parameter-name": "service-data.sdnc-request-header.svc-action",
"string-value": "Reserve"
},
{
"parameter-name": "service-data.request-information.notification-url",
"string-value": "Some notification-url"
},
{
"parameter-name": "service-topology-operation-input.service-information.subscription-service-type",
"string-value": "Some subscription-service-type"
},
{
"parameter-name": "service-topology-operation-input.service-information.ecomp-model-information.model-version",
"string-value": "Some model-version"
},
{
"parameter-name": "service-topology-operation-input.service-information.ecomp-model-information.model-uuid",
"string-value": "Some model-uuid"
},
{
"parameter-name": "service-data.service-request-input.service-input-parameters.param[0].value",
"string-value": "Some value"
},
{
"parameter-name": "service-data.service-information.service-instance-id",
"string-value": "10001"
},
{
"parameter-name": "service-data.request-information.source",
"string-value": "so"
},
{
"parameter-name": "service-topology-operation-input.service-information.subscriber-name",
"string-value": "Some subscriber-name1"
},
{
"parameter-name": "service-data.service-information.ecomp-model-information.model-name",
"string-value": "Some model-name"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[1].key"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[0].name",
"string-value": "Some name"
},
{
"parameter-name": "service-data.service-request-input.service-input-parameters.param[0].key"
},
{
"parameter-name": "service-data.service-request-input.service-input-parameters.param[0].name",
"string-value": "Some name"
},
{
"parameter-name": "service-data.request-information.request-action",
"string-value": "CreateNetworkInstance"
},
{
"parameter-name": "service-data.sdnc-request-header.svc-notification-url",
"string-value": "Some svc-notification-url"
},
{
"parameter-name": "service-topology-operation-input.sdnc-request-header.svc-request-id",
"string-value": "Some svc-request-id"
},
{
"parameter-name": "service-data.service-information.service-id",
"string-value": "Some service-id"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[1].name",
"string-value": "Some name1"
},
{
"parameter-name": "service-data.service-information.subscription-service-type",
"string-value": "Some subscription-service-type"
},
{
"parameter-name": "service-data.request-information.request-id",
"string-value": "Some request-id"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[0].key"
},
{
"parameter-name": "service-topology-operation-input.service-information.service-id",
"string-value": "Some service-id"
},
{
"parameter-name": "service-data.service-information.subscriber-name",
"string-value": "Some subscriber-name"
},
{
"parameter-name": "service-topology-operation-input.service-request-input.service-input-parameters.param[1].value",
"string-value": "Some value1"
},
{
"parameter-name": "service-topology-operation-input.request-information.notification-url",
"string-value": "Some notification-url"
},
{
"parameter-name": "currentGraph"
},
{
"parameter-name": "service-data.service-request-input.service-input-parameters.param[0].key.name",
"string-value": "Some name"
},
{
"parameter-name": "service-data.service-information.ecomp-model-information.model-invariant-uuid",
"string-value": "Some model-invariant-uuid"
},
{
"parameter-name": "service-topology-operation-input.service-information.service-instance-id",
"string-value": "Some service-instance-id"
},
{
"parameter-name": "service-data.service-information.ecomp-model-information.model-customization-uuid",
"string-value": "Some model-customization-uuid"
}
]
}
}

Testing with the GENERIC-RESOURCE-API

Copy the following json body and use in the apidoc/explorer interface on the SDNC

http://10.0.7.1:8282/apidoc/explorer/index.html#!/GENERIC-RESOURCE-API/

Paste the string into the input box for the GENERIC-RESOURCE-API:service-topology-operation

input for generic-resource-api:service-topology-operation

PASTE IN service-topology-operation assign

ONAP Wiki

Understanding the the GENERIC-RESOURCE-APIs