API Reference for device/genericcucm/DoLdapSync

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

[pkid] is the ID of the resource instance. Refer to the List reference below.

[filename] refers to a file

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

(The list will return 0 to 3 device/genericcucm/DoLdapSync instances)

GET http://[host]/api/device/genericcucm/DoLdapSync/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "name",
          "direction": "asc",
          "current": "/api/device/genericcucm/DoLdapSync/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
     },
     "operations": [
          "list"
     ],
     "meta": {
          "model_type": "device/genericcucm/DoLdapSync",
          "summary_attrs": [
               {
                    "name": "name",
                    "title": "Name"
               },
               {
                    "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": []
          },
          "model_specific_actions": [
               "list"
          ],
          "schema_version": "11.5",
          "actions": [
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/genericcucm/DoLdapSync/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/genericcucm/DoLdapSync/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/genericcucm/DoLdapSync/purge/	hierarchy=[hierarchy] format=json

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	GET	/api/device/genericcucm/DoLdapSync/[pkid]	hierarchy=[hierarchy]	The device/genericcucm/DoLdapSync instance with [pkid].

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/genericcucm/DoLdapSync/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/genericcucm/DoLdapSync

GET http://[host-proxy]/api/device/genericcucm/DoLdapSync/schema/?hierarchy=[hierarchy]&format=json&schema=1

List

GET http://[host]/api/device/genericcucm/DoLdapSync/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Purge

Instance API Reference

Get

Purge