[Index]
Model ref.: view/MoveSubscriberVIEW
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": {
"DPPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Device Profile Move Policy"
},
"one_username": {
"is_password": false,
"description": "Name of individual user who will be moved.",
"title": "User",
"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 user will be moved if the conditions are satisfied.",
"title": "Move To Hierarchy",
"minItems": 0,
"required": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
},
"PhoneRDCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Phone Remote Destination move.",
"title": "Phone Remote Destination CFT",
"required": false,
"readonly": false,
"type": "string"
},
"RDPCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Remote Destination Profile move.",
"title": "Remote Destination Profile CFT",
"required": false,
"readonly": false,
"type": "string"
},
"lineRP": {
"is_password": false,
"description": "The Configuration Template to apply during Line move.",
"title": "Line Partition",
"required": false,
"readonly": true,
"type": "string"
},
"RDPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Remote Destination Move Policy"
},
"AuthenticationPolicy": {
"default": "keepConfig",
"choices": [
{
"value": "keepConfig",
"title": "Keep Current Settings"
},
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
}
],
"type": "string",
"title": "User Authentication"
},
"cuc_present": {
"is_password": false,
"description": "Hidden field used to show/hide CUC checkbox.",
"title": "CUC User Found",
"required": false,
"readonly": false,
"type": "string"
},
"ldap_present": {
"is_password": false,
"description": "Hidden field used to show/hide LDAP checkbox.",
"title": "LDAP User Found",
"required": false,
"readonly": false,
"type": "string"
},
"CUCMUserCFT": {
"is_password": false,
"description": "The Configuration Template to apply during CUCM User move.",
"title": "CUCM User CFT",
"required": false,
"readonly": false,
"type": "string"
},
"move_webex": {
"type": "boolean",
"description": "Include WebEx Voicemail.",
"title": "Move WebEx User"
},
"linePolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Line Move Policy"
},
"lineCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Line move.",
"title": "Line CFT",
"required": false,
"readonly": false,
"type": "string"
},
"MIPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Mobile Identity Move Policy"
},
"move_from_hn": {
"is_password": false,
"description": "The name of the hierarchy node from which the user will be moved if the conditions are satisfied.",
"title": "Move From Hierarchy",
"minItems": 0,
"required": false,
"displayable": false,
"readonly": false,
"type": "string"
},
"webex_present": {
"is_password": false,
"description": "Hidden field used to show/hide WebEx checkbox.",
"title": "WebEx User Found",
"required": false,
"readonly": false,
"type": "string"
},
"move_ldap": {
"type": "boolean",
"description": "Include data/ldap",
"title": "Move LDAP User"
},
"RDPPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Remote Destination Profile Move Policy"
},
"MICFT": {
"is_password": false,
"description": "The Configuration Template to apply during Mobile Identity move.",
"title": "Phone Mobile Identity CFT",
"required": false,
"readonly": false,
"type": "string"
},
"PhoneCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Phone move.",
"title": "Phone CFT",
"required": false,
"readonly": false,
"type": "string"
},
"move_to_role": {
"type": "string",
"description": "The user role to use at the new site",
"title": "Role at new site"
},
"move_cuc": {
"type": "boolean",
"description": "Include CUC Voicemail.",
"title": "Move CUC Voicemail User"
},
"DPCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Device Profile move.",
"title": "Device Profile CFT",
"required": false,
"readonly": false,
"type": "string"
},
"linesMove": {
"default": "existLines",
"choices": [
{
"value": "existLines",
"title": "Keep existing lines"
},
{
"value": "newLines",
"title": "Choose new lines"
}
],
"type": "string",
"title": "Lines Replace"
},
"PhonePolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Phone Move Policy"
},
"lines": {
"items": {
"type": "object",
"properties": {
"directory_number": {
"type": "string",
"title": "Directory Number"
}
}
},
"required": false,
"type": "array",
"title": "Lines"
},
"CUCMUserPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "CUCM User Move Policy"
},
"PhoneRDPolicy": {
"default": "sddConfig",
"choices": [
{
"value": "sddConfig",
"title": "Use Destination SDD Defaults"
},
{
"value": "cftConfig",
"title": "Use CFT and Destination SDD Defaults"
}
],
"type": "string",
"title": "Phone Remote Destination Move Policy"
},
"RDCFT": {
"is_password": false,
"description": "The Configuration Template to apply during Remote Destination move.",
"title": "Remote Destination CFT",
"required": false,
"readonly": false,
"type": "string"
}
},
"schema_version": "1.2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/MoveSubscriberVIEW/add/ |
|
The GUI Add form of view/MoveSubscriberVIEW 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/MoveSubscriberVIEW/ | 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 | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/MoveSubscriberVIEW | POST | /api/view/MoveSubscriberVIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/MoveSubscriberVIEW/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/MoveSubscriberVIEW/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/MoveSubscriberVIEW/ |
|
The view/MoveSubscriberVIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/MoveSubscriberVIEW instances)
{
"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/MoveSubscriberVIEW/?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.1",
"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/MoveSubscriberVIEW/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/view/MoveSubscriberVIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/MoveSubscriberVIEW/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/view/MoveSubscriberVIEW/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/MoveSubscriberVIEW/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/MoveSubscriberVIEW/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/MoveSubscriberVIEW/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/MoveSubscriberVIEW/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/view/MoveSubscriberVIEW/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "view/MoveSubscriberVIEW",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/MoveSubscriberVIEW. | GET | /api/view/MoveSubscriberVIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/MoveSubscriberVIEW as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/view/MoveSubscriberVIEW/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/view/MoveSubscriberVIEW/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/MoveSubscriberVIEW/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/MoveSubscriberVIEW/[pkid]/ | hierarchy=[hierarchy] | The view/MoveSubscriberVIEW instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/MoveSubscriberVIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/MoveSubscriberVIEW. |