API Reference for view/HcsSyncUsersVIEW

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "note": {
               "is_password": false, 
               "description": "Indicates whether or not sync is possible.", 
               "title": "Note", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "string"
          }, 
          "removeLogs": {
               "is_password": false, 
               "description": "When checked, the existing User Management Log Messages get cleared prior to performing the action. Whether the existing Log Messages are removed or not, new logs may result from the action.", 
               "title": "Remove Log Messages", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "readonly": false, 
               "type": "boolean"
          }, 
          "userSyncType": {
               "is_password": false, 
               "title": "User Sync Type", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "default": "TBD", 
               "readonly": false, 
               "type": "string"
          }, 
          "ldapServer": {
               "is_password": false, 
               "description": "LDAP Server", 
               "title": "LDAP Server", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {}
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "ldapAction": {
               "is_password": false, 
               "description": "The action to perform.", 
               "title": "LDAP Action", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": "SyncLdapUsers", 
                         "title": "Synchronize users from LDAP"
                    }, 
                    {
                         "value": "PurgeLdapUsers", 
                         "title": "Purge local LDAP device resources"
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "ndlName": {
               "is_password": false, 
               "description": "The network device list to use when performing the action.", 
               "title": "Network Device List", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": " ", 
                         "title": " "
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "cucmAction": {
               "is_password": false, 
               "description": "The action to perform.", 
               "title": "CUCM Action", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": "SyncCucmUsers", 
                         "title": "Synchronize users, lines, and phones from CUCM"
                    }
               ], 
               "readonly": false, 
               "type": "string"
          }, 
          "removeLogsDirection": {
               "is_password": false, 
               "description": "Select Local to remove logs at the hierarchy of the LDAP server. Select Down to remove logs at and below the hierarchy of the LDAP server. Note that this will remove all User Management logs according to the selected direction regardless of what triggered the log.", 
               "title": "Remove Log Direction", 
               "minItems": 0, 
               "required": false, 
               "displayable": false, 
               "choices": [
                    {
                         "value": "Local", 
                         "title": "Local"
                    }, 
                    {
                         "value": "Down", 
                         "title": "Down"
                    }
               ], 
               "default": "Down", 
               "readonly": false, 
               "type": "string"
          }
     }, 
     "schema_version": "2.2"
}

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

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

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

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

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

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

GET http://[host]/api/view/HcsSyncUsersVIEW/?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/HcsSyncUsersVIEW/?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.2", 
          "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/HcsSyncUsersVIEW/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/view/HcsSyncUsersVIEW/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/HcsSyncUsersVIEW/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/HcsSyncUsersVIEW/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/HcsSyncUsersVIEW/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/HcsSyncUsersVIEW", 
          "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/HcsSyncUsersVIEW.	GET	/api/view/HcsSyncUsersVIEW/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/HcsSyncUsersVIEW 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/HcsSyncUsersVIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/view/HcsSyncUsersVIEW/[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/HcsSyncUsersVIEW and the JSON format can be used to import instances of view/HcsSyncUsersVIEW.

For Bulk Export, refer to the Bulk Export section.

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

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

API Reference for view/HcsSyncUsersVIEW

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

Get the Add form

Create

Bulk Export

Export Bulk Load Template

List

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

Help

Instance API Reference

Export

Get

Help