[Index]
Model ref.: device/skypeforbusinesshybrid/CsRgsQueue
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": { "Name": { "__type_requested": "String", "required": true, "description": "Unique name to be assigned to the queue. The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue's globally unique identifier (GUID).", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "OwnerPool": { "__type_requested": "Microsoft.Rtc.Management.Deploy.Fqdn", "required": false, "name": "OwnerPool", "title": "OwnerPool", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "OverflowThreshold": { "__type_requested": "System.Nullable[int16]", "required": false, "description": "Number of simultaneous calls that can be in the queue at any one time before the overflow action is triggered. The OverflowThreshold can be any integer value between 0 and 1000, inclusive. The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time.", "title": "OverflowThreshold", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "OverflowThreshold" }, "OverflowCandidate": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.OverflowCandidate", "required": false, "description": "Indicates which call will be acted upon should the overflow threshold be reached. The OverflowCandidate property must be set to one of the following two values:\nNewestCall\nOldestCall\nThe default value is NewestCall.", "title": "OverflowCandidate", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "OverflowCandidate" }, "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" }, "TimeoutAction": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction", "required": false, "description": "Action to be taken if the timeout threshold is reached. The TimeoutAction must be created using the New-CsRgsCallAction cmdlet.", "title": "TimeoutAction", "__type_mapping_type": "Complex.CallAction", "readonly": false, "type": "object", "properties": { "Action": { "choices": [ [ "Terminate", "The call is terminated" ], [ "TransferToQueue", "The call is transferred to a Response Group queue" ], [ "TransferToQuestion", "The call is transferred to a Response Group question" ], [ "TransferToUri", "The call is transferred to the specified SIP Uniform Resource Identifier " ], [ "TransferToPSTN", "The call is transferred to a public switched telephone network (PSTN) telephone" ] ], "type": "string", "name": "Action", "title": "Action" }, "Prompt": { "type": "object", "properties": { "TextToSpeechPrompt": { "type": "string", "name": "TextToSpeechPrompt", "title": "TextToSpeechPrompt" }, "AudioFilePrompt": { "ignore": true, "readonly": true, "type": "string", "name": "AudioFilePrompt", "title": "AudioFilePrompt" } }, "name": "Prompt", "title": "Prompt" }, "Question": { "type": "string", "name": "Question", "title": "Question" }, "Uri": { "type": "string", "name": "Uri", "title": "Uri" }, "QueueID": { "target_title": "Name", "target": "/api/device/skypeforbusinesshybrid/CsRgsQueue/choices/?choice_title=Name&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "QueueID", "choices": [], "target_attr": "Identity", "target_model_type": "device/skypeforbusinesshybrid/CsRgsQueue", "type": "string", "name": "QueueID" } }, "name": "TimeoutAction" }, "Parent": { "__type_requested": "RgsIdentity", "required": true, "description": "Service where the new queue will be hosted. For example: -Parent \"service:ApplicationServer:atl-cs-001.litwareinc.com\".", "title": "Parent", "__type_mapping_type": "Complex.RgsIdentity", "readonly": false, "type": "string", "name": "Parent" }, "OverflowAction": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction", "required": false, "description": "Action to be taken if the overflow threshold is reached. The OverflowAction must be created using the New-CsRgsCallAction cmdlet.", "title": "OverflowAction", "__type_mapping_type": "Complex.CallAction", "readonly": false, "type": "object", "properties": { "Action": { "choices": [ [ "Terminate", "The call is terminated" ], [ "TransferToQueue", "The call is transferred to a Response Group queue" ], [ "TransferToQuestion", "The call is transferred to a Response Group question" ], [ "TransferToUri", "The call is transferred to the specified SIP Uniform Resource Identifier " ], [ "TransferToPSTN", "The call is transferred to a public switched telephone network (PSTN) telephone" ] ], "type": "string", "name": "Action", "title": "Action" }, "Prompt": { "type": "object", "properties": { "TextToSpeechPrompt": { "type": "string", "name": "TextToSpeechPrompt", "title": "TextToSpeechPrompt" }, "AudioFilePrompt": { "ignore": true, "readonly": true, "type": "string", "name": "AudioFilePrompt", "title": "AudioFilePrompt" } }, "name": "Prompt", "title": "Prompt" }, "Question": { "type": "string", "name": "Question", "title": "Question" }, "Uri": { "type": "string", "name": "Uri", "title": "Uri" }, "QueueID": { "target_title": "Name", "target": "/api/device/skypeforbusinesshybrid/CsRgsQueue/choices/?choice_title=Name&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "QueueID", "choices": [], "target_attr": "Identity", "target_model_type": "device/skypeforbusinesshybrid/CsRgsQueue", "type": "string", "name": "QueueID" } }, "name": "OverflowAction" }, "AgentGroupIDList": { "__type_requested": "System.Collections.ObjectModel.Collection[Microsoft.Rtc.Rgs.Management.RgsIdentity]", "required": false, "description": "Identity of the Response Group agent groups to be added to the queue. The agent group Identities can be retrieved using the Get-CsRgsAgentGroup cmdlet. For details, see the Examples section in this topic.\nIf a call is routed to a queue that has no agent groups assigned to it (or has only been assigned agent groups that do not have any agents) then that call will automatically be disconnected.", "title": "AgentGroupIDList", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AgentGroupIDList" }, "TimeoutThreshold": { "__type_requested": "Int32", "required": false, "description": "Amount of time (in seconds) that a call can be in the queue before that call times out. At that point, the system will take the action specified by the TimeoutAction parameter.\nThe timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out.", "title": "TimeoutThreshold", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "TimeoutThreshold" }, "Identity": { "__type_requested": "Microsoft.Rtc.Rgs.Management.RgsIdentity", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "Complex.RgsIdentity", "readonly": true, "type": "string", "description": "Represents either the Identity of the service where the Response Group queue is hosted or the full Identity of the queue itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group queues hosted on that service will be returned. If you specify the Identity of the queue, then only the specified Response Group queue will be returned. Note that the Identity of a queue consists of the service Identity followed by a globally unique identifier (GUID); for example: service:ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83.\nAn alternate way to return a single Response Group queue is to specify the service Identity, then include the Name parameter and the queue name. That enables you to retrieve a specific Response Group queue without having to know the GUID assigned to that queue.\nIf called without any parameters, Get-CsRgsQueue returns all the Response Group queues configured for use in your organization." }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide additional information about the Response Group queue.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsRgsQueue 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/CsRgsQueue/ | 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/CsRgsQueue/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsQueue/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsRgsQueue/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsRgsQueue/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsRgsQueue/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsQueue/?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/CsRgsQueue |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsRgsQueue |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsRgsQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsRgsQueue/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsQueue/[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/CsRgsQueue and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsQueue.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsQueue/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsRgsQueue | POST | /api/device/skypeforbusinesshybrid/CsRgsQueue/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/CsRgsQueue/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/CsRgsQueue/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/ |
|
The device/skypeforbusinesshybrid/CsRgsQueue schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsRgsQueue instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsRgsQueue/?skip=0&limit=3&order_by=Description&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/CsRgsQueue/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/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/CsRgsQueue", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/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/CsRgsQueue/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsRgsQueue/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsRgsQueue", "model_specific_actions": [ "get", "list", "add", "remove", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Description", "title": "Description" }, { "name": "Name", "title": "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/skypeforbusinesshybrid/CsRgsQueue. | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsRgsQueue as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsRgsQueue/[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/CsRgsQueue/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsQueue/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsRgsQueue | 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/CsRgsQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/[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/CsRgsQueue and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsQueue.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsRgsQueue instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsRgsQueue. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsRgsQueue/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |