[Index]
Model ref.: relation/HcsLdapServerREL
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": {
"description": {
"required": false,
"type": "string",
"description": "The description of the LDAP server.",
"title": "Description"
},
"host": {
"required": true,
"type": "string",
"description": "The host name of the LDAP server.",
"title": "Host Name"
},
"port": {
"default": "389",
"type": "string",
"description": "The port number for LDAP traffic. The ports a fully configurable.",
"title": "Port"
},
"user_dn": {
"required": true,
"type": "string",
"description": "The User Distinguished Name (DN) on the LDAP server.",
"title": "User DN"
},
"password": {
"is_password": true,
"description": "The administrator Password associated with the Username to connect to the LDAP server.",
"title": "Admin Password",
"required": true,
"store_encrypted": true,
"type": "string"
},
"search_base_dn": {
"required": true,
"type": "string",
"description": "The base Distinguished Name for LDAP search.",
"title": "Search Base DN"
},
"search_filter": {
"required": false,
"type": "string",
"description": "A RFC 2254 conformant string that is used to restrict the results retuned by list operations on the LDAP server.",
"title": "Search Filter"
},
"allow_write_back": {
"default": false,
"type": "boolean",
"description": "Enables Add, Modify and Delete operations for users on the the LDAP server.",
"title": "Enable Write Operations"
},
"server_type": {
"description": "The selected LDAP server type. The type can be Open LDAP or Microsoft Active Directory.",
"title": "Server Type",
"required": true,
"choices": [
{
"value": "microsoft_active_directory",
"title": "Microsoft Active Directory"
},
{
"value": "open_ldap",
"title": "Open LDAP"
}
],
"type": "string"
},
"auth_attribute": {
"required": false,
"type": "object",
"title": "Authentication Attribute",
"properties": {
"model_type": {
"description": "The model type to be used for authentication. The defualt choices are device/ldap/inetOrgPerson, device/ldap/person, and device/ldap/user. If the default choices do not fit the deployment scenario, custom values are allowed for this field.",
"title": "Model Type",
"required": false,
"choices": [
{
"value": "device/ldap/inetOrgPerson",
"title": "device/ldap/inetOrgPerson"
},
{
"value": "device/ldap/person",
"title": "device/ldap/person"
},
{
"value": "device/ldap/user",
"title": "device/ldap/user"
}
],
"type": "string"
},
"name": {
"required": false,
"type": "string",
"description": "The selected attribute of the LDAP user login. When Server Type is Microsoft Active Directory, the following default choices are populated employeeNumber, mail, sAMAccountName, telephoneNumber, userPrincipalName. When Server Type is Open LDAP, the following choices are populated employeeNumber, mail, telephoneNumber, uid. If the default choices do not fit the deployment, custom values are allowed for this field.",
"title": "Login Attribute Name"
}
}
},
"connection_security": {
"type": "object",
"title": "Connection Security",
"properties": {
"encryption_method": {
"description": "The encryption mechanism to be used. This can be No Encryption, Use SSL Encryption (ldaps://), or Use StartTLS Extension",
"title": "Encryption Method",
"default": "no_encryption",
"choices": [
{
"value": "no_encryption",
"title": "No Encryption"
},
{
"value": "ssl",
"title": "Use SSL Encryption (ldaps://)"
},
{
"value": "start_tls",
"title": "Use StartTLS Extension"
}
],
"type": "string"
},
"certificate_validation": {
"type": "object",
"description": "Specifies behavior for certificate validation eg. Trust all certificates (no validation).",
"title": "Certificate Validation",
"properties": {
"trust_all": {
"type": "boolean",
"description": "When enabled, the system will not check if the server's certificate is trusted.",
"title": "Trust All"
},
"server_root_certificate": {
"target": "/api/data/File/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Server Root Certificate",
"type": "string",
"description": "When trust_all is False, the LDAP server's SSL certificate will be validated against this root certificate. If this certificate is not specified, validation will done against any existing trusted CA certificates. Use this option for custom root certificates in (.pem format)",
"target_model_type": "data/File",
"choices": []
}
}
}
}
},
"advanced_configuration": {
"type": "object",
"description": "Advanced configuration settings.",
"title": "Advanced Configuration",
"properties": {
"custom_pk": {
"type": "string",
"description": "This field allows an administrator to specify the primary key attribute that will be used to retrieve records from the ldap server.",
"title": "Primary Key Attribute"
}
}
},
"data_sync_list": {
"items": {
"type": "object",
"properties": {
"model_type": {
"format": "uri",
"type": "string",
"description": "Model type whose attributes should be included (eg device/ldap/user)",
"title": "Model Type",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"attributes": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
}
}
},
"type": "array",
"description": "Attributes to be included for model type.",
"title": "Attributes"
}
}
},
"type": "array",
"description": "LDAP attributes to be included during data sync.",
"title": "Data Sync List"
},
"authentication": {
"type": "object",
"description": "Authentication settings.",
"title": "Authentication settings",
"properties": {
"scope": {
"description": "Hierarchical scope this server applies to",
"title": "Authentication Scope",
"default": "Down",
"choices": [
{
"value": "Local",
"title": "Current hierarchy level only"
},
{
"value": "Down",
"title": "Current hierarchy level and below"
}
],
"type": "string"
},
"user_type": {
"description": "Type of users that can authenticate against this server.",
"title": "User Sync Type",
"default": "Synced_only",
"choices": [
{
"value": "Synced_only",
"title": "LDAP synced users only"
},
{
"value": "All",
"title": "All users"
}
],
"type": "string"
},
"auth_enabled": {
"default": true,
"type": "boolean",
"description": "Authentication Enabled",
"title": "Authentication Enabled"
}
}
},
"ext": {
"title": "Ext",
"type": "object",
"properties": {
"host": {
"is_password": false,
"description": "The assoicated LDAP server host.",
"title": "LDAP Server",
"required": false,
"displayable": false,
"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"
},
"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"
},
"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"
},
"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"
}
}
},
"ldapsynclist": {
"title": "Ldapsynclist",
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "Note about certain fields that will always get synced.",
"title": "Note"
},
"ldap_sync_list_option": {
"description": "LDAP Sync List Option. Please Note: LDAP server sync will always sync in the following attributes, regardless of whether they are explicitly set in the sync list or not. (sAMAccountName, userPrincipalName, mail, cn, uid, description)",
"title": "LDAP Sync List Option",
"default": "none",
"choices": [
{
"value": "none",
"title": "No sync list - all fields will be synced"
},
{
"value": "manual",
"title": "Create sync list manually"
},
{
"value": "template",
"title": "Create sync list from template"
}
],
"type": "string"
},
"ldap_sync_list_template": {
"type": "string",
"description": "LDAP Sync List Template. A template contains a predefined list of fields that is normally used when syncing in LDAP servers.",
"title": "LDAP Sync List Template"
},
"ldap_sync_list_template_flag": {
"type": "boolean",
"description": "Flag to see if we need to show the LDAP Sync List Template field",
"title": "LDAP Sync List Template Flag"
}
}
}
},
"schema_version": "2.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsLdapServerREL/add/ |
|
The GUI Add form of relation/HcsLdapServerREL 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/relation/HcsLdapServerREL | 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/relation/HcsLdapServerREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsLdapServerREL/[pkid1]", "/api/relation/HcsLdapServerREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsLdapServerREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsLdapServerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsLdapServerREL/export/ |
|
{ "hrefs":["/api/relation/HcsLdapServerREL/[pkid1]", "/api/relation/HcsLdapServerREL/[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 relation/HcsLdapServerREL and the JSON format can be used to import instances of relation/HcsLdapServerREL.
GET http://[host-proxy]/api/relation/HcsLdapServerREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsLdapServerREL | POST | /api/relation/HcsLdapServerREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsLdapServerREL/ |
|
The relation/HcsLdapServerREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsLdapServerREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "description",
"direction": "asc",
"current": "/api/relation/HcsLdapServerREL/?skip=0&limit=3&order_by=description&direction=asc&traversal=down"
},
"operations": [
"update",
"help",
"remove",
"field_display_policy",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/HcsLdapServerREL",
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"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": [],
"self": [
{
"href": "/api/relation/HcsLdapServerREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"help",
"remove",
"add",
"export",
"list",
"get",
"export_bulkload_template"
],
"schema_version": "2.3",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsLdapServerREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsLdapServerREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsLdapServerREL/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/relation/HcsLdapServerREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsLdapServerREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsLdapServerREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"description": "AB_Group-Civil LDAP Server",
"server_type": "microsoft_active_directory",
"user_dn": "CN=Administrator,CN=Users,DC=vossqa,DC=net",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"host": "10.120.2.221",
"connection_security": {
"encryption_method": "no_encryption"
},
"password": "==$YW5SrHSx0lVhX2VF$7jRLNzAe5tE=$==",
"port": "389",
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"pkid": "5ae89f2aaffa931cce38d480",
"hierarchy_friendly_name": "AB-C (IntermediateNode)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C"
},
"meta": {
"model_type": "relation/HcsLdapServerREL",
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "10.120.2.221 - 389 - OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89f22affa931cce38d2f4",
"href": "/api/data/HierarchyNode/5ae89f22affa931cce38d2f4"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/",
"pkid": "5ae89f2aaffa931cce38d47f"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae89f2aaffa931cce38d47f"
],
"schema_version": "0.3.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89f2aaffa931cce38d47f"
},
{
"data": {
"description": "AB_Group-D&S LDAP Server",
"server_type": "microsoft_active_directory",
"pkid": "5aeb2666affa931cce4246d9",
"user_dn": "CN=Administrator,CN=Users,DC=vossqa,DC=net",
"port": "389",
"host": "10.120.2.221",
"connection_security": {
"encryption_method": "no_encryption"
},
"password": "==$jfI1I1eyuO712UHZ$OSQFJmDM4EU=$==",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"search_base_dn": "OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net",
"hierarchy_friendly_name": "AB-DS (IntermediateNode)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS"
},
"meta": {
"model_type": "relation/HcsLdapServerREL",
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "10.120.2.221 - 389 - OU=AB-DS,OU=AB-GROUP,DC=vossqa,DC=net",
"business_key": {
"hierarchy": true,
"unique": [
"host",
"port",
"search_base_dn"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89f25affa931cce38d369",
"href": "/api/data/HierarchyNode/5ae89f25affa931cce38d369"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/",
"pkid": "5aeb2666affa931cce4246d8"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f25affa931cce38d369",
"5aeb2666affa931cce4246d8"
],
"schema_version": "0.3.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsLdapServerREL/5aeb2666affa931cce4246d8/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5aeb2666affa931cce4246d8"
}
]
}
(Show the first instance)
{
"data": {
"description": "AB_Group-Civil LDAP Server",
"server_type": "microsoft_active_directory",
"user_dn": "CN=Administrator,CN=Users,DC=vossqa,DC=net",
"auth_attribute": {
"model_type": "device/ldap/user",
"name": "sAMAccountName"
},
"host": "10.120.2.221",
"connection_security": {
"encryption_method": "no_encryption"
},
"password": "==$YW5SrHSx0lVhX2VF$7jRLNzAe5tE=$==",
"port": "389",
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net",
"ext": {
"cucmLdapDirectoryName": "AB-C",
"adSyncMode": "Direct",
"host": "10.120.2.221",
"uniqueId": "1",
"port": "389",
"search_base_dn": "OU=AB-C,OU=AB-GROUP,DC=vossqa,DC=net"
}
},
"meta": {
"model_type": "relation/HcsLdapServerREL",
"summary_attrs": [
{
"name": "description",
"title": "Description"
},
{
"name": "host",
"title": "Host Name"
},
{
"name": "port",
"title": "Port"
},
{
"name": "search_base_dn",
"title": "Search Base DN"
},
{
"name": "server_type",
"title": "Server Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "AB_Group-Civil LDAP Server",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5ae89f22affa931cce38d2f4",
"href": "/api/data/HierarchyNode/5ae89f22affa931cce38d2f4"
}
],
"self": [
{
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/",
"pkid": "5ae89f2aaffa931cce38d47f"
}
]
},
"schema_version": "2.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsLdapServerREL/5ae89f2aaffa931cce38d47f/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ae89f2aaffa931cce38d47f"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsLdapServerREL. | GET | /api/relation/HcsLdapServerREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsLdapServerREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsLdapServerREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsLdapServerREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsLdapServerREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsLdapServerREL/[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 relation/HcsLdapServerREL and the JSON format can be used to import instances of relation/HcsLdapServerREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsLdapServerREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsLdapServerREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsLdapServerREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsLdapServerREL. |