Parameters

Operations can have parameters as a JSON object with the necessary data for the operation execution.

Normally the specific parameters of a operation will be the same for the both APIs (North and South). Nevertheless there are operations that can have different list of parameters for North and South APIs. They are showed below. In this section it is described how the parameters in operations has to be interpreted in both API sides.

To understand this we take the REBOOT_EQUIPMENT operation from the catalog as an example:

REBOOT_EQUIPMENT parameters JSON schema:

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string",
            "title": "Reboot Type",
            "enum": [
                "HARDWARE",
                "SOFTWARE"
            ],
            "default": "HARDWARE"
        }
    },
    "additionalProperties": false
}

North API invocation

The next example shows how the parameters has to be filled in the North API call:

South API invocation

The next example shows how the parameters will be received by the device through the south API call:

South API Parameters format