API Reference for view/Site_Phones_Reset

View to kick off reset/restart of all site level phones.

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/Site_Phones_Reset/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "action": {
               "default": "Reset All Phones", 
               "choices": [
                    {
                         "value": "reset", 
                         "title": "Reset All Phones"
                    }, 
                    {
                         "value": "restart", 
                         "title": "Restart All Phones"
                    }
               ], 
               "type": "string", 
               "title": "Action to Take"
          }, 
          "notes": {
               "default": "If a device is not registered with Cisco Unified Communications Manager, you cannot reset or restart it. \nIf a device is registered, to restart a device without shutting it down, choose \"Restart All Phones\" from the dropdown. \nTo shut down a device and bring it back up, choose \"Reset All Phones\" from the dropdown.\n \nWARNING: The selected Action will be performed on ALL phones currently registered at this Site.", 
               "type": "string", 
               "title": "Note"
          }
     }, 
     "schema_version": "2.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/Site_Phones_Reset/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/Site_Phones_Reset 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/Site_Phones_Reset/	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/Site_Phones_Reset/[pkid]/	hierarchy=[hierarchy]	The view/Site_Phones_Reset instance with [pkid].

API Reference for view/Site_Phones_Reset

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

Get the Add form

Create

Instance API Reference

Get