POST cliTemplateConfiguration/upload - multiple variables

[Gabriel Zapodeanu]

I am working on a script to upload a CLI template to Prime, followed by deployment.

As part of my script I will need to have multiple variables used:

/webacs/api/v1/op/cliTemplateConfiguration/upload

...

"variables" :

  {"variable" : {

   "defaultValue" : "",

   "description" : "IP address",

   "displayLabel" : "",

   "name" : "RemoteClient",

   "rangeFrom" : "",

   "rangeTo" : "",

   "required" : True,

   "type" : "IPv4 Address",

   "validationExpression" : ""

   },

   "variable" : {

   "defaultValue" : "",

   "description" : "VLAN number",

   "displayLabel" : "",

   "name" : "VlanId",

   "rangeFrom" : "",

   "rangeTo" : "",

   "required" : True,

   "type" : "Integer",

   "validationExpression" : ""

   }

}

---

I am able to send one variable to Prime, but not more. The documentation asks for a list of variables. It does not seem to work as a list of variables.

The documentation is not very clear how to actually accomplish this. How do I format the data I need to send to be able to use multiple variables in my code?

[Spencer Zier · Accepted solution]

So for JSON, there should be a JSON object "variables" containing a JSON array "variable" of variable objects.

"variables":{
"variable":[
{"name":"Example one","description":"Example",...},
{"name":"Example two","description":"Example",...},
{"name":"Example three","description":"Example",...}
]
}

The square brackets denote that it's an array of objects.

For customers using JSON, we recommend moving to API v2, as the JSON output and input handling for arrays is consistent (in v1, the JSON handler will treat "variable" as an object if it has only one element and an array if it has more than one).

[Gabriel Zapodeanu]

Spencer, Thank you, I will try out the solution and use API v2. I will update with the results.

[Gabriel Zapodeanu]

Thank you for your help. It worked as stated. Example of using two variables: $VlanId and $RemoteClient

list_var = {
   'variable': [
  {'name': 'RemoteClient', 'displayLabel': 'RemoteClient', 'description': 'IP address', 'required': 'True', 'type': 'IPv4 Address'},
   {'name': 'VlanId', 'displayLabel': 'VlanId', 'description': 'VLAN number', 'required': 'True', 'type': 'Integer'}
  ]
}