API Reference for view/SCCP_Analog_Gateway_Upgrade

Process to upgrade analog gateways from VG2XX to VG3XX

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

[pkid] is the ID of the resource instance. Refer to the List reference below.

[filename] refers to a file

GET http://[host-proxy]/api/view/SCCP_Analog_Gateway_Upgrade/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "gateway": {
               "title": "Analog Gateway Domain Name",
               "description": "Choice of analog gateway",
               "type": "string",
               "required": true
          },
          "vMac": {
               "title": "Reuse Virtual Domain Name",
               "description": "Cater for use of virtual mac address",
               "type": "boolean",
               "required": true,
               "default": "false"
          },
          "gateway_type": {
               "title": "Gateway Type (Informational)",
               "description": "Gateway Type (Informational)",
               "type": "string"
          },
          "new_gateway_model": {
               "title": "Model of New Gateway",
               "description": "Model of new gateway",
               "type": "string",
               "required": true,
               "default": "VG310"
          },
          "new_gateway_domain_name": {
               "title": "Gateway Domain Name",
               "description": "Gateway Domain Name",
               "type": "string",
               "required": true
          },
          "networkInterface": {
               "title": "Gateway Network Interface",
               "type": "string",
               "required": true,
               "choices": [
                    {
                         "value": "FastEthernet0/0",
                         "title": "FastEthernet0/0"
                    },
                    {
                         "value": "FastEthernet0/1",
                         "title": "FastEthernet0/1"
                    },
                    {
                         "value": "GigabitEthernet0/0",
                         "title": "GigabitEthernet0/0"
                    },
                    {
                         "value": "GigabitEthernet0/1",
                         "title": "GigabitEthernet0/1"
                    },
                    {
                         "value": "GigabitEthernet0/2",
                         "title": "GigabitEthernet0/2"
                    }
               ]
          },
          "modules_array": {
               "title": "Modules",
               "description": "Gateway Card Slotting",
               "type": "array",
               "required": true,
               "items": {
                    "type": "object",
                    "properties": {
                         "index": {
                              "title": "index",
                              "type": "integer",
                              "required": true
                         },
                         "product": {
                              "title": "Module",
                              "type": "string",
                              "required": true
                         },
                         "subunit_array": {
                              "title": "Subunits",
                              "type": "array",
                              "items": {
                                   "type": "object",
                                   "properties": {
                                        "index": {
                                             "title": "Subunit Position",
                                             "type": "integer",
                                             "required": true
                                        },
                                        "product": {
                                             "title": "Subunit",
                                             "type": "string",
                                             "required": true
                                        }
                                   }
                              }
                         }
                    }
               }
          }
     }
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/SCCP_Analog_Gateway_Upgrade/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/SCCP_Analog_Gateway_Upgrade as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/SCCP_Analog_Gateway_Upgrade	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Instance API Reference

[pkid] is the ID of the resource instance.

If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Get	GET	/api/view/SCCP_Analog_Gateway_Upgrade/[pkid]	hierarchy=[hierarchy]	The view/SCCP_Analog_Gateway_Upgrade instance with [pkid].

API Reference for view/SCCP_Analog_Gateway_Upgrade

GET http://[host-proxy]/api/view/SCCP_Analog_Gateway_Upgrade/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Instance API Reference

Get