[Index]
Model ref.: device/skypeforbusinesshybrid/CsRgsAgentGroup
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 agent group. The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group'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" }, "ParticipationPolicy": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.ParticipationPolicy", "required": false, "description": "Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. If ParticipationPolicy is set to Informal (the default value) sign-in is not required. If ParticipationPolicy is set to Formal then sign-in is required.", "title": "ParticipationPolicy", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ParticipationPolicy" }, "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" }, "AgentAlertTime": { "__type_requested": "int16", "required": false, "description": "Represents the amount of time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 10 and 600 seconds (10 minutes), inclusive. The default value is 20 seconds. Note: The Agent alert time setting cannot exceed 180 seconds. If it exceeds 180 seconds, the client application will reject the call due to the SIP transaction timer reaching its maximum wait time. To avoid this, set the Alert Time value to less than 180 seconds.", "title": "AgentAlertTime", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AgentAlertTime" }, "RoutingMethod": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.RoutingMethod", "required": false, "description": "Specifies the method used to route new calls to agents. The RoutingMethod must be set to one of the following values:\nLongestIdle - Calls are routed to the agent who has been idle (that is, not involved in a Skype for Business activity) for the longest period of time.\nRoundRobin - Calls are routed to the next agent on the list.\nSerial - Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time.\nParallel - Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable.\nAttendant - Calls are routed to all agents at the same time, even if the agent's presence status indicates that he or she is in a call or otherwise unavailable. The only exception occurs when an agent has set his or her presence to Do Not Disturb.\nThe default routing method is Parallel.", "title": "RoutingMethod", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "RoutingMethod" }, "AgentsByUri": { "__type_requested": "System.Collections.ObjectModel.Collection[uri]", "required": false, "description": "Enables you to individually add agents to an agent group. New agents are identified using their SIP addresses.\nNote that you can only select users who have been enabled for Enterprise Voice.", "title": "AgentsByUri", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "AgentsByUri" }, "DistributionGroupAddress": { "__type_requested": "String", "required": false, "description": "Enables you to add all the members of a distribution group to an agent group.", "title": "DistributionGroupAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DistributionGroupAddress" }, "Parent": { "__type_requested": "RgsIdentity", "required": true, "description": "Service where the new agent group 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" }, "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 agent group is hosted or the full Identity of the agent group itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com) then all the agent groups hosted on that service will be returned. If you specify the Identity of the group, then only the specified agent group will be returned. Note that the Identity of an agent group 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 group is to specify the service Identity, then include the Name parameter and the agent group name. That enables you to retrieve a specific agent group without having to know the GUID assigned to that group.\nIf called without any parameters, Get-CsRgsAgentGroup returns a collection of all the agent groups configured for use in your organization." }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide additional, explanatory information about the agent group. For example, the Description might contain information about who to contact if the group does not receive the expected phone calls.", "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/CsRgsAgentGroup/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsRgsAgentGroup 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/CsRgsAgentGroup/ | 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/CsRgsAgentGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?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/CsRgsAgentGroup |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsRgsAgentGroup |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsRgsAgentGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[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/CsRgsAgentGroup and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsAgentGroup.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsRgsAgentGroup | POST | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/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/CsRgsAgentGroup/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/CsRgsAgentGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/ |
|
The device/skypeforbusinesshybrid/CsRgsAgentGroup schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsRgsAgentGroup instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?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/CsRgsAgentGroup/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/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/CsRgsAgentGroup", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/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/CsRgsAgentGroup/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsRgsAgentGroup", "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": "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/CsRgsAgentGroup. | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsRgsAgentGroup as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[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/CsRgsAgentGroup/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsAgentGroup/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsRgsAgentGroup | 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/CsRgsAgentGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[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/CsRgsAgentGroup and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsAgentGroup.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsRgsAgentGroup instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsRgsAgentGroup. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsRgsAgentGroup/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |