[Index]
Model ref.: device/skypeforbusinesshybrid/CsAnnouncement
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": { "AnnouncementId": { "__type_requested": "string", "required": false, "name": "AnnouncementId", "title": "AnnouncementId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Language": { "__type_requested": "String", "required": false, "description": "The language in which the text-to-speech (TTS) prompt will be played. If a value is entered for TextToSpeechPrompt, this parameter is required.\nValues are entered as a string representing the language and locale to be used. The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan)", "title": "Language", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Language" }, "Parent": { "__type_requested": "String", "required": false, "description": "This parameter is identical to Identity, except that Identity will accept the service Identity and the GUID, whereas Parent will accept only the service Identity; the GUID will be automatically generated. You cannot specify an Identity and a Parent.", "title": "Parent", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Parent" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "AudioFilePrompt": { "__type_requested": "String", "required": false, "description": "The name of the audio file to be played for the announcement. Audio files are stored in the File Store. To save an audio file to the File Store, use the Import-CsAnnouncementFile cmdlet.\nValid file types: WAV and WMA", "title": "AudioFilePrompt", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AudioFilePrompt" }, "TargetUri": { "__type_requested": "String", "required": false, "description": "The Uniform Resource Identifier (URI) to which the caller will be transferred after the announcement has been played. This value must be a SIP address entered in the format sip: followed by the SIP address. For example, sip:[email protected]. Note that the SIP address can also be a telephone number or voice mail, for example sip:[email protected];user=phone for a phone number or sip:[email protected];opaque=app:voicemail for voice mail.", "title": "TargetUri", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TargetUri" }, "Pool": { "name": "Pool", "title": "Pool", "required": false, "ignore": true, "readonly": false, "type": "string" }, "TextToSpeechPrompt": { "__type_requested": "String", "required": false, "description": "A text-to-speech (TTS) prompt. This is a string that will be converted to audio and played as the announcement.\nIf both AudioFilePrompt and TextToSpeechPrompt are specified for a single announcement, you will receive a warning that the audio file will take precedence and the TTS prompt will be ignored.", "title": "TextToSpeechPrompt", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TextToSpeechPrompt" }, "Identity": { "__type_requested": "System.String", "required": true, "description": "A unique identifier for the Announcement. For this value you must enter the Identity of the Application Server running the Response Group application. For example, ApplicationServer:redmond.litwareinc.com.\nMore than one Announcement can be assigned to a single service. Thus, in order to make the Identity a unique value, a globally unique identifier (GUID) will be automatically generated and assigned to the Identity when you create the Announcement. The new Announcement will have an Identity in the format service:<service ID>/<GUID>. For example: service: ApplicationServer:redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. You do not need to supply a GUID when you call this cmdlet. Instead, supply the service Identity, and the GUID will be auto-generated and added to the Identity.\nAlthough you don't have to supply a GUID, you can. You might want to do this if an announcement was assigned to an unassigned number range, and then the announcement was deleted. You can create a new announcement with a matching Identity (including the GUID) and in that case not have to update the unassigned number range.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "Name": { "__type_requested": "String", "required": true, "description": "A descriptive name for the Announcement. This name must be unique within the service. This name will be used in the call to the New-CsUnassignedNumber cmdlet or to the Set-CsUnassignedNumber cmdlet to specify the Announcement associated with an unassigned number range.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsAnnouncement 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/skypeforbusinesshybrid/CsAnnouncement/ | 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/skypeforbusinesshybrid/CsAnnouncement/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid1]", "/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsAnnouncement/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsAnnouncement/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsAnnouncement/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsAnnouncement |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsAnnouncement |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid1]", "/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsAnnouncement; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsAnnouncement/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid1]", "/api/device/skypeforbusinesshybrid/CsAnnouncement/[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/skypeforbusinesshybrid/CsAnnouncement and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsAnnouncement.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsAnnouncement | POST | /api/device/skypeforbusinesshybrid/CsAnnouncement/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/skypeforbusinesshybrid/CsAnnouncement/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/ |
|
The device/skypeforbusinesshybrid/CsAnnouncement schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsAnnouncement instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsAnnouncement/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1150", "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/skypeforbusinesshybrid/CsAnnouncement/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/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/skypeforbusinesshybrid/CsAnnouncement", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/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/skypeforbusinesshybrid/CsAnnouncement/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsAnnouncement/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsAnnouncement", "model_specific_actions": [ "get", "list", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "Language", "title": "Language" }, { "name": "TargetUri", "title": "TargetUri" }, { "name": "Identity", "title": "Identity" }, { "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/skypeforbusinesshybrid/CsAnnouncement. | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsAnnouncement as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsAnnouncement/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsAnnouncement | 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/skypeforbusinesshybrid/CsAnnouncement; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/[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/skypeforbusinesshybrid/CsAnnouncement and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsAnnouncement.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsAnnouncement instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsAnnouncement. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsAnnouncement/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |