[Index]
HcsLdapServerDAT
Model ref.: data/HcsLdapServerDAT
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": {
"organizationID": {
"is_password": false,
"description": "The organization ID assigned to the tenant in the Common Identity Store. This is not used currently and does not need to be initialized.",
"title": "Organization ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cucmLdapDirectoryName": {
"is_password": false,
"description": "The name of the LDAP Directory configured on CUCM that we want this user to be considered synced from. The LDAP Directory must be configured on CUCM already. This is an optional parameter but the following should be considered: For top down sync scenario, Users will be added to CUCM as Local Users if this parameter is not set. For bottom up sync scenario, Users will not be able to log on to CUCDM if this parameter is not set.",
"title": "CUCM LDAP Directory Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"adSyncMode": {
"is_password": false,
"description": "The mode in which users will be synced from the LDAP server. Currently, only Direct sync from the LDAP server is supported.",
"title": "AD Sync Mode",
"required": true,
"displayable": false,
"choices": [
{
"value": "Direct",
"title": "Direct"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"host": {
"is_password": false,
"description": "The assoicated LDAP server host.",
"title": "LDAP Server",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"uniqueId": {
"is_password": false,
"description": "This is an auto-generated internal identifier that does not need to be explicitly initialized.",
"title": "Unique ID",
"default": "Auto generated",
"required": false,
"displayable": true,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"port": {
"is_password": false,
"description": "The assoicated LDAP server port.",
"title": "Port",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"search_base_dn": {
"is_password": false,
"description": "The assoicated LDAP server Search Base Dn.",
"title": "Search_Base_Dn",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsLdapServerDAT/add/ |
|
The GUI Add form of data/HcsLdapServerDAT 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/data/HcsLdapServerDAT/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsLdapServerDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsLdapServerDAT/[pkid1]", "/api/data/HcsLdapServerDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsLdapServerDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsLdapServerDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsLdapServerDAT/export/ |
|
{ "hrefs":["/api/data/HcsLdapServerDAT/[pkid1]", "/api/data/HcsLdapServerDAT/[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 data/HcsLdapServerDAT and the JSON format can be used to import instances of data/HcsLdapServerDAT.
GET http://[host-proxy]/api/data/HcsLdapServerDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsLdapServerDAT | POST | /api/data/HcsLdapServerDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsLdapServerDAT/ |
|
The data/HcsLdapServerDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsLdapServerDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "host",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsLdapServerDAT/?skip=0&limit=3&order_by=host&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"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/data/HcsLdapServerDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsLdapServerDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsLdapServerDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsLdapServerDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsLdapServerDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsLdapServerDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsLdapServerDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "host",
"title": "LDAP Server"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search_Base_Dn"
},
{
"name": "uniqueId",
"title": "Unique ID"
},
{
"name": "adSyncMode",
"title": "AD Sync Mode"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae5bfce894e0012055b16",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5bfce894e0012055b16",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/"
}
],
"parent": [
{
"pkid": "5f3ae5bace894e00120559f8",
"href": "/api/data/HierarchyNode/5f3ae5bace894e00120559f8"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsLdapServerDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae5bfce894e0012055b16"
],
"summary_attrs": [
{
"name": "host",
"title": "LDAP Server"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search_Base_Dn"
},
{
"name": "uniqueId",
"title": "Unique ID"
},
{
"name": "adSyncMode",
"title": "AD Sync Mode"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"pkid": "5f3ae5bfce894e0012055b17",
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"adSyncMode": "Direct",
"host": "10.120.2.221",
"uniqueId": "1",
"hierarchy_friendly_name": "AB-C (IntermediateNode)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C",
"port": "389",
"cucmLdapDirectoryName": "AB-C"
}
},
{
"pkid": "5f3ae5ccce894e0012055cf5",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.2",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5ccce894e0012055cf5",
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/"
}
],
"parent": [
{
"pkid": "5f3ae5bbce894e0012055a46",
"href": "/api/data/HierarchyNode/5f3ae5bbce894e0012055a46"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/execute/",
"title": "Execute",
"class": "execute",
"method": "POST"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/HcsLdapServerDAT/5f3ae5ccce894e0012055cf5/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/HcsLdapServerDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bbce894e0012055a46",
"5f3ae5ccce894e0012055cf5"
],
"summary_attrs": [
{
"name": "host",
"title": "LDAP Server"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search_Base_Dn"
},
{
"name": "uniqueId",
"title": "Unique ID"
},
{
"name": "adSyncMode",
"title": "AD Sync Mode"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"pkid": "5f3ae5ccce894e0012055cf6",
"search_base_dn": "OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net",
"adSyncMode": "Direct",
"host": "10.120.2.221",
"uniqueId": "2",
"hierarchy_friendly_name": "AB-DS (IntermediateNode)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS",
"port": "389",
"cucmLdapDirectoryName": "AB-DS"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae5bfce894e0012055b16",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.2",
"references": {
"parent": [
{
"pkid": "5f3ae5bace894e00120559f8",
"href": "/api/data/HierarchyNode/5f3ae5bace894e00120559f8"
}
],
"self": [
{
"pkid": "5f3ae5bfce894e0012055b16",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsLdapServerDAT/5f3ae5bfce894e0012055b16/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsLdapServerDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae5bfce894e0012055b16"
],
"summary_attrs": [
{
"name": "host",
"title": "LDAP Server"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search_Base_Dn"
},
{
"name": "uniqueId",
"title": "Unique ID"
},
{
"name": "adSyncMode",
"title": "AD Sync Mode"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"adSyncMode": "Direct",
"pkid": "5f3ae5bfce894e0012055b17",
"cucmLdapDirectoryName": "AB-C",
"host": "10.120.2.221",
"uniqueId": "1",
"port": "389",
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsLdapServerDAT. | GET | /api/data/HcsLdapServerDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsLdapServerDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsLdapServerDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsLdapServerDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsLdapServerDAT/[pkid]/import/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/HcsLdapServerDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsLdapServerDAT/[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 data/HcsLdapServerDAT and the JSON format can be used to import instances of data/HcsLdapServerDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsLdapServerDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsLdapServerDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsLdapServerDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsLdapServerDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsLdapServerDAT. |