[Index]
Model ref.: view/HcsManageUsersVIEW
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": {
"action": {
"is_password": false,
"description": "The action to perform against the selected users. This attribute is deprecated and user_action should be used instead.",
"title": "Action",
"minItems": 0,
"required": false,
"displayable": false,
"choices": [
{
"value": "UpsertToCucm",
"title": "Add or update users to CUCM"
},
{
"value": "RemoveFromCucm",
"title": "Remove users from CUCM"
}
],
"readonly": false,
"type": "string"
},
"user_action": {
"is_password": false,
"description": "The action to perform against the selected users.",
"title": "Action",
"minItems": 0,
"required": false,
"displayable": false,
"choices": [
{
"value": "UpsertToCucm",
"title": "Add or update users to CUCM"
},
{
"value": "RemoveFromCucm",
"title": "Remove users from CUCM"
}
],
"readonly": false,
"type": "string"
},
"usernames": {
"is_password": false,
"description": "Names of users who will be affected by the specified action.",
"title": "Users",
"minItems": 0,
"items": {
"type": "string"
},
"required": false,
"displayable": false,
"readonly": false,
"type": "array"
},
"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"
},
"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"
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/HcsManageUsersVIEW/add/ |
|
The GUI Add form of view/HcsManageUsersVIEW 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/HcsManageUsersVIEW | 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 | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of view/HcsManageUsersVIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/view/HcsManageUsersVIEW/export/ |
|
{ "hrefs":["/api/view/HcsManageUsersVIEW/[pkid1]", "/api/view/HcsManageUsersVIEW/[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/HcsManageUsersVIEW and the JSON format can be used to import instances of view/HcsManageUsersVIEW.
GET http://[host-proxy]/api/view/HcsManageUsersVIEW/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/HcsManageUsersVIEW | POST | /api/view/HcsManageUsersVIEW/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/HcsManageUsersVIEW/ |
|
The view/HcsManageUsersVIEW schema and all instances as JSON. |
(The list will return 0 to 3 view/HcsManageUsersVIEW 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/HcsManageUsersVIEW/?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.3",
"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/HcsManageUsersVIEW/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/view/HcsManageUsersVIEW/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/HcsManageUsersVIEW/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/HcsManageUsersVIEW/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/HcsManageUsersVIEW/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/HcsManageUsersVIEW",
"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/HcsManageUsersVIEW. | GET | /api/view/HcsManageUsersVIEW/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/HcsManageUsersVIEW as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of view/HcsManageUsersVIEW; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/view/HcsManageUsersVIEW/[pkid]/export |
|
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/HcsManageUsersVIEW and the JSON format can be used to import instances of view/HcsManageUsersVIEW.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/HcsManageUsersVIEW/[pkid] | hierarchy=[hierarchy] | The view/HcsManageUsersVIEW instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/HcsManageUsersVIEW/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/HcsManageUsersVIEW. |