Operation Parameters

Operation parameters are crucial for configuring each operation’s execution. As an OpenGate operation administrator, you can set operation parameters when creating or editing an operation using the API to manage operations in your organization. You can define operation parameters using JSON schema. JSON schema definition provides the flexibility to create simple or complex parameters to meet your needs.

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

Parameters for REBOOT_EQUIPMENT operation as 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