[Index]
Model ref.: view/UserPhoneMoveUsers_VIEW
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"username": {
"title": "Subscriber",
"description": "Name of individual Subscriber who will be moved.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
]
},
"move_from_hn": {
"title": "Move From Hierarchy",
"description": "The name of the hierarchy node from which the Subscriber will be moved from if the conditions are satisfied.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false
},
"move_to_hn": {
"title": "Move To Hierarchy",
"description": "The name of the hierarchy node to which the Subscriber will be moved to if the conditions are satisfied.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
]
},
"move_to_role": {
"title": "New Role",
"description": "The user role to use at the destination hierarchy",
"type": "string"
},
"new_user_cft": {
"title": "User Template",
"description": "Optional Template for Subscriber update on CUCM",
"type": "string"
},
"move_line": {
"title": "Move Lines",
"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",
"type": "boolean",
"default": "true"
},
"AllowLineMove": {
"title": "Allow Move of Lines",
"type": "boolean"
},
"new_line": {
"title": "Create New Line",
"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.",
"type": "boolean"
},
"lines": {
"title": "New Lines",
"type": "array",
"items": {
"type": "object",
"properties": {
"template_name": {
"title": "Line Template",
"description": "Line template to use for configuration settings.",
"type": "string"
},
"line_filter": {
"title": "Inventory Filter",
"type": "string",
"required": false,
"default": "default",
"choices": [
{
"value": "default",
"title": "Default"
},
{
"value": "lines_unused_only_local",
"title": "Show Unused Numbers (Site Only)"
},
{
"value": "lines_unused_only",
"title": "Show Unused Numbers"
},
{
"value": "lines_e164_unused_local",
"title": "Show Unused Numbers with Associated E164's (Site Only)"
},
{
"value": "lines_e164_unused",
"title": "Show Unused Numbers with Associated E164's"
},
{
"value": "lines_used_only_local",
"title": "Show Used Numbers (Site Only)"
},
{
"value": "lines_used_only",
"title": "Show Used Numbers"
},
{
"value": "lines_userid_used",
"title": "Show Numbers belonging to this Subscriber"
}
]
},
"directory_number": {
"title": "Directory Number",
"description": "Directory Number of line to assign.",
"type": "string",
"required": true
},
"label": {
"title": "Label",
"description": "Label to use for this line.",
"type": "string"
},
"display": {
"title": "Display",
"description": "Display to use for this line.",
"type": "string"
}
}
}
},
"line_profile": {
"title": "Line Configuration Mapping",
"description": "Line Configuration Mapping",
"type": "string"
},
"android_profile": {
"title": "Android Profile",
"description": "Android profile to be applied.",
"type": "string"
},
"csf_profile": {
"title": "CSF Profile",
"description": "CSF profile to be applied.",
"type": "string"
},
"tablet_profile": {
"title": "Tablet Profile",
"description": "Tablet profile to be applied.",
"type": "string"
},
"iphone_profile": {
"title": "iPhone Profile",
"description": "iPhone profile to be applied.",
"type": "string"
},
"cim_profile": {
"title": "Carrier Integrated Mobile Profile",
"description": "Carrier Integrated Mobile profile to be applied.",
"type": "string"
},
"ctird_profile": {
"title": "CTI Remote Device Profile",
"description": "CTI Remote Device profile to be applied.",
"type": "string"
},
"move_phone": {
"title": "Move Desk Phones",
"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.",
"type": "boolean",
"default": "true"
},
"new_phone": {
"title": "Create New Phone",
"description": "Create New Phone at Destination Hierarchy",
"type": "boolean"
},
"new_phone_from_source": {
"title": "Use Existing Phone Configuration",
"description": "Toggle to select an existing Phone for configuration.",
"type": "boolean",
"default": "false"
},
"phone_type": {
"title": "Desk Phone Profile",
"description": "Select the required Desk Phone Profile specified in Phone Configuration Mapping",
"type": "string"
},
"new_phone_protocol": {
"title": "Phone Protocol",
"type": "string"
},
"name": {
"title": "Phone Name",
"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",
"type": "string"
},
"new_phone_config_source": {
"title": "Phone Configuration Source",
"description": "Copy configuration from associated phone",
"type": "string"
},
"new_phone_config_source_product": {
"title": "Phone Type to Copy Configuration from",
"type": "string"
},
"phone_profile": {
"title": "Phone Configuration Mapping",
"description": "Phone Configuration Mapping",
"type": "string"
},
"dp_profile": {
"title": "Device Profile Configuration Mapping",
"description": "Device Profile Configuration Mapping",
"type": "string"
},
"new_phone_cft": {
"title": "Desk Phone Feature Template",
"description": "Optional Configuration Template name for phone parameter override",
"type": "string"
},
"new_phone_pbt": {
"title": "Phone Button Template",
"type": "string"
},
"new_phone_securityprofile": {
"title": "Phone Security Profile",
"type": "string"
},
"default_css": {
"title": "Use Default CSS",
"description": "Use the CSS defined as the site default at the destination hierarchy",
"type": "boolean"
},
"line_css": {
"title": "Line CSS",
"description": "Specify a specific CSS to be used at the destination hierarchy",
"type": "string"
},
"cfwd_css": {
"title": "Call Forward CSS",
"description": "Specify a specific CSS to be used at the destination hierarchy",
"type": "string"
},
"default_dp": {
"title": "Use Default Device Pool",
"description": "Use the Default Device Pool defined as the site default at the destination hierarchy",
"type": "boolean",
"default": "true"
},
"device_pool": {
"title": "Device Pool",
"description": "Specify a specific device pool to be used at the destination hierarchy",
"type": "string"
},
"guiSourceCucmBkey": {
"title": "Source CUCM",
"type": "string"
},
"guiTargetCucmBkey": {
"title": "Target CUCM",
"type": "string"
},
"guiTargetCucmPkid": {
"title": "Target CUCM PKID",
"type": "string"
},
"guiSourceCucBkey": {
"title": "Source CUC",
"type": "string"
},
"guiTargetCucBkey": {
"title": "Target CUC",
"type": "string"
},
"guiNewCucm": {
"title": "CUCM changes",
"type": "boolean"
},
"guiNewCuc": {
"title": "CUC Changes",
"type": "boolean"
},
"CrossClusterMessage": {
"title": "Caution",
"type": "string"
},
"newCucUserTemplate": {
"title": "New Cuc User Template",
"type": "string"
},
"existingPhones": {
"title": "Phones",
"type": "string"
},
"existingDeviceProfiles": {
"title": "Extension Mobility",
"type": "string"
},
"existingSnr": {
"title": "Single Number Reach",
"type": "string"
},
"existingVoicemail": {
"title": "Voicemail",
"type": "string"
},
"existingWebex": {
"title": "Webex Meetings",
"type": "string"
},
"existingWebexTeams": {
"title": "Webex App",
"type": "string"
},
"existingPexip": {
"title": "Pexip Conferencing",
"type": "string"
},
"existingContactCenter": {
"title": "Contact Center",
"type": "string"
}
},
"schema_version": "3.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/UserPhoneMoveUsers_VIEW/add/ |
|
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] |
|
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/ |
|
{ "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.
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/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/UserPhoneMoveUsers_VIEW/ |
|
The view/UserPhoneMoveUsers_VIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/UserPhoneMoveUsers_VIEW instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/UserPhoneMoveUsers_VIEW/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/UserPhoneMoveUsers_VIEW",
"summary_attrs": [
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add"
],
"schema_version": "3.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/UserPhoneMoveUsers_VIEW/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/view/UserPhoneMoveUsers_VIEW/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/view/UserPhoneMoveUsers_VIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/UserPhoneMoveUsers_VIEW/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/UserPhoneMoveUsers_VIEW/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"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 |
| 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 |
|
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. |