[Index]
Model ref.: device/cuc/TenantExternalService
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": { "ResourceURI": { "minItems": 0, "type": "string", "description": " Resource URI", "name": "ResourceURI", "title": "Resource URI" }, "DisplayName": { "minItems": 0, "type": "string", "description": " A descriptive name for the external service.", "name": "DisplayName", "title": "Display Name" }, "UseServiceCredentials": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether to use service credentials rather than user credentials to logon to the external service.", "name": "UseServiceCredentials", "title": "Use Service Credentials" }, "ClientId": { "minItems": 0, "type": "string", "description": " client id from azure", "name": "ClientId", "title": "Client Id" }, "ExternalServiceResetURI": { "type": "string", "description": "The URI to reset external service.", "name": "ExternalServiceResetURI", "title": "External Service Reset URI" }, "ServiceAlias": { "minItems": 0, "type": "string", "description": " The unique text name (i.e., logon name) to use to logon to the external service.", "name": "ServiceAlias", "title": "Service Alias" }, "MailboxSynchFaxAction": { "minItems": 0, "type": "integer", "description": " Action to take for incoming FAX messages.", "name": "MailboxSynchFaxAction", "title": "Mailbox Synch Fax Action" }, "DirectoryID": { "minItems": 0, "type": "string", "description": " azure active directory id", "name": "DirectoryID", "title": "Directory ID" }, "ExchSite": { "minItems": 0, "type": "string", "description": " Name of the Exchange site to which to confine searches for domain controllers and Autodiscover servers.", "name": "ExchSite", "title": "Exch Site" }, "SupportsMailboxSynchCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the external service supports synchronizing mailbox contents between a Connection mailbox and an external, third-party mailbox.", "name": "SupportsMailboxSynchCapability", "title": "Supports Mailbox Synch Capability" }, "AuthenticationMode": { "minItems": 0, "type": "integer", "description": " The method of authentication used when authenticating via HTTP with the server hosting the service.", "name": "AuthenticationMode", "title": "Authentication Mode" }, "SupportsCalendarCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the external service supports the capabilities to access calendar information such as appointments, information for free/busy based PCTR rules, and for Exchange servers only, the capability to import a user's contacts from Exchange", "name": "SupportsCalendarCapability", "title": "Supports Calendar Capability" }, "isProxyAuthEnabled": { "minItems": 0, "type": "boolean", "description": " A flag to determine wheather proxy server needs authentication or not.", "name": "isProxyAuthEnabled", "title": "Is Proxy Auth Enabled" }, "ExchOrgDomain": { "minItems": 0, "type": "string", "description": " Root of the domain to search for autodiscovery", "name": "ExchOrgDomain", "title": "Exch Org Domain" }, "MailboxSynchEmailAction": { "minItems": 0, "type": "integer", "description": " Action to take for incoming emails", "name": "MailboxSynchEmailAction", "title": "Mailbox Synch Email Action" }, "LdapSecurityTransportType": { "minItems": 0, "type": "integer", "description": " The method of encryption used for LDAP.", "name": "LdapSecurityTransportType", "title": "Ldap Security Transport Type" }, "ExchDoAutodiscover2003": { "minItems": 0, "type": "boolean", "description": " Flag indicating whether Connection is permitted to search the network for the URL to log in each Exchange 2003 mailbox. This emulates the Exchange Autodiscovery feature which was available beginning with Exchange 2007. ", "name": "ExchDoAutodiscover2003", "title": "Exch Do Autodiscover2003" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for an external service object.", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "IsEnabled": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the external service is enabled.", "name": "IsEnabled", "title": "Is Enabled" }, "ServerType": { "minItems": 0, "type": "integer", "description": " The type of external service. Examples are MeetingPlace 7.0, Exchange 2003, and Exchange 2007.", "name": "ServerType", "title": "Server Type" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "ProxyPassword": { "minItems": 0, "type": "string", "description": " Pasword for proxy server authentication.", "name": "ProxyPassword", "title": "Proxy Password" }, "Server": { "minItems": 0, "type": "string", "description": " The name of the server which hosts the external service.", "name": "Server", "title": "Server" }, "TransferExtensionDialString": { "minItems": 0, "type": "string", "description": " The number dialed by Unity Connection to access (join) the Cisco Unified MeetingPlace\nmeeting.\n", "name": "TransferExtensionDialString", "title": "Transfer Extension Dial String" }, "TenantObjectId": { "description": " TenantObjectId associated with External Service. - template parameter [1]", "format": "uri", "minItems": 0, "title": "Tenant Object Id", "required": true, "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/Tenant/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/Tenant", "type": [ "string" ], "name": "TenantObjectId" }, "ValidateServerCertificate": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether server certificates should be validated against a trust-certificate when establishing an HTTPS connection. ", "name": "ValidateServerCertificate", "title": "Validate Server Certificate" }, "ClientSecret": { "minItems": 0, "type": "string", "description": " client secret from azure", "name": "ClientSecret", "title": "Client Secret" }, "SupportsMeetingCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the external service supports the capability to access meeting information from a server. For example, allowing a user to receive notification of a meeting about ready to start, providing join meeting and cancel meeting capabilities on the server, and allowing a user to schedule a meeting on the server,", "name": "SupportsMeetingCapability", "title": "Supports Meeting Capability" }, "LdapValidateServerCertificate": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether server certificates should be validated against a trust-certificate when establishing an LDAPS connection. ", "name": "LdapValidateServerCertificate", "title": "Ldap Validate Server Certificate" }, "ExchDoAutodiscover": { "minItems": 0, "type": "boolean", "description": " Flag indicating whether Connection is permitted to search the network for the URL to log in each Exchange 2007 or above mailbox. Connection may use the Exchange Autodiscovery feature (which was first available in Exchange 2007) in combination with LDAP and DNS calls to identify the URL.", "name": "ExchDoAutodiscover", "title": "Exch Do Autodiscover" }, "AdAuthenticationEndpoint": { "minItems": 0, "type": "string", "description": " URL to connect AD Authentication Endpoint", "name": "AdAuthenticationEndpoint", "title": "Ad Authentication Endpoint" }, "ProxyServer": { "minItems": 0, "type": "string", "description": " IP address or Hostname for Proxy Server", "name": "ProxyServer", "title": "Proxy Server" }, "ProxyUsername": { "minItems": 0, "type": "string", "description": " User name for proxy server authentication.", "name": "ProxyUsername", "title": "Proxy Username" }, "SupportsTtsOfEmailCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the external service supports the capability to access an email store for the purpose of playing the email via TTS. ", "name": "SupportsTtsOfEmailCapability", "title": "Supports Tts Of Email Capability" }, "ServicePassword": { "minItems": 0, "type": "string", "description": " The password for logon to the external service.", "name": "ServicePassword", "title": "Service Password" }, "SecurityTransportType": { "minItems": 0, "type": "integer", "description": " The method of encryption used for HTTP sessions to/from the external service.", "name": "SecurityTransportType", "title": "Security Transport Type" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/TenantExternalService/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/TenantExternalService/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TenantExternalService/[pkid1]", "/api/v0/device/cuc/TenantExternalService/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/TenantExternalService/?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/TenantExternalService |
|
{"hrefs": ["/api/device/cuc/TenantExternalService/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/TenantExternalService |
|
{"hrefs": ["/api/device/cuc/TenantExternalService/[pkid1]", "/api/device/cuc/TenantExternalService/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/TenantExternalService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/TenantExternalService/export/ |
|
{ "hrefs":["/api/device/cuc/TenantExternalService/[pkid1]", "/api/device/cuc/TenantExternalService/[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/TenantExternalService and the JSON format can be used to import instances of device/cuc/TenantExternalService.
GET http://[host-proxy]/api/device/cuc/TenantExternalService/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/TenantExternalService | POST | /api/device/cuc/TenantExternalService/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/TenantExternalService/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/TenantExternalService/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/TenantExternalService/ |
|
The device/cuc/TenantExternalService schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/TenantExternalService instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/TenantExternalService/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "14.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/TenantExternalService/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/TenantExternalService", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/TenantExternalService/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/TenantExternalService/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/TenantExternalService/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/TenantExternalService/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/TenantExternalService/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/TenantExternalService/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/TenantExternalService/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/TenantExternalService", "model_specific_actions": [ "list", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/TenantExternalService. | GET | /api/device/cuc/TenantExternalService/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/TenantExternalService as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/TenantExternalService/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/TenantExternalService/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/TenantExternalService | 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/TenantExternalService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/TenantExternalService/[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/TenantExternalService and the JSON format can be used to import instances of device/cuc/TenantExternalService.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/TenantExternalService/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/TenantExternalService. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/TenantExternalService/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |