{
    "tags": "unit-number",
    "name": "unit-number",
    "property": {
      "description": "unit-number",
      "type": "string"
    },
    "updated-by": "adetalhouet",
    "sources": {
      "input": {
        "type": "source-input"
      }
    }
  }

{
  "tags": "prefix-id",
  "name": "prefix-id",
  "property" :{
    "description": "prefix-id",
    "type": "integer"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "default": {
      "type": "source-default"
    }
  }
}

primary-config-data via rest source type

In this example, we're making a POST request to an IPAM system with no payload.

Some ingredients are required to perform the query, in this case, $prefixId. Hence It is provided as an input-key-mapping and defined as a key-dependencies. Please refer to the modeling guideline for more in depth understanding.

As part of this request, the expected response will be as bellow. What is of interest is the address field, as this is what we're trying to resolve.

{
    "id": 4,
    "address": "192.168.10.2/32",
    "vrf": null,
    "tenant": null,
    "status": 1,
    "role": null,
    "interface": null,
    "description": "",
    "nat_inside": null,
    "created": "2018-08-30",
    "last_updated": "2018-08-30T14:59:05.277820Z"
}

To tell the resolution framework what is of interest in the response, the path property can be used, which uses JSON_PATH, to get the value.

{
    "tags" : "oam-local-ipv4-address",
    "name" : "create_netbox_ip",
    "property" : {
      "description" : "netbox ip",
      "type" : "string"
    },
    "updated-by" : "adetalhouet",
    "sources" : {
      "primary-config-data" : {
        "type" : "source-rest",
        "properties" : {
          "type" : "JSON",
          "verb" : "POST",
          "endpoint-selector" : "ipam-1",
          "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/",
          "path" : "/address",
          "input-key-mapping" : {
            "prefixId" : "prefix-id"
          },
          "output-key-mapping" : {
            "address" : "address"
          },
          "key-dependencies" : [ "prefix-id" ]
        }
      }
    }
  }

primary-aai-data via rest source type

{
  "name": "vf-module-type",
  "tags": "vf-module-type",
  "property": {
    "description": "vf-module-type",
    "type": "string"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "primary-db": {
      "type": "source-primary-db",
      "properties": {
        "type": "SQL",
        "query": "select sdnctl.demo.value as value from sdnctl.demo where sdnctl.demo.id=:vfmoduleid",
        "input-key-mapping": {
          "vfmoduleid": "vf-module-number"
        },
        "output-key-mapping": {
          "vf-module-type": "value"
        },
        "key-dependencies": [
          "vf-module-number"
        ]
      }
    }
  }
}

{
  "tags": "interface-description",
  "name": "interface-description",
  "property": {
    "description": "interface-description",
    "type": "string"
  },
  "updated-by": "adetalhouet",
  "sources": {
    "capability": {
      "type": "source-capability",
      "properties": {
        "script-type": "jython",
        "script-class-reference": "Scripts/python/DescriptionExample.py",
        "instance-dependencies": [],
        "key-dependencies": [
          "vf-module-type"
        ]
      }
    }
  }
}

#  Copyright (c) 2019 Bell Canada.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.

from abstract_ra_processor import AbstractRAProcessor
from blueprint_constants import *
from java.lang import Exception as JavaException

class DescriptionExample(AbstractRAProcessor):

    def process(self, resource_assignment):
        try:
            # get key-dependencies value
            value = self.raRuntimeService.getStringFromResolutionStore("vf-module-type")
            
            # logic based on key-dependency outcome
            result = ""
            if value == "vfw":
                result = "This is the Virtual Firewall entity"
            elif value == "vsn":
                result = "This is the Virtual Sink entity"
            elif value == "vpg":
                result = "This is the Virtual Packet Generator"

            # set the value of resource getting currently resolved
            self.set_resource_data_value(resource_assignment, result)

        except JavaException, err:
          log.error("Java Exception in the script {}", err)
        except Exception, err:
          log.error("Python Exception in the script {}", err)
        return None

    def recover(self, runtime_exception, resource_assignment):
        print self.addError(runtime_exception.getMessage())
        return None

{
    "id": 4,
    "address": "192.168.10.2/32",
    "vrf": null,
    "tenant": null,
    "status": 1,
    "role": null,
    "interface": null,
    "description": "",
    "nat_inside": null,
    "created": "2018-08-30",
    "last_updated": "2018-08-30T14:59:05.277820Z"
}

{
  "version": "1.0.0",
  "description": "This is Netbox IP Data Type",
  "properties": {
    "address": {
      "required": true,
      "type": "string"
    },
    "id": {
      "required": true,
      "type": "integer"
    }
  },
  "derived_from": "tosca.datatypes.Root"
}

{
    "tags" : "oam-local-ipv4-address",
    "name" : "create_netbox_ip",
    "property" : {
      "description" : "netbox ip",
      "type" : "dt-netbox-ip"
    },
    "updated-by" : "adetalhouet",
    "sources" : {
      "primary-config-data" : {
        "type" : "source-rest",
        "properties" : {
          "type" : "JSON",
          "verb" : "POST",
          "endpoint-selector" : "ipam-1",
          "url-path" : "/api/ipam/prefixes/$prefixId/available-ips/",
          "path" : "",
          "input-key-mapping" : {
            "prefixId" : "prefix-id"
          },
          "output-key-mapping" : {
			"address" : "address",
            "id" : "id"
          },
          "key-dependencies" : [ "prefix-id" ]
        }
      }
    }
  }

{
  "workflows": {
    "resource-assignment": {
      "steps": {
        "resource-assignment-process": {
          "description": "Resource Assign Workflow",
          "target": "resource-assignment-process"
        }
      },
      "inputs": {
        "artifact-name": {
          "required": true,
          "type": "string"
        },
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "resource-assignment-properties": {
          "description": "Dynamic PropertyDefinition for workflow(resource-assignment).",
          "required": true,
          "type": "dt-resource-assignment-properties"
        }
      },
      "outputs": {
        "dry-run": {
          "type": "json",
          "value": {
            "get_attribute": [
              "SELF",
              "assignment-params"
            ]
          }
        }
      }
    }
  }
}

{
  "workflows": {
    "config-assign": {
      "steps": {
        "config-assign-process": {
          "description": "Config Assign Workflow",
          "target": "config-assign-process"
        }
      },
      "inputs": {
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "config-assign-properties": {
          "description": "Dynamic PropertyDefinition for workflow(config-assign).",
          "required": true,
          "type": "dt-config-assign-properties"
        }
      },
      "outputs": {
        "dry-run": {
          "type": "json",
          "value": {
            "get_attribute": [
              "SELF",
              "assignment-params"
            ]
          }
        }
      }
    }
  }
}

{
  "workflow": {
    "config-deploy": {
      "steps": {
        "config-deploy": {
          "description": "Config Deploy using Python (Netconf) script",
          "target": "config-deploy-process"
        }
      },
      "inputs": {
        "resolution-key": {
          "required": true,
          "type": "string"
        },
        "config-deploy-properties": {
          "description": "Dynamic PropertyDefinition for workflow(config-deploy).",
          "required": true,
          "type": "dt-config-deploy-properties"
        }
      }
    }
  }
}