API Reference for device/cuc/Tenant

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

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "PartitionsURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the ScheduleSets associated with this tenant.", 
               "name": "PartitionsURI", 
               "title": "Partitions URI"
          }, 
          "PartitionObjectId": {
               "target_attr": "ObjectId", 
               "description": "ObjectId of the Partition associated with a tenant", 
               "format": "uri", 
               "title": "Partition Name", 
               "choices": [], 
               "target_title": "Name", 
               "readonly": true, 
               "target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/Partition", 
               "type": "string", 
               "name": "PartitionObjectId"
          }, 
          "Name": {
               "minItems": 0, 
               "type": "string", 
               "description": " The preferred text name of a tenant to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.", 
               "name": "Name", 
               "title": "Name"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a  Tenant. - template parameter [1]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "CosesURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the Coses associated with this tenant.", 
               "name": "CosesURI", 
               "title": "Coses URI"
          }, 
          "MediaSwitchObjectId": {
               "target_attr": "ObjectId", 
               "description": "Phone System to be used for the Tenant.", 
               "title": "Media Switch", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "target_title": "DisplayName", 
               "readonly": true, 
               "target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/PhoneSystem", 
               "type": "string", 
               "name": "MediaSwitchObjectId"
          }, 
          "ScheduleSetsURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the ScheduleSets associated with this tenant.", 
               "name": "ScheduleSetsURI", 
               "title": "Schedule Sets URI"
          }, 
          "SmtpDomain": {
               "description": " This column contains the domain of each tenant.The domain portion (right-half) of an internet-addressable address (for example,vm-tenant.com). ", 
               "title": "Smtp Domain", 
               "minItems": 0, 
               "required": true, 
               "readonly": true, 
               "type": "string", 
               "name": "SmtpDomain"
          }, 
          "URI": {
               "name": "URI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "URI", 
               "choices": [], 
               "readonly": true, 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "MailboxStoreObjectId": {
               "target_attr": "ObjectId", 
               "description": "Mailbox Store for the tenant.", 
               "format": "uri", 
               "title": "Mailbox Store", 
               "choices": [], 
               "target_title": "DisplayName", 
               "readonly": true, 
               "target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/MailboxStore", 
               "type": "string", 
               "name": "MailboxStoreObjectId"
          }, 
          "PhoneSystemURI": {
               "name": "PhoneSystemURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Phone System URI", 
               "choices": [], 
               "readonly": true, 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "Alias": {
               "description": " The unique text name of this Tenant, e.g. \"ABC.\"  Used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.", 
               "title": "Alias", 
               "minItems": 0, 
               "required": true, 
               "readonly": true, 
               "type": "string", 
               "name": "Alias"
          }, 
          "PhoneSystemsURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the Phone Systems associated with this tenant.", 
               "name": "PhoneSystemsURI", 
               "title": "Phone Systems URI"
          }, 
          "Language": {
               "description": " This is the language specific to Tenant.", 
               "title": "Language", 
               "minItems": 0, 
               "choices": [
                    [
                         1033, 
                         "English(UnitedStates)"
                    ]
               ], 
               "readonly": true, 
               "type": "integer", 
               "name": "Language"
          }, 
          "PilotNumber": {
               "minItems": 0, 
               "type": "string", 
               "description": " The unique pilot number assigned to this Tenant. ", 
               "name": "PilotNumber", 
               "title": "Pilot Number"
          }, 
          "OperatorsURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the Operator associated with this tenant", 
               "name": "OperatorsURI", 
               "title": "Operators URI"
          }, 
          "TimeZone": {
               "description": " TimeZone this Tenant is operating in.", 
               "title": "Time Zone", 
               "minItems": 0, 
               "readonly": true, 
               "type": "integer", 
               "name": "TimeZone"
          }, 
          "CreationDate": {
               "description": " This column holds creation date of each tenant on Connection.", 
               "title": "Creation Date", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "CreationDate"
          }, 
          "ExternalServicesURI": {
               "readonly": true, 
               "type": "string", 
               "description": "URI to get details on the External Service associated with this tenant", 
               "name": "ExternalServicesURI", 
               "title": "External Services URI"
          }, 
          "Description": {
               "minItems": 0, 
               "type": "string", 
               "description": " This column contains detail description of every Tenant.", 
               "name": "Description", 
               "title": "Description"
          }
     }, 
     "schema_version": "12.5"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/cuc/Tenant/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/cuc/Tenant 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/device/cuc/Tenant/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Descendants:

device/cuc/Callhandler DisplayName startswith {Alias}: added
device/cuc/CallhandlerTemplate DisplayName startswith {Alias}: added
device/cuc/Partition ObjectId is {PartitionObjectId}: added
device/cuc/PhoneSystem ObjectId is {MediaSwitchObjectId}: added
device/cuc/Cos DisplayName startswith {Alias}: added
device/cuc/DistributionList DisplayName startswith {Alias}: added
device/cuc/RoutingRule DisplayName startswith {Alias}: added
device/cuc/Schedule DisplayName startswith {Alias}: added
device/cuc/ScheduleSet DisplayName startswith {Alias}: added
device/cuc/SearchSpace Name startswith {Alias}: added
device/cuc/User Alias startswith {Alias}: added
device/cuc/UserTemplate Alias startswith {Alias}: added

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/cuc/Tenant/	hierarchy=[hierarchy]	{"hrefs":["/api/device/cuc/Tenant/[pkid1]", "/api/device/cuc/Tenant/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/cuc/Tenant
```
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json
```

Descendants:

device/cuc/Callhandler DisplayName startswith {Alias}: deleted
device/cuc/CallhandlerTemplate DisplayName startswith {Alias}: deleted
device/cuc/Partition ObjectId is {PartitionObjectId}: deleted
device/cuc/PhoneSystem ObjectId is {MediaSwitchObjectId}: deleted
device/cuc/Cos DisplayName startswith {Alias}: deleted
device/cuc/DistributionList DisplayName startswith {Alias}: deleted
device/cuc/RoutingRule DisplayName startswith {Alias}: deleted
device/cuc/Schedule DisplayName startswith {Alias}: deleted
device/cuc/ScheduleSet DisplayName startswith {Alias}: deleted
device/cuc/SearchSpace Name startswith {Alias}: deleted
device/cuc/User Alias startswith {Alias}: deleted
device/cuc/UserTemplate Alias startswith {Alias}: deleted

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/Tenant/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/Tenant device/cuc/Tenant schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/Tenant/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Tenant/[pkid1]", "/api/v0/device/cuc/Tenant/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
```
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json
```
The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/Tenant	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/Tenant/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/Tenant	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/Tenant/[pkid1]", "/api/device/cuc/Tenant/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Tenant; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/Tenant/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/Tenant/[pkid1]", "/api/device/cuc/Tenant/[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 device/cuc/Tenant and the JSON format can be used to import instances of device/cuc/Tenant.

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

 GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/Tenant/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/Tenant/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

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

(The list will return 0 to 3 device/cuc/Tenant instances)

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/Tenant/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "12.5", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/cuc/Tenant/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/cuc/Tenant/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/Tenant/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/Tenant", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/Tenant/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/cuc/Tenant/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/Tenant/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/Tenant/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/Tenant/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/Tenant/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/Tenant/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/Tenant", 
          "model_specific_actions": [
               "add", 
               "list", 
               "update", 
               "get", 
               "remove", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Name", 
                    "title": "Name"
               }, 
               {
                    "name": "Alias", 
                    "title": "Alias"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "19.3.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/Tenant.	GET	/api/device/cuc/Tenant/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/Tenant 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	Payload
Modify	PUT	/api/device/cuc/Tenant/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/cuc/Tenant/[pkid]/	hierarchy=[hierarchy]

Descendants:

device/cuc/Callhandler DisplayName startswith {Alias}: deleted
device/cuc/CallhandlerTemplate DisplayName startswith {Alias}: deleted
device/cuc/Partition ObjectId is {PartitionObjectId}: deleted
device/cuc/PhoneSystem ObjectId is {MediaSwitchObjectId}: deleted
device/cuc/Cos DisplayName startswith {Alias}: deleted
device/cuc/DistributionList DisplayName startswith {Alias}: deleted
device/cuc/RoutingRule DisplayName startswith {Alias}: deleted
device/cuc/Schedule DisplayName startswith {Alias}: deleted
device/cuc/ScheduleSet DisplayName startswith {Alias}: deleted
device/cuc/SearchSpace Name startswith {Alias}: deleted
device/cuc/User Alias startswith {Alias}: deleted
device/cuc/UserTemplate Alias startswith {Alias}: deleted

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/Tenant/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cuc/Tenant

GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/Tenant	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 device/cuc/Tenant; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/Tenant/[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 device/cuc/Tenant and the JSON format can be used to import instances of device/cuc/Tenant.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/Tenant/[pkid]/	hierarchy=[hierarchy]	The device/cuc/Tenant instance with [pkid].

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

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

API Reference for device/cuc/Tenant

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

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge