[Index]
Model ref.: device/cuc/Tenant
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": { "PartitionsURI": { "readonly": true, "title": "Partitions URI", "type": "string", "description": "URI to get details on the ScheduleSets associated with this tenant.", "name": "PartitionsURI" }, "PartitionObjectId": { "target_title": "Name", "description": "ObjectId of the Partition associated with a tenant", "title": "Partition Name", "format": "uri", "name": "PartitionObjectId", "target_attr": "ObjectId", "readonly": true, "type": "string", "target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/Partition", "choices": [] }, "Name": { "minItems": 0, "title": "Name", "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" }, "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, "title": "Coses URI", "type": "string", "description": "URI to get details on the Coses associated with this tenant.", "name": "CosesURI" }, "PhoneSystemURI": { "name": "PhoneSystemURI", "title": "Phone System URI", "minItems": 0, "format": "uri", "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "choices": [] }, "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", "title": "URI", "minItems": 0, "format": "uri", "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "choices": [] }, "MailboxStoreObjectId": { "target_title": "DisplayName", "description": "Mailbox Store for the tenant.", "title": "Mailbox Store", "format": "uri", "name": "MailboxStoreObjectId", "target_attr": "ObjectId", "readonly": true, "type": "string", "target": "/api/device/cuc/MailboxStore/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/MailboxStore", "choices": [] }, "TimeZone": { "description": " TimeZone this Tenant is operating in.", "title": "Time Zone", "minItems": 0, "readonly": true, "type": "integer", "name": "TimeZone" }, "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" }, "ExternalServicesURI": { "readonly": true, "title": "External Services URI", "type": "string", "description": "URI to get details on the External Service associated with this tenant", "name": "ExternalServicesURI" }, "PhoneSystemsURI": { "readonly": true, "title": "Phone Systems URI", "type": "string", "description": "URI to get details on the Phone Systems associated with this tenant.", "name": "PhoneSystemsURI" }, "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, "title": "Pilot Number", "type": "string", "description": " The unique pilot number assigned to this Tenant. ", "name": "PilotNumber" }, "OperatorsURI": { "readonly": true, "title": "Operators URI", "type": "string", "description": "URI to get details on the Operator associated with this tenant", "name": "OperatorsURI" }, "ScheduleSetsURI": { "readonly": true, "title": "Schedule Sets URI", "type": "string", "description": "URI to get details on the ScheduleSets associated with this tenant.", "name": "ScheduleSetsURI" }, "CreationDate": { "description": " This column holds creation date of each tenant on Connection.", "title": "Creation Date", "minItems": 0, "readonly": true, "type": "string", "name": "CreationDate" }, "MediaSwitchObjectId": { "target_title": "DisplayName", "description": "Phone System to be used for the Tenant.", "format": "uri", "minItems": 0, "title": "Media Switch", "name": "MediaSwitchObjectId", "target_attr": "ObjectId", "readonly": true, "type": "string", "target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/PhoneSystem", "choices": [] }, "Description": { "minItems": 0, "title": "Description", "type": "string", "description": " This column contains detail description of every Tenant.", "name": "Description" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/Tenant/add/ |
|
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] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
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]", ...]} |
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/Tenant/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/Tenant/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Tenant/[pkid1]", "/api/v0/device/cuc/Tenant/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/Tenant |
|
{"hrefs": ["/api/device/cuc/Tenant/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Tenant |
|
{"hrefs": ["/api/device/cuc/Tenant/[pkid1]", "/api/device/cuc/Tenant/[pkid2]",...]} |
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/ |
|
{ "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.
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/ |
|
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 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 http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/Tenant/ |
|
The device/cuc/Tenant schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Tenant instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "Name", "direction": "asc", "current": "/api/device/cuc/Tenant/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down" }, "operations": [ "move" ], "meta": { "model_type": "device/cuc/Tenant", "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "Alias", "title": "Alias" }, { "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": [ "add", "list", "update", "get", "remove", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "schema_version": "14.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/device/cuc/Tenant/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/device/cuc/Tenant/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/device/cuc/Tenant/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "move": { "method": "POST", "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/Tenant", "support_async": true, "title": "Move", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "method": "POST", "class": "export", "href": "/api/device/cuc/Tenant/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/device/cuc/Tenant/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/device/cuc/Tenant/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/device/cuc/Tenant/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "list": { "method": "GET", "class": "list", "href": "/api/device/cuc/Tenant/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/device/cuc/Tenant/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } }, { "purge": { "method": "POST", "class": "purge", "href": "/api/device/cuc/Tenant/purge/?hierarchy=[hierarchy]", "support_async": false, "title": "Purge" } } ] }, "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 |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Purge | POST | /api/device/cuc/Tenant/purge/ |
|
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] |
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 |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Tenant/?hierarchy=[hierarchy]&format=json
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 |
|
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: |