[Index]
Model ref.: device/cuc/Cos
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": {
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The unique text name of this COS , e.g. \"Default COS,\" \"Basic Voice Mail.\" Used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"OutsideCallers": {
"minItems": 0,
"type": "boolean",
"description": " It will set the Outside Caller to allow video greetings to be played and Message to be recorded",
"name": "OutsideCallers",
"title": "Outside Callers"
},
"XferRestrictionObjectId": {
"target_title": "DisplayName",
"description": "The unique identifier of the RestrictionTable object that Cisco Unity Connection uses to limit phone numbers that the subscriber can enter in call transfer settings.",
"title": "Xfer Restriction",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/RestrictionTable/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/RestrictionTable",
"type": "string",
"name": "XferRestrictionObjectId"
},
"AccessAdvancedUser": {
"minItems": 0,
"type": "boolean",
"description": "Duplicate of AdvnacedUserFeatures for licensing code purposes. A flag indicating whether or not the subscriber has access to advanced user features. Currently, there are two advanced user features: TTS and VUI.",
"name": "AccessAdvancedUser",
"title": "Access Advanced User"
},
"CanSendToPublicDl": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber can send messages to system (formerly called \"public\") distribution lists.",
"name": "CanSendToPublicDl",
"title": "Can Send To Public Dl"
},
"CallHoldAvailable": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to change their own call holding options by using the Cisco Unity Connection Assistant. Call holding settings apply when calls are transferred from the automated attendant or a directory handler to subscriber phones. They do not apply when an outsider caller or another subscriber dials a subscriber extension directly. ",
"name": "CallHoldAvailable",
"title": "Call Hold Available"
},
"EnableSTTSecureMessage": {
"minItems": 0,
"type": "integer",
"description": " Controls transcriptions and notification of secure messages for Speech To Text transcription feature.",
"name": "EnableSTTSecureMessage",
"title": "Enable STT Secure Message"
},
"ImapCanFetchMessageBody": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber can fetch the body of a non-private message using IMAP.",
"name": "ImapCanFetchMessageBody",
"title": "Imap Can Fetch Message Body"
},
"AccessUnifiedClient": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber can use the unified client.",
"name": "AccessUnifiedClient",
"title": "Access Unified Client"
},
"UpdateBroadcastMessage": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.",
"name": "UpdateBroadcastMessage",
"title": "Update Broadcast Message"
},
"EnableEnhancedSecurity": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber uses regular or enhanced phone security. Enhanced phone security adds RSA two-factor authentication to regular security.",
"name": "EnableEnhancedSecurity",
"title": "Enable Enhanced Security"
},
"MovetoDeleteFolder": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection moves deleted messages for the subscriber to a Deleted Items folder or physically deletes the message.\n\nTrue='deletion' moves messages to the DeletedItems folder, where it ages until it evaporates. False='deletion' physically deletes the message",
"name": "MovetoDeleteFolder",
"title": "Moveto Delete Folder"
},
"FaxRestrictionObjectId": {
"target_title": "DisplayName",
"description": "The unique identifier for the RestrictionTable object that Cisco Unity Connection uses to limit phone numbers that the subscriber can enter in fax dialing settings.",
"title": "Fax Restriction",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/RestrictionTable/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/RestrictionTable",
"type": "string",
"name": "FaxRestrictionObjectId"
},
"MessagePlaybackRestriction": {
"minItems": 0,
"type": "integer",
"description": " Playback restrictions for GUI clients",
"name": "MessagePlaybackRestriction",
"title": "Message Playback Restriction"
},
"OutcallRestrictionObjectId": {
"target_title": "DisplayName",
"description": "The unique identifier of the RestrictionTable object that Cisco Unity Connection uses to limit phone numbers that the subscriber can enter in message delivery settings. The restriction table also restricts the subscriber extensions that Cisco Unity Connection dials when the phone is selected as the recording and playback device for the Media Master.",
"title": "Outcall Restriction",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/RestrictionTable/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/RestrictionTable",
"type": "string",
"name": "OutcallRestrictionObjectId"
},
"MaxNameLength": {
"minItems": 0,
"type": "integer",
"description": " The maximum recording length (in seconds) allowed to the subscriber for recording their voice name.",
"name": "MaxNameLength",
"title": "Max Name Length"
},
"LocationObjectId": {
"target_title": "DisplayName",
"description": "The unique identifier of the LocationVMS to which this COS belongs.",
"title": "Location",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/ConnectionLocation/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/ConnectionLocation",
"type": "string",
"name": "LocationObjectId"
},
"WarnMinMsgLength": {
"minItems": 0,
"type": "integer",
"description": " The minimum length (in milliseconds) that the maximum recording time has to be before the record termination warning feature is active. When the record termination feature is active, Cisco Unity Connection plays a warning tone indicating to the caller that they are almost out of recording time.",
"name": "WarnMinMsgLength",
"title": "Warn Min Msg Length"
},
"PlaybackMessageAndGreetings": {
"minItems": 0,
"type": "boolean",
"description": " It will allow users to playback and record video greetings and messages.",
"name": "PlaybackMessageAndGreetings",
"title": "Playback Message And Greetings"
},
"ImapCanFetchPrivateMessageBody": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber can fetch the body of a private message using IMAP.",
"name": "ImapCanFetchPrivateMessageBody",
"title": "Imap Can Fetch Private Message Body"
},
"WarnIntervalMsgEnd": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in milliseconds) before the end of the maximum recording time when Cisco Unity Connection will play a warning tone or WAV file to indicate to the caller that they are almost out of recording time.",
"name": "WarnIntervalMsgEnd",
"title": "Warn Interval Msg End"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a COS object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"AccessLiveReply": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can after listening to a message from another subscriber press 4-4, and Cisco Unity Connection will call the subscriber who left the message. Generally referred to as \"Live Reply.\"",
"name": "AccessLiveReply",
"title": "Access Live Reply"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MaxMembersPVL": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of members allowed in a personal voice mail list.",
"name": "MaxMembersPVL",
"title": "Max Members PVL"
},
"AccessFaxMail": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS is allowed to manage their fax messages over the phone or from the Cisco Unity Connection Inbox.",
"name": "AccessFaxMail",
"title": "Access Fax Mail"
},
"MaxPrivateDlists": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of personal voice mail lists the subscriber is allowed to create.",
"name": "MaxPrivateDlists",
"title": "Max Private Dlists"
},
"AccessVmi": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can use the Cisco Unity Connection Inbox to listen to, compose, reply to, forward, and delete voice messages. If the subscriber has \"AccessFaxMail\" set, they can also use it to manage their faxes. This is a licensed feature.",
"name": "AccessVmi",
"title": "Access Vmi"
},
"AccessIMAP": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can access VM via an IMAP client.",
"name": "AccessIMAP",
"title": "Access IMAP"
},
"AccessAdvancedUserFeatures": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether or not the subscriber has access to advanced user features. Currently, there are two advanced user features: TTS and VUI.",
"name": "AccessAdvancedUserFeatures",
"title": "Access Advanced User Features"
},
"AccessTts": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can have to their e-mail messages read to them by an e-mail reader over the phone.",
"name": "AccessTts",
"title": "Access Tts"
},
"UaAlternateExtensionAccess": {
"minItems": 0,
"type": "integer",
"description": " The abilities a subscriber has to manage administer-defined alternate extensions assigned to the subscriber. Determines whether subscribers can view the administrator-defined alternate extensions, and whether subscribers can manage (add, modify, and delete) their own set of alternate extensions in the Cisco Unity Assistant. If enabled, subscribers can define up to 5 alternate extensions in addition to the 9 alternate extensions that an administrator can define for them.",
"name": "UaAlternateExtensionAccess",
"title": "Ua Alternate Extension Access"
},
"Undeletable": {
"description": " A flag indicating whether this COS can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.",
"title": "Undeletable",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "Undeletable"
},
"PersonalAdministrator": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection allows a subscriber to use the Cisco Unity Assistant to personalize their Cisco Unity Connection setting -- including their recorded greetings and message delivery options -- or to set up message notification devices and create private lists. ",
"name": "PersonalAdministrator",
"title": "Personal Administrator"
},
"CallScreenAvailable": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to change their own call screening options by using the Cisco Unity Assistant. Call screening settings apply when calls are transferred from the automated attendant or a directory handler to subscriber phones. They do not apply when an outsider caller or another subscriber dials a subscriber extension directly. ",
"name": "CallScreenAvailable",
"title": "Call Screen Available"
},
"CanRecordName": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber can record their own name. ",
"name": "CanRecordName",
"title": "Can Record Name"
},
"MaxMsgLength": {
"minItems": 0,
"type": "integer",
"description": " The maximum recording length (in seconds) allowed to the subscriber for recording messages and conversations.",
"name": "MaxMsgLength",
"title": "Max Msg Length"
},
"AccessSTT": {
"minItems": 0,
"type": "boolean",
"description": " An integer value indicating whether a subscriber assigned this COS can have to their voice messages transcribed to text.",
"name": "AccessSTT",
"title": "Access STT"
},
"SttType": {
"minItems": 0,
"type": "integer",
"description": " An integer value indicating whether a subscriber assigned standard or PRO COS for STT.",
"name": "SttType",
"title": "Stt Type"
},
"RequireSecureMessages": {
"minItems": 0,
"type": "integer",
"description": " Specifies when to mark message secure",
"name": "RequireSecureMessages",
"title": "Require Secure Messages"
},
"AccessOutsideLiveReply": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber, assigned this COS, can after listening to a message from outside caller issue a command to call the outside caller . When a VUI or TUI command is issued, Cisco Unity Connection will call the outside caller who left the message. Generally referred to as \"Return Call to Outside Caller.\"\n\n",
"name": "AccessOutsideLiveReply",
"title": "Access Outside Live Reply"
},
"MaxGreetingLength": {
"minItems": 0,
"type": "integer",
"description": " The maximum recording length (in seconds) allowed to the subscriber for recording their greeting.",
"name": "MaxGreetingLength",
"title": "Max Greeting Length"
},
"ReadOnly": {
"description": " A flag indicating that this COS is read only. It cannot be modified from the SA.",
"title": "Read Only",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "ReadOnly"
},
"AccessCallRoutingRules": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can access personal call routing rules.",
"name": "AccessCallRoutingRules",
"title": "Access Call Routing Rules"
},
"AccessVui": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a subscriber assigned this COS can use the voice driven inbox conversation.",
"name": "AccessVui",
"title": "Access Vui"
},
"SendBroadcastMessage": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the subscriber has the ability to send broadcast messages to all subscribers on the VMS.",
"name": "SendBroadcastMessage",
"title": "Send Broadcast Message"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ListInDirectoryStatus": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether subscribers can choose to be listed or not in the phone directory. The phone directory (directory assistance) is the audio listing that subscribers and unidentified callers use to reach subscribers and to leave messages.",
"name": "ListInDirectoryStatus",
"title": "List In Directory Status"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/Cos/add/ |
|
The GUI Add form of device/cuc/Cos 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/Cos | 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/Cos/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/Cos/[pkid1]", "/api/device/cuc/Cos/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/Cos/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/Cos/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/Cos/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Cos/[pkid1]", "/api/v0/device/cuc/Cos/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Cos/?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/Cos |
|
{"hrefs": ["/api/device/cuc/Cos/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Cos |
|
{"hrefs": ["/api/device/cuc/Cos/[pkid1]", "/api/device/cuc/Cos/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Cos; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Cos/export/ |
|
{ "hrefs":["/api/device/cuc/Cos/[pkid1]", "/api/device/cuc/Cos/[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/Cos and the JSON format can be used to import instances of device/cuc/Cos.
GET http://[host-proxy]/api/device/cuc/Cos/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Cos | POST | /api/device/cuc/Cos/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/Cos/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/Cos/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/Cos/ |
|
The device/cuc/Cos schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Cos instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/Cos/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"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/Cos/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Cos/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/Cos/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/Cos",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Cos/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/Cos/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/Cos/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/Cos/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/Cos/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Cos/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Cos/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Cos",
"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"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae6cdce894e0012058dc7",
"meta": {
"tags": [],
"cached": true,
"title": "System",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6cdce894e0012058dc7",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cdce894e0012058dc7/?model_type=device/cuc/Cos",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Cos",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cdce894e0012058dc7"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DisplayName": "System",
"OutsideCallers": false,
"XferRestrictionObjectId": "52563b56-03af-4275-8ac4-c19796bee72e",
"AccessAdvancedUser": false,
"CanSendToPublicDl": true,
"CallHoldAvailable": false,
"EnableSTTSecureMessage": 0,
"ImapCanFetchMessageBody": true,
"AccessUnifiedClient": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"UpdateBroadcastMessage": false,
"EnableEnhancedSecurity": false,
"ListInDirectoryStatus": true,
"MovetoDeleteFolder": true,
"FaxRestrictionObjectId": "04d00953-1223-46ef-a440-fdb161e979d4",
"MessagePlaybackRestriction": 0,
"OutcallRestrictionObjectId": "0159bc6e-6485-491c-bdff-ccd276ced516",
"MaxNameLength": 30,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"PlaybackMessageAndGreetings": false,
"ImapCanFetchPrivateMessageBody": false,
"WarnIntervalMsgEnd": 0,
"AccessCallRoutingRules": false,
"ObjectId": "c93a1e7e-57f4-4fa8-89ef-1cd7f8816651",
"AccessLiveReply": false,
"URI": "/vmrest/coses/c93a1e7e-57f4-4fa8-89ef-1cd7f8816651",
"MaxMembersPVL": 99,
"AccessFaxMail": false,
"MaxPrivateDlists": 25,
"WarnMinMsgLength": 0,
"AccessIMAP": true,
"AccessAdvancedUserFeatures": false,
"AccessTts": false,
"UaAlternateExtensionAccess": 0,
"Undeletable": true,
"PersonalAdministrator": true,
"CallScreenAvailable": false,
"CanRecordName": true,
"MaxMsgLength": 300,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"AccessSTT": false,
"SendBroadcastMessage": false,
"RequireSecureMessages": 4,
"MaxGreetingLength": 90,
"ReadOnly": true,
"AccessVmi": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"AccessVui": false,
"SttType": 1,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"AccessOutsideLiveReply": false
}
},
{
"pkid": "5f3ae6cdce894e0012058dce",
"meta": {
"tags": [],
"cached": true,
"title": "Voice Mail User COS",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae6cdce894e0012058dce",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cdce894e0012058dce/?model_type=device/cuc/Cos",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dce/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/Cos",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cdce894e0012058dce"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DisplayName": "Voice Mail User COS",
"hierarchy": "5f3ae552ce894e00120537fa",
"OutsideCallers": false,
"XferRestrictionObjectId": "52563b56-03af-4275-8ac4-c19796bee72e",
"AccessAdvancedUser": false,
"CanSendToPublicDl": true,
"CallHoldAvailable": false,
"EnableSTTSecureMessage": 0,
"ImapCanFetchMessageBody": true,
"AccessUnifiedClient": false,
"hierarchy_friendly_name": "AB_Group (Customer)",
"UpdateBroadcastMessage": false,
"EnableEnhancedSecurity": false,
"ListInDirectoryStatus": true,
"MovetoDeleteFolder": true,
"FaxRestrictionObjectId": "04d00953-1223-46ef-a440-fdb161e979d4",
"MessagePlaybackRestriction": 0,
"OutcallRestrictionObjectId": "0159bc6e-6485-491c-bdff-ccd276ced516",
"MaxNameLength": 30,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"PlaybackMessageAndGreetings": false,
"ImapCanFetchPrivateMessageBody": false,
"WarnIntervalMsgEnd": 0,
"AccessCallRoutingRules": false,
"ObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"AccessLiveReply": false,
"URI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"MaxMembersPVL": 99,
"AccessFaxMail": false,
"MaxPrivateDlists": 25,
"WarnMinMsgLength": 0,
"AccessIMAP": false,
"AccessAdvancedUserFeatures": false,
"AccessTts": false,
"UaAlternateExtensionAccess": 0,
"Undeletable": true,
"PersonalAdministrator": true,
"CallScreenAvailable": false,
"CanRecordName": true,
"MaxMsgLength": 300,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"AccessSTT": false,
"SendBroadcastMessage": false,
"RequireSecureMessages": 4,
"MaxGreetingLength": 90,
"ReadOnly": false,
"AccessVmi": false,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"AccessVui": false,
"SttType": 1,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"AccessOutsideLiveReply": false
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6cdce894e0012058dc7",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "System",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6cdce894e0012058dc7",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cdce894e0012058dc7/?hierarchy=[hierarchy]&model_type=device/cuc/Cos",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Cos/5f3ae6cdce894e0012058dc7/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Cos",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cdce894e0012058dc7"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DisplayName": "System",
"OutsideCallers": false,
"XferRestrictionObjectId": "52563b56-03af-4275-8ac4-c19796bee72e",
"AccessAdvancedUser": false,
"CanSendToPublicDl": true,
"CallHoldAvailable": false,
"EnableSTTSecureMessage": 0,
"ImapCanFetchMessageBody": true,
"AccessUnifiedClient": false,
"UpdateBroadcastMessage": false,
"EnableEnhancedSecurity": false,
"MovetoDeleteFolder": true,
"FaxRestrictionObjectId": "04d00953-1223-46ef-a440-fdb161e979d4",
"MessagePlaybackRestriction": 0,
"OutcallRestrictionObjectId": "0159bc6e-6485-491c-bdff-ccd276ced516",
"MaxNameLength": 30,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"PlaybackMessageAndGreetings": false,
"ImapCanFetchPrivateMessageBody": false,
"WarnIntervalMsgEnd": 0,
"AccessVmi": true,
"ObjectId": "c93a1e7e-57f4-4fa8-89ef-1cd7f8816651",
"AccessLiveReply": false,
"URI": "/vmrest/coses/c93a1e7e-57f4-4fa8-89ef-1cd7f8816651",
"MaxMembersPVL": 99,
"AccessFaxMail": false,
"MaxPrivateDlists": 25,
"WarnMinMsgLength": 0,
"ListInDirectoryStatus": true,
"AccessAdvancedUserFeatures": false,
"AccessTts": false,
"UaAlternateExtensionAccess": 0,
"Undeletable": true,
"PersonalAdministrator": true,
"CallScreenAvailable": false,
"CanRecordName": true,
"MaxMsgLength": 300,
"AccessSTT": false,
"SttType": 1,
"RequireSecureMessages": 4,
"AccessOutsideLiveReply": false,
"MaxGreetingLength": 90,
"ReadOnly": true,
"AccessCallRoutingRules": false,
"AccessVui": false,
"SendBroadcastMessage": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"AccessIMAP": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/Cos. | GET | /api/device/cuc/Cos/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Cos as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/Cos/[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/Cos/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Cos/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Cos/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Cos | 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/Cos; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Cos/[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/Cos and the JSON format can be used to import instances of device/cuc/Cos.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/Cos/[pkid] | hierarchy=[hierarchy] | The device/cuc/Cos instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/Cos/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Cos. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/Cos/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |