API Reference for view/ReassignServicesVIEW

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "currentHnPkid": {
               "is_password": false,
               "description": "The Pkid of the hierarchy node from where the view is launched.",
               "title": "Current Hierarchy PKID",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "sourceUsername": {
               "is_password": false,
               "description": "Name of Source User with existing services.",
               "title": "Source User",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "choices": [
                    {
                         "value": " ",
                         "title": " "
                    }
               ],
               "readonly": false,
               "type": "string"
          },
          "sourceUserHn": {
               "is_password": false,
               "description": "The name of the hierarchy node where Source User resides and the Target User will be moved to.",
               "title": "Source User Hierarchy",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "sourceUserHnPkid": {
               "is_password": false,
               "description": "The PKID of the hierarchy node where the Source User resides and the Target User will be moved to.",
               "title": "Source Hierarchy Pkid",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "sourceUserSite": {
               "is_password": false,
               "description": "The Site name where the Source User resides and the Target User will be moved to",
               "title": "Source Site",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "addTargetUser": {
               "type": "boolean",
               "description": "Checkbox to allow adding of Target User.",
               "title": "Add New Target User"
          },
          "username": {
               "is_password": false,
               "description": "Name of Target User that will receive services.",
               "title": "Target User",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": false,
               "type": "string"
          },
          "targetUserHn": {
               "is_password": false,
               "description": "The name of the hierarchy node where Target User resides at submit time.",
               "title": "Target User Hierarchy",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "targetUserHnPkid": {
               "is_password": false,
               "description": "The PKID of the hierarchy node where Target User resides at submit time.",
               "title": "Target User Current Hierarchy Pkid",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "targetUserSite": {
               "is_password": false,
               "description": "The Site where Target User currently resides.",
               "title": "Target User Current Site Name",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "firstName": {
               "is_password": false,
               "description": "The First Name of the Target User used in naming macros.",
               "title": "First Name",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "lastName": {
               "is_password": false,
               "description": "The Last Name of the Target User used in naming macros.",
               "title": "Last Name",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "email": {
               "is_password": false,
               "description": "The Email Address of the Target User to be created.",
               "title": "Email Address",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "password": {
               "is_password": true,
               "description": "The Password of the Target User to be created.",
               "title": "Password",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "pin": {
               "is_password": true,
               "description": "The Pin of the Target User to be created.",
               "title": "Pin",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          },
          "reassignServicesProfile": {
               "is_password": false,
               "description": "Choose a Reassign Services Profile to apply to this service change.",
               "title": "Reassign Services Profile",
               "minItems": 0,
               "format": "uri",
               "displayable": false,
               "required": false,
               "target_attr": "profileName",
               "readonly": false,
               "target": "/api/data/ReassignServicesProfile/choices/?field=profileName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "type": "string",
               "target_model_type": "data/ReassignServicesProfile",
               "choices": []
          },
          "existingSource": {
               "type": "object",
               "title": "Source User Services",
               "properties": {
                    "phones": {
                         "type": "string",
                         "title": "Phones"
                    },
                    "ext_mobilities": {
                         "type": "string",
                         "title": "Extension Mobility Profiles"
                    },
                    "voicemail": {
                         "type": "string",
                         "title": "Voicemail Extension"
                    },
                    "webex": {
                         "type": "string",
                         "title": "Webex"
                    },
                    "snr": {
                         "type": "string",
                         "title": "Single Number Reach"
                    }
               }
          },
          "existingTarget": {
               "type": "object",
               "title": "Target User Services",
               "properties": {
                    "phones": {
                         "type": "string",
                         "title": "Phones"
                    },
                    "ext_mobilities": {
                         "type": "string",
                         "title": "Extension Mobility Profiles"
                    },
                    "voicemail": {
                         "type": "string",
                         "title": "Voicemail Extension"
                    },
                    "webex": {
                         "type": "string",
                         "title": "Webex"
                    },
                    "snr": {
                         "type": "string",
                         "title": "Single Number Reach"
                    }
               }
          },
          "ldapUserStatus": {
               "is_password": false,
               "description": "The LDAP User Status of the Target User to be created.",
               "title": "LDAP User Status",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "integer"
          },
          "ldapDirectoryName": {
               "is_password": false,
               "description": "The LDAP Directory Name of the Target User to be created.",
               "title": "LDAP Directory Name",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "readonly": true,
               "type": "string"
          }
     },
     "schema_version": "1.2.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/ReassignServicesVIEW/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/ReassignServicesVIEW 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/ReassignServicesVIEW	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 a compressed format of the Bulk Load spreadsheet template for view/ReassignServicesVIEW	POST	/api/view/ReassignServicesVIEW/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/ReassignServicesVIEW	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/ReassignServicesVIEW/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/view/ReassignServicesVIEW/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get the on-line Help for view/ReassignServicesVIEW.	GET	/api/view/ReassignServicesVIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/ReassignServicesVIEW 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/ReassignServicesVIEW/[pkid]	hierarchy=[hierarchy]	The view/ReassignServicesVIEW instance with [pkid].

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

API Reference for view/ReassignServicesVIEW

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

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Field Display Policy

Help

Instance API Reference

Get

Help