API Reference for device/cuc/TenantExternalService

Model ref.: device/cuc/TenantExternalService

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/TenantExternalService/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "ResourceURI": {
               "minItems": 0,
               "title": "Resource URI",
               "type": "string",
               "description": " Resource URI",
               "name": "ResourceURI"
          },
          "DisplayName": {
               "minItems": 0,
               "title": "Display Name",
               "type": "string",
               "description": " A descriptive name for the external service.",
               "name": "DisplayName"
          },
          "UseServiceCredentials": {
               "minItems": 0,
               "title": "Use Service Credentials",
               "type": "boolean",
               "description": " A flag indicating whether to use service credentials rather than user credentials to logon to the external service.",
               "name": "UseServiceCredentials"
          },
          "ClientId": {
               "minItems": 0,
               "title": "Client Id",
               "type": "string",
               "description": " client id from azure",
               "name": "ClientId"
          },
          "ExternalServiceResetURI": {
               "title": "External Service Reset URI",
               "type": "string",
               "description": "The URI to reset external service.",
               "name": "ExternalServiceResetURI"
          },
          "ServiceAlias": {
               "minItems": 0,
               "title": "Service Alias",
               "type": "string",
               "description": " The unique text name (i.e., logon name) to use to logon to the external service.",
               "name": "ServiceAlias"
          },
          "AuthenticationMode": {
               "minItems": 0,
               "title": "Authentication Mode",
               "type": "integer",
               "description": " The method of authentication used when authenticating via HTTP with the server hosting the service.",
               "name": "AuthenticationMode"
          },
          "DirectoryID": {
               "minItems": 0,
               "title": "Directory ID",
               "type": "string",
               "description": " azure active directory id",
               "name": "DirectoryID"
          },
          "ExchSite": {
               "minItems": 0,
               "title": "Exch Site",
               "type": "string",
               "description": " Name of the Exchange site to which to confine searches for domain controllers and Autodiscover servers.",
               "name": "ExchSite"
          },
          "SupportsMailboxSynchCapability": {
               "minItems": 0,
               "title": "Supports Mailbox Synch Capability",
               "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"
          },
          "MailboxSynchFaxAction": {
               "minItems": 0,
               "title": "Mailbox Synch Fax Action",
               "type": "integer",
               "description": " Action to take for incoming FAX messages.",
               "name": "MailboxSynchFaxAction"
          },
          "SupportsCalendarCapability": {
               "minItems": 0,
               "title": "Supports Calendar Capability",
               "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"
          },
          "isProxyAuthEnabled": {
               "minItems": 0,
               "title": "Is Proxy Auth Enabled",
               "type": "boolean",
               "description": " A flag to determine wheather proxy server needs authentication or not.",
               "name": "isProxyAuthEnabled"
          },
          "ExchOrgDomain": {
               "minItems": 0,
               "title": "Exch Org Domain",
               "type": "string",
               "description": " Root of the domain to search for autodiscovery",
               "name": "ExchOrgDomain"
          },
          "MailboxSynchEmailAction": {
               "minItems": 0,
               "title": "Mailbox Synch Email Action",
               "type": "integer",
               "description": " Action to take for incoming emails",
               "name": "MailboxSynchEmailAction"
          },
          "LdapSecurityTransportType": {
               "minItems": 0,
               "title": "Ldap Security Transport Type",
               "type": "integer",
               "description": " The method of encryption used for LDAP.",
               "name": "LdapSecurityTransportType"
          },
          "ExchDoAutodiscover2003": {
               "minItems": 0,
               "title": "Exch Do Autodiscover2003",
               "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"
          },
          "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,
               "title": "Is Enabled",
               "type": "boolean",
               "description": " A flag indicating whether the external service is enabled.",
               "name": "IsEnabled"
          },
          "ServerType": {
               "minItems": 0,
               "title": "Server Type",
               "type": "integer",
               "description": " The type of external service.  Examples are MeetingPlace 7.0, Exchange 2003, and Exchange 2007.",
               "name": "ServerType"
          },
          "URI": {
               "minItems": 0,
               "title": "URI",
               "type": "string",
               "name": "URI",
               "format": "uri",
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "choices": []
          },
          "ProxyPassword": {
               "minItems": 0,
               "title": "Proxy Password",
               "type": "string",
               "description": " Pasword for proxy server authentication.",
               "name": "ProxyPassword"
          },
          "Server": {
               "minItems": 0,
               "title": "Server",
               "type": "string",
               "description": " The name of the server which hosts the external service.",
               "name": "Server"
          },
          "TransferExtensionDialString": {
               "minItems": 0,
               "title": "Transfer Extension Dial String",
               "type": "string",
               "description": " The number dialed by Unity Connection to access (join) the Cisco Unified MeetingPlace\nmeeting.\n",
               "name": "TransferExtensionDialString"
          },
          "TenantObjectId": {
               "target": "/api/device/cuc/Tenant/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "format": "uri",
               "minItems": 0,
               "required": true,
               "name": "TenantObjectId",
               "target_attr": "ObjectId",
               "title": "Tenant Object Id",
               "type": [
                    "string"
               ],
               "description": " TenantObjectId associated with External Service. - template parameter [1]",
               "target_model_type": "device/cuc/Tenant",
               "choices": []
          },
          "ClientSecret": {
               "minItems": 0,
               "title": "Client Secret",
               "type": "string",
               "description": " client secret from azure",
               "name": "ClientSecret"
          },
          "SupportsMeetingCapability": {
               "minItems": 0,
               "title": "Supports Meeting Capability",
               "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"
          },
          "SecurityTransportType": {
               "minItems": 0,
               "title": "Security Transport Type",
               "type": "integer",
               "description": " The method of encryption used for HTTP sessions to/from the external service.",
               "name": "SecurityTransportType"
          },
          "ExchDoAutodiscover": {
               "minItems": 0,
               "title": "Exch Do Autodiscover",
               "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"
          },
          "ValidateServerCertificate": {
               "minItems": 0,
               "title": "Validate Server Certificate",
               "type": "boolean",
               "description": " A flag indicating whether server certificates should be validated against a trust-certificate when establishing an HTTPS connection. ",
               "name": "ValidateServerCertificate"
          },
          "AdAuthenticationEndpoint": {
               "minItems": 0,
               "title": "Ad Authentication Endpoint",
               "type": "string",
               "description": " URL to connect AD Authentication Endpoint",
               "name": "AdAuthenticationEndpoint"
          },
          "ProxyServer": {
               "minItems": 0,
               "title": "Proxy Server",
               "type": "string",
               "description": " IP address or Hostname for Proxy Server",
               "name": "ProxyServer"
          },
          "ProxyUsername": {
               "minItems": 0,
               "title": "Proxy Username",
               "type": "string",
               "description": " User name for proxy server authentication.",
               "name": "ProxyUsername"
          },
          "SupportsTtsOfEmailCapability": {
               "minItems": 0,
               "title": "Supports Tts Of Email Capability",
               "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"
          },
          "ServicePassword": {
               "minItems": 0,
               "title": "Service Password",
               "type": "string",
               "description": " The password for logon to the external service.",
               "name": "ServicePassword"
          },
          "LdapValidateServerCertificate": {
               "minItems": 0,
               "title": "Ldap Validate Server Certificate",
               "type": "boolean",
               "description": " A flag indicating whether server certificates should be validated against a trust-certificate when establishing an LDAPS connection. ",
               "name": "LdapValidateServerCertificate"
          }
     },
     "schema_version": "14.0"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/TenantExternalService/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/TenantExternalService device/cuc/TenantExternalService schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/TenantExternalService/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TenantExternalService/[pkid1]", "/api/v0/device/cuc/TenantExternalService/[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/TenantExternalService/?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/TenantExternalService	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/TenantExternalService/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/TenantExternalService	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/TenantExternalService/[pkid1]", "/api/device/cuc/TenantExternalService/[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/TenantExternalService/?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/TenantExternalService; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/TenantExternalService/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "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.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for 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/	hierarchy=[hierarchy] modeltype=device/cuc/TenantExternalService	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 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/TenantExternalService/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/TenantExternalService/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/TenantExternalService schema and all instances as JSON.

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

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "DisplayName",
          "direction": "asc",
          "current": "/api/device/cuc/TenantExternalService/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
     },
     "operations": [
          "move"
     ],
     "meta": {
          "model_type": "device/cuc/TenantExternalService",
          "summary_attrs": [
               {
                    "name": "DisplayName",
                    "title": "Display 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",
               "bulk_update_form",
               "clone",
               "configuration_template",
               "export",
               "export_bulkload_template",
               "field_display_policy",
               "help",
               "move"
          ],
          "schema_version": "14.0",
          "actions": [
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/device/cuc/TenantExternalService/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/TenantExternalService",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/cuc/TenantExternalService/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/TenantExternalService/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/cuc/TenantExternalService/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/cuc/TenantExternalService/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/cuc/TenantExternalService/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/cuc/TenantExternalService/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/cuc/TenantExternalService/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "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
Purge	POST	/api/device/cuc/TenantExternalService/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
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/TenantExternalService/[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/TenantExternalService

GET http://[host-proxy]/api/device/cuc/TenantExternalService/?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/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	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/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:

API Reference for device/cuc/TenantExternalService

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

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Purge

Instance API Reference

Clone

Move

Export

Help

Purge