[Index]

API Reference for view/ExportDeviceStatusView

Export device status information

Model ref.: view/ExportDeviceStatusView

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "status": {
               "description": "Only devices with this status will be exported",
               "title": "Status",
               "required": true,
               "choices": [
                    {
                         "value": "Registered",
                         "title": "Registered"
                    },
                    {
                         "value": "Unregistered",
                         "title": "Unregistered"
                    },
                    {
                         "value": "PartiallyRegistered",
                         "title": "Partially Registered"
                    },
                    {
                         "value": "Rejected",
                         "title": "Rejected"
                    },
                    {
                         "value": "Any",
                         "title": "Any"
                    },
                    {
                         "value": "Unknown",
                         "title": "Unknown"
                    },
                    {
                         "value": "None",
                         "title": "None"
                    }
               ],
               "type": "string"
          },
          "call_manager": {
               "type": "string",
               "description": "Only devices on this Unified CM Cluster will be exported",
               "title": "Unified CM Cluster"
          },
          "device_name": {
               "type": "string",
               "description": "Only devices with names starting with this value will be exported",
               "title": "Device Name"
          },
          "ip_address": {
               "type": "string",
               "description": "Only devices with IP addresses starting with this value will be exported",
               "title": "IP Address"
          },
          "dir_number": {
               "type": "string",
               "description": "Only devices where the directory number starts with this value will be exported",
               "title": "Directory Number"
          },
          "fname_prefix": {
               "type": "string",
               "description": "Will be prefixed to generated filename if set",
               "title": "File name prefix"
          },
          "notes": {
               "default": "This tool will export the list of Phones where the Phone's status matches the selected \"Status\" filter. Additional filters for Unified CM Cluster, Device Name and Directory Number can be defined to refine the list. If the matched Phones reside on more than 3 Unified CM Clusters the export will fail and you will be required to further refine your search. When executed above Customer level the Unified CM Cluster filter must be defined in order to reduce the search scope to a single Unified CM Cluster.",
               "type": "string",
               "title": "Notes"
          },
          "hierarchy_type": {
               "type": "string",
               "description": "Hidden field to determine hierarchy type",
               "title": "Hierarchy Type"
          }
     },
     "schema_version": "1.2"
}

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

Task	Call	URL	Parameters	Response
Get the on-line Help for view/ExportDeviceStatusView.	GET	/api/view/ExportDeviceStatusView/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/ExportDeviceStatusView as HTML

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/ExportDeviceStatusView/[pkid]	hierarchy=[hierarchy]	The view/ExportDeviceStatusView instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/view/ExportDeviceStatusView/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/ExportDeviceStatusView.

API Reference for view/ExportDeviceStatusView

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

Get the Add form

Create

Help

Instance API Reference

Get

Help