API Reference for view/HcsMoveUsersVIEW

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "move_from_hn_count": {
               "is_password": false, 
               "description": "The number of the hierarchy nodes that match the from username.", 
               "title": "Move From Hierarchy Count", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "default": "TBD", 
               "readonly": false, 
               "type": "string"
          }, 
          "usernames": {
               "is_password": false, 
               "description": "Names of users who will be moved.", 
               "title": "Users", 
               "minItems": 0, 
               "items": {
                    "type": "string"
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "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_all": {
               "is_password": false, 
               "description": "Move all the users at the move from hierarchy.", 
               "title": "Move All Users", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "default": "false", 
               "readonly": false, 
               "type": "boolean"
          }, 
          "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_user": {
               "is_password": false, 
               "description": "The default role to assign to the moved user (if no other LDAP Custom Role Mappings are applicable for the moved user, then this fallback/default role will be applied)", 
               "title": "Set Default Role", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": " ", 
                         "title": " "
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "note": {
               "is_password": false, 
               "description": "Information regarding the specified action.", 
               "title": "Note", 
               "minItems": 0, 
               "required": false, 
               "displayable": true, 
               "readonly": false, 
               "type": "string"
          }, 
          "filters": {
               "is_password": false, 
               "description": "Select move filters to be applied when the transaction is submitted.", 
               "title": "Filters", 
               "minItems": 0, 
               "items": {
                    "type": "string", 
                    "choices": [
                         {
                              "value": " ", 
                              "title": " "
                         }
                    ]
               }, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "array"
          }, 
          "action": {
               "is_password": false, 
               "description": "The type of Move action to perform. This attribute is deprecated and move_action should be used instead.", 
               "title": "Action", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": "MoveUsersByFilters", 
                         "title": "Move users by filters"
                    }, 
                    {
                         "value": "MoveUsersByUsernames", 
                         "title": "Move users by usernames"
                    }, 
                    {
                         "value": "MoveUserByUsername", 
                         "title": "Move user by username"
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "move_action": {
               "is_password": false, 
               "description": "The type of Move action to perform.", 
               "title": "Action", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": "MoveUsersByFilters", 
                         "title": "Move users by filters"
                    }, 
                    {
                         "value": "MoveUsersByUsernames", 
                         "title": "Move users by usernames"
                    }, 
                    {
                         "value": "MoveUserByUsername", 
                         "title": "Move user by username"
                    }
               ], 
               "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"
          }
     }, 
     "schema_version": "2.4.1"
}

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

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

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

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

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

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

GET http://[host]/api/view/HcsMoveUsersVIEW/?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/HcsMoveUsersVIEW/?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": "2.4.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/HcsMoveUsersVIEW/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/view/HcsMoveUsersVIEW/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/HcsMoveUsersVIEW/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/HcsMoveUsersVIEW/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/HcsMoveUsersVIEW/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/HcsMoveUsersVIEW", 
          "model_specific_actions": [
               "add"
          ], 
          "summary_attrs": [
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

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

For Bulk Export, refer to the Bulk Export section.

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

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

API Reference for view/HcsMoveUsersVIEW

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

Get the Add form

Create

Bulk Export

Export Bulk Load Template

List

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

Help

Instance API Reference

Export

Get

Help