[Index]
Model ref.: device/cuc/TemplateExternalServiceAccount
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": { "EnableTtsOfEmailCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the capability to access an email store for the purpose of playing the email via TTS is enabled for the user. ", "name": "EnableTtsOfEmailCapability", "title": "Enable Tts Of Email Capability" }, "ExternalServiceObjectId": { "minItems": 0, "type": "string", "description": " A foreign key to an ExternalService. The unique identifier of the external service object that is associated with the user template.", "name": "ExternalServiceObjectId", "title": "External Service Object Id" }, "EnableMailboxSynchCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether synchronization of mailbox contents between Connection and an external/third-party mail system is enabled.", "name": "EnableMailboxSynchCapability", "title": "Enable Mailbox Synch Capability" }, "IsPrimaryMeetingService": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this external service is the user's primary meeting service. A user is only allowed to schedule meetings on the MeetingPlace server that is designated as the user?s primary meeting service. This column applies only to a ServerType of MeetingPlace, and EnableMeetingCapability must be enabled.", "name": "IsPrimaryMeetingService", "title": "Is Primary Meeting Service" }, "ObjectId": { "description": "template parameter [2]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "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] }, "LoginType": { "minItems": 0, "type": "integer", "description": " Type of login to use - user alias, login as guest, or login using UserId. Applies only to MeetingPlace external service.", "name": "LoginType", "title": "Login Type" }, "UserTemplateDisplayName": { "minItems": 0, "type": "string", "description": " The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.", "name": "UserTemplateDisplayName", "title": "User Template Display Name" }, "EnableMeetingCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the capability to access meeting information from a server is enabled for the user. 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": "EnableMeetingCapability", "title": "Enable Meeting Capability" }, "EmailAddressUseCorp": { "minItems": 0, "type": "boolean", "description": " Flag indicating whether to use the EmailAddress specified or the corporate e-mail address specified on the owning User", "name": "EmailAddressUseCorp", "title": "Email Address Use Corp" }, "DisplayName": { "minItems": 0, "type": "string", "description": " A descriptive name for the external service.", "name": "DisplayName", "title": "Display Name" }, "UserTemplateURI": { "name": "UserTemplateURI", "format": "uri", "minItems": 0, "title": "User Template URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "EnableCalendarCapability": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether 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 is enabled for the user. ", "name": "EnableCalendarCapability", "title": "Enable Calendar Capability" }, "UserTemplateObjectId": { "description": " A foreign key to User Template. The unique identifier of the template object that is associated with the external service. - template parameter [1]", "format": "uri", "minItems": 0, "title": "User Template Object Id", "required": true, "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/UserTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/UserTemplate", "type": [ "string" ], "name": "UserTemplateObjectId" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/TemplateExternalServiceAccount/add/ |
|
The GUI Add form of device/cuc/TemplateExternalServiceAccount 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/TemplateExternalServiceAccount | 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/TemplateExternalServiceAccount/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/TemplateExternalServiceAccount/[pkid1]", "/api/device/cuc/TemplateExternalServiceAccount/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/TemplateExternalServiceAccount/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/TemplateExternalServiceAccount/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/TemplateExternalServiceAccount/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TemplateExternalServiceAccount/[pkid1]", "/api/v0/device/cuc/TemplateExternalServiceAccount/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/TemplateExternalServiceAccount/?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/TemplateExternalServiceAccount |
|
{"hrefs": ["/api/device/cuc/TemplateExternalServiceAccount/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/TemplateExternalServiceAccount |
|
{"hrefs": ["/api/device/cuc/TemplateExternalServiceAccount/[pkid1]", "/api/device/cuc/TemplateExternalServiceAccount/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/TemplateExternalServiceAccount; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/TemplateExternalServiceAccount/export/ |
|
{ "hrefs":["/api/device/cuc/TemplateExternalServiceAccount/[pkid1]", "/api/device/cuc/TemplateExternalServiceAccount/[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/TemplateExternalServiceAccount and the JSON format can be used to import instances of device/cuc/TemplateExternalServiceAccount.
GET http://[host-proxy]/api/device/cuc/TemplateExternalServiceAccount/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/TemplateExternalServiceAccount | POST | /api/device/cuc/TemplateExternalServiceAccount/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/TemplateExternalServiceAccount/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/TemplateExternalServiceAccount/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/TemplateExternalServiceAccount/ |
|
The device/cuc/TemplateExternalServiceAccount schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/TemplateExternalServiceAccount instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/TemplateExternalServiceAccount/?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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/TemplateExternalServiceAccount/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/TemplateExternalServiceAccount/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/TemplateExternalServiceAccount/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/TemplateExternalServiceAccount", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/TemplateExternalServiceAccount/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/TemplateExternalServiceAccount/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/TemplateExternalServiceAccount/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/TemplateExternalServiceAccount/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/TemplateExternalServiceAccount/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/TemplateExternalServiceAccount/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/TemplateExternalServiceAccount/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/TemplateExternalServiceAccount", "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": "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/TemplateExternalServiceAccount. | GET | /api/device/cuc/TemplateExternalServiceAccount/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/TemplateExternalServiceAccount as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/TemplateExternalServiceAccount/[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/TemplateExternalServiceAccount/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/TemplateExternalServiceAccount/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/TemplateExternalServiceAccount/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/TemplateExternalServiceAccount | 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/TemplateExternalServiceAccount; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/TemplateExternalServiceAccount/[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/TemplateExternalServiceAccount and the JSON format can be used to import instances of device/cuc/TemplateExternalServiceAccount.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/TemplateExternalServiceAccount/[pkid] | hierarchy=[hierarchy] | The device/cuc/TemplateExternalServiceAccount instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/TemplateExternalServiceAccount/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/TemplateExternalServiceAccount. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/TemplateExternalServiceAccount/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |