API Reference for view/UserPhoneMoveUsers_VIEW

Model ref.: view/UserPhoneMoveUsers_VIEW

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "one_username": {
               "is_password": false, 
               "description": "Name of individual Subscriber who will be moved.", 
               "title": "Subscriber", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": " ", 
                         "title": " "
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "move_to_hn": {
               "is_password": false, 
               "description": "The name of the hierarchy node to which the Subscriber will be moved to if the conditions are satisfied.", 
               "title": "Move To Hierarchy", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": " ", 
                         "title": " "
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "lines": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "line": {
                              "type": "string", 
                              "title": "Pattern"
                         }
                    }
               }, 
               "type": "array", 
               "title": "New Lines"
          }, 
          "guiSourceCucBkey": {
               "type": "string", 
               "title": "Source CUC"
          }, 
          "existingSnr": {
               "type": "string", 
               "title": "Existing Single Number Reach"
          }, 
          "AllowLineMove": {
               "type": "boolean", 
               "title": "Allow Move of Lines to Destination Hierarchy"
          }, 
          "guiSourceCucmBkey": {
               "type": "string", 
               "title": "Source CUCM"
          }, 
          "move_line": {
               "default": "true", 
               "type": "boolean", 
               "description": "Tick to move any lines associated with the user to the destination hierarchy. If lines are moved, they will remain on the devices. Lines that are not moved may be  retained on devices, or may be replaced", 
               "title": "Move Lines to Destination Hierarchy"
          }, 
          "line_css": {
               "type": "string", 
               "description": "Specify a specific CSS to be used at the destination hierarchy", 
               "title": "Line Calling Search Space at Destination Hierarchy"
          }, 
          "new_phone_securityprofile": {
               "type": "string", 
               "title": "New Phone Security Profile"
          }, 
          "guiTargetCucmPkid": {
               "type": "string", 
               "title": "Target CUCM PKID"
          }, 
          "new_user_cft": {
               "type": "string", 
               "description": "Optional Template for Subscriber update on CUCM", 
               "title": "Configuration Template for Subscriber Update"
          }, 
          "new_phone_mac": {
               "type": "string", 
               "description": "e.g. SEP123412341234. Leave blank for auto generated MAC if you use phone based registration, select from list of free phones or provide a new phone name", 
               "title": "Device Name for New Phone"
          }, 
          "move_phone": {
               "default": "true", 
               "type": "boolean", 
               "description": "Tick to move any desk phones(SEP prefix) associated with the user to the new hierarchy. Disassociate Subscriber from existing desk phones if not checked. Jabber/Soft Clients etc (non SEP prefix devices) are always moved.", 
               "title": "Move Desk Phones to Destination Hierarchy"
          }, 
          "new_phone_product": {
               "type": "string", 
               "title": "New Phone Type"
          }, 
          "new_phone_config_source": {
               "type": "string", 
               "description": "Copy configuration from specified old phone", 
               "title": "New Phone Configuration Source"
          }, 
          "new_phone_pbt": {
               "type": "string", 
               "title": "New Phone Button Template"
          }, 
          "move_from_hn": {
               "is_password": false, 
               "description": "The name of the hierarchy node from which the Subscriber will be moved from if the conditions are satisfied.", 
               "title": "Move From Hierarchy", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "string"
          }, 
          "newCucUserTemplate": {
               "type": "string", 
               "title": "New Cuc User Template"
          }, 
          "new_line_cft": {
               "type": "string", 
               "description": "Optional Configuration Template name for Line parameter override", 
               "title": "Configuration Template for New Line"
          }, 
          "guiNewCucm": {
               "type": "boolean", 
               "title": "CUCM changes"
          }, 
          "default_dp": {
               "default": "true", 
               "type": "boolean", 
               "description": "Use the Default Device Pool defined as the site default at the destination hierarchy", 
               "title": "Use Default Device Pool at Destination Hierarchy"
          }, 
          "cfwd_css": {
               "type": "string", 
               "description": "Specify a specific CSS to be used at the destination hierarchy", 
               "title": "Call Forward Calling Search Space at Destination Hierarchy"
          }, 
          "new_phone_cft": {
               "type": "string", 
               "description": "Optional Configuration Template name for phone parameter override", 
               "title": "New Phone Configuration Template"
          }, 
          "move_to_role": {
               "type": "string", 
               "description": "The user role to use at the destination hierarchy", 
               "title": "Role at Destination Hierarchy"
          }, 
          "CrossClusterMessage": {
               "type": "string", 
               "title": "Caution"
          }, 
          "new_phone": {
               "type": "boolean", 
               "description": "Create New Phone at Destination Hierarchy", 
               "title": "Create New Phone at Destination Hierarchy"
          }, 
          "new_line": {
               "type": "boolean", 
               "description": "Create new line at the destination hierarchy. Use existing line if not ticked, even if line is not moved to the new hierarchy ( i.e shared line ). This applies to line 1 only. Subsequent lines must be modified if required after the move is complete.", 
               "title": "Replace Line with New Line at Destination Hierarchy"
          }, 
          "default_css": {
               "type": "boolean", 
               "description": "Use the CSS defined as the site default at the destination hierarchy", 
               "title": "Use Default CSS at Destination Hierarchy"
          }, 
          "device_pool": {
               "type": "string", 
               "description": "Specify a specific device pool to be used at the destination hierarchy", 
               "title": "Device Pool at Destination Hierarchy"
          }, 
          "existingVoicemail": {
               "type": "string", 
               "title": "Existing Voicemail"
          }, 
          "guiTargetCucBkey": {
               "type": "string", 
               "title": "Target CUC"
          }, 
          "new_phone_protocol": {
               "type": "string", 
               "title": "New Phone Protocol"
          }, 
          "guiNewCuc": {
               "type": "boolean", 
               "title": "CUC Changes"
          }, 
          "existingPhones": {
               "type": "string", 
               "title": "Existing Phones"
          }, 
          "new_phone_config_source_product": {
               "type": "string", 
               "title": "Phone Type to Copy Configuration from"
          }, 
          "guiTargetCucmBkey": {
               "type": "string", 
               "title": "Target CUCM"
          }, 
          "existingDeviceProfiles": {
               "type": "string", 
               "title": "Existing Device Profiles"
          }
     }, 
     "schema_version": "1.2"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/UserPhoneMoveUsers_VIEW/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/UserPhoneMoveUsers_VIEW 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/UserPhoneMoveUsers_VIEW/	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	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of view/UserPhoneMoveUsers_VIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/view/UserPhoneMoveUsers_VIEW/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/view/UserPhoneMoveUsers_VIEW/[pkid1]", "/api/view/UserPhoneMoveUsers_VIEW/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of view/UserPhoneMoveUsers_VIEW and the JSON format can be used to import instances of view/UserPhoneMoveUsers_VIEW.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for view/UserPhoneMoveUsers_VIEW:

 GET http://[host-proxy]/api/view/UserPhoneMoveUsers_VIEW/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for view/UserPhoneMoveUsers_VIEW	POST	/api/view/UserPhoneMoveUsers_VIEW/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/UserPhoneMoveUsers_VIEW	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/view/UserPhoneMoveUsers_VIEW/	hierarchy=[hierarchy] format=json schema=true	The view/UserPhoneMoveUsers_VIEW schema and all instances as JSON.

(The list will return 0 to 3 view/UserPhoneMoveUsers_VIEW instances)

GET http://[host]/api/view/UserPhoneMoveUsers_VIEW/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "add", 
          "help", 
          "configuration_template", 
          "field_display_policy", 
          "export_bulkload_template", 
          "transform"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/view/UserPhoneMoveUsers_VIEW/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "1.2", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/view/UserPhoneMoveUsers_VIEW/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/view/UserPhoneMoveUsers_VIEW/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/view/UserPhoneMoveUsers_VIEW/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/UserPhoneMoveUsers_VIEW/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/UserPhoneMoveUsers_VIEW/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/UserPhoneMoveUsers_VIEW", 
          "model_specific_actions": [
               "add"
          ], 
          "summary_attrs": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "19.3.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for view/UserPhoneMoveUsers_VIEW.	GET	/api/view/UserPhoneMoveUsers_VIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/UserPhoneMoveUsers_VIEW 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 a selected [export_format] of the schema and a single instance with [pkid] of view/UserPhoneMoveUsers_VIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/view/UserPhoneMoveUsers_VIEW/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of view/UserPhoneMoveUsers_VIEW and the JSON format can be used to import instances of view/UserPhoneMoveUsers_VIEW.

For Bulk Export, refer to the Bulk Export section.

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

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

API Reference for view/UserPhoneMoveUsers_VIEW

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

Get the Add form

Create

Bulk Export

Export Bulk Load Template

List

GET http://[host]/api/view/UserPhoneMoveUsers_VIEW/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Export

Get

Help