[Index]

API Reference for view/GS_LinkedSiteMoveUsers_VIEW

Model ref.: view/GS_LinkedSiteMoveUsers_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 [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

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/GS_LinkedSiteMoveUsers_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 user who will be moved.",
               "title": "User",
               "minItems": 0,
               "required": false,
               "displayable": false,
               "choices": [
                    {
                         "value": " ",
                         "title": " "
                    }
               ],
               "readonly": false,
               "type": "string"
          },
          "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"
          },
          "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"
          },
          "move_to_role": {
               "type": "string",
               "description": "The user role to use at the new site",
               "title": "Role at new site"
          },
          "move_line": {
               "default": "true",
               "type": "boolean",
               "description": "Tick to move any lines associated with the user to the new site. 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 new site"
          },
          "new_line": {
               "type": "boolean",
               "description": "Create new line at new site. Use existing line if not ticked, even if line is not moved to the new site ( 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 new site"
          },
          "new_line_dn": {
               "type": "string",
               "description": "Select new line from new site inventory",
               "title": "Directory Number for new line"
          },
          "new_line_cft": {
               "type": "string",
               "description": "optional template name for line parameter override",
               "title": "Configuration Template for new line"
          },
          "move_phone": {
               "default": "true",
               "type": "boolean",
               "description": "Tick to move any fixed phones associated with the user to the new site. Disassociate user from existing fixed phones if not checked. Jabber clients etc (non SEP devices) are always moved.",
               "title": "Move fixed phones to new site"
          },
          "new_phone": {
               "type": "boolean",
               "description": "Create new phone at new site",
               "title": "Create new phone at new site"
          },
          "new_phone_product": {
               "type": "string",
               "title": "New phone model"
          },
          "new_phone_mac": {
               "type": "string",
               "description": "e.g. SEP123412341234. Leave blank for auto generated MAC if you use phone based registration",
               "title": "Device name for new phone"
          },
          "new_phone_config_source": {
               "type": "string",
               "description": "Copy configuration from specified old phone",
               "title": "New phone config source"
          },
          "new_phone_config_source_product": {
               "type": "string",
               "title": "Phone type to copy config from"
          },
          "new_phone_cft": {
               "type": "string",
               "description": "optional config template name for phone parameter override",
               "title": "Configuration Template for new phone"
          },
          "new_phone_pbt": {
               "type": "string",
               "title": "Phone ButtonTemplate for new phone"
          },
          "default_css": {
               "type": "boolean",
               "description": "Use the CSS defined as the site default",
               "title": "Use default CSS at new site"
          },
          "line_css": {
               "type": "string",
               "description": "Specify a specific CSS to be used at the new site",
               "title": "Line Calling Search Space at new site"
          },
          "cfwd_css": {
               "type": "string",
               "description": "Specify a specific CSS to be used at the new site",
               "title": "Call Forward Calling Search Space at new site"
          },
          "default_dp": {
               "default": "true",
               "type": "boolean",
               "description": "Use the CSS defined as the site default",
               "title": "Use default device pool at new site"
          },
          "device_pool": {
               "type": "string",
               "description": "Specify a specific device pool to be used at the new site",
               "title": "device pool at new site"
          }
     }
}

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

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

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

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

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

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

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": null,
          "direction": "asc",
          "current": "/api/view/GS_LinkedSiteMoveUsers_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/GS_LinkedSiteMoveUsers_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": null,
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/view/GS_LinkedSiteMoveUsers_VIEW/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/view/GS_LinkedSiteMoveUsers_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/GS_LinkedSiteMoveUsers_VIEW/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/view/GS_LinkedSiteMoveUsers_VIEW/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/view/GS_LinkedSiteMoveUsers_VIEW/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for view/GS_LinkedSiteMoveUsers_VIEW.	GET	/api/view/GS_LinkedSiteMoveUsers_VIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/GS_LinkedSiteMoveUsers_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/GS_LinkedSiteMoveUsers_VIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/view/GS_LinkedSiteMoveUsers_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/GS_LinkedSiteMoveUsers_VIEW and the JSON format can be used to import instances of view/GS_LinkedSiteMoveUsers_VIEW.

For Bulk Export, refer to the Bulk Export section.

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

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

API Reference for view/GS_LinkedSiteMoveUsers_VIEW

GET http://[host-proxy]/api/view/GS_LinkedSiteMoveUsers_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/GS_LinkedSiteMoveUsers_VIEW/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Export

Get

Help