[Index]
Model ref.: device/skypeforbusinesshybrid/CsRgsWorkflow
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": { "DisplayNumber": { "__type_requested": "String", "required": false, "description": "Phone number for the workflow as displayed in Skype for Business. The DisplayNumber can be formatted any way you want; for example:\n-DisplayNumber \"555-1219\"\n-DisplayNumber \"1-(425)-555-1219\"\n-DisplayNumber \"1.425.555.1219\"", "title": "DisplayNumber", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayNumber" }, "TimeZone": { "__type_requested": "String", "required": false, "description": "Time zone information used when determining holidays and business hours. For example: -TimeZone \"Pacific Standard Time\"", "title": "TimeZone", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "TimeZone" }, "CustomMusicOnHoldFile": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.AudioFile", "required": false, "description": "Represents custom music to be played when callers are placed on hold. (If not defined, callers will hear the default music when placed on hold.) Custom music must be imported by using the Import-CsRgsAudioFile cmdlet.", "title": "CustomMusicOnHoldFile", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "CustomMusicOnHoldFile" }, "OwnerPool": { "__type_requested": "Microsoft.Rtc.Management.Deploy.Fqdn", "required": false, "name": "OwnerPool", "title": "OwnerPool", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Parent": { "__type_requested": "RgsIdentity", "required": true, "description": "Service where the new workflow 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" }, "HolidaySetIDList": { "__type_requested": "System.Collections.ObjectModel.Collection[Microsoft.Rtc.Rgs.Management.RgsIdentity]", "required": false, "description": "Represents days when workflow agents are not available to answer calls. The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet.", "title": "HolidaySetIDList", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "HolidaySetIDList" }, "Anonymous": { "__type_requested": "$true | $false", "required": false, "description": "If set to True, the identities of individual Response Group agents will be masked any time these agents answer a call. If set to False (the default value), agent identities will be available to callers.", "title": "Anonymous", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Anonymous" }, "Active": { "__type_requested": "$true | $false", "required": false, "description": "If set to True, this means that the workflow is active and available to take phone calls. If set to False (the default value), the workflow is not available to take phone calls.\nWhen the Active property is set to True then the workflow will be validated before it is created. For example, the workflow will not be created if a DefaultAction has not been specified. If Active is set to False (or not configured) then no validation will take place, and the workflow will be created even if a DefaultAction has not been specified.", "title": "Active", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Active" }, "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 workflow is hosted or the full Identity of the workflow itself. If you specify the service Identity (for example, service: ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group workflows hosted on that service will be returned. If you specify the Identity of the workflow, then only that one Response Group workflow will be returned. Note that the Identity of a workflow 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 workflow is to specify the service Identity, then include the Name parameter and the workflow name. That enables you to retrieve a specific workflow without having to know the GUID assigned to that workflow.\nIf called without any parameters, Get-CsRgsWorkflow returns a collection of all the workflows configured for use in your organization." }, "NonBusinessHoursAction": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction", "required": false, "description": "Action to be taken if a call is received outside the workflow's business hours. The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet.", "title": "NonBusinessHoursAction", "__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": "NonBusinessHoursAction" }, "Name": { "__type_requested": "String", "required": true, "description": "Unique name to be assigned to the workflow. The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow's globally unique identifier (GUID).", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "Language": { "__type_requested": "String", "required": false, "description": "Language that is used to read workflow text-to-speech prompts. The language parameter is optional as long as the operating system is using one of the supported languages shown in the list below. (Note that supported speech languages represent a subset of the languages that can be used on the operating system.)\nIf the operating system is not using a supported language, then the Language parameter becomes mandatory, and the parameter must specify the language code for a supported language. If your operating system is using a non-supported language on the operating system, and you run the New-CsRgsWorkflow cmdlet without including the Language parameter, your command will fail.\nFor example, suppose your operating system is running under the Faroese language. This language is supported by the Windows operating system, but not by the Response Group application. Therefore, you must include the Language parameter and a supported language when creating a new workflow.\nThis is required because, if no language is specified, the workflow uses the operating system language. However, that language can be used in a workflow only if it is a language supported by the Response Group application.\nThe language must be specified using one of the following language codes:\nca-ES - Catalan (Spain)\nda-DK - Danish (Denmark)\nde-DE - German (Germany)\nen-AU - English (Australia)\nen-CA - English (Canada)\nen-GB - English (United Kingdom)\nen-IN - English (India)\nen-US - English (United States)\nes-ES - Spanish (Spain)\nes-MX - Spanish (Mexico)\nfi-FI - Finnish (Finland)\nfr-CA - French (Canada)\nfr-FR - French (France)\nit-IT - Italian (Italy)\nja-JP - Japanese (Japan)\nko-KR - Korean (Korea)\nnb-NO - Norwegian, Bokmal (Norway)\nnl-NL - Dutch (Netherlands)\npl-PL - Polish (Poland)\npt-BR - Portuguese (Brazil)\npt-PT - Portuguese (Portugal)\nru-RU - Russian (Russia)\nsv-SE - Swedish (Sweden)\nzh-CN - Chinese (People's Republic of China)\nzh-HK - Chinese (Hong Kong SAR)\nzh-TW - Chinese (Taiwan)\nFor example: -Language \"nl-NL\".", "title": "Language", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Language" }, "EnabledForFederation": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether the workflow is available to users from a federated domain. If set to False, only users within your organization will have access to the workflow.", "title": "EnabledForFederation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnabledForFederation" }, "ManagersByUri": { "__type_requested": "System.Collections.ObjectModel.Collection[uri]", "required": false, "description": "SIP addresses of the user (or users) who will manage the workflow. For example:\n-ManagedByUri \"sip:[email protected]\"\nTo specify multiple managers separate the manager SIP addresses by using commas:\n-ManagedByUri \"sip:[email protected]\", \"sip:[email protected]\"", "title": "ManagersByUri", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ManagersByUri" }, "DefaultAction": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction", "required": false, "description": "Indicates the action to be taken when a workflow is opened during business hours. DefaultAction must be defined by using the New-CsRgsCallAction cmdlet, and must either direct the call to a queue or to a question. The DefaultAction parameter is mandatory if the workflow is active, but can be omitted if the workflow is inactive.", "title": "DefaultAction", "__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": "DefaultAction" }, "LineUri": { "__type_requested": "string", "required": false, "description": "Phone number for the workflow. The line Uniform Resource Identifier (URI) must be specified by using the following format: the TEL: prefix followed by a plus sign, followed by the country/region calling code, area code, and phone number (using only digits: no blank spaces, periods, or hyphens). For example: -LineUri \"TEL:+14255551219\"", "title": "LineUri", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "LineUri" }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to add additional information about a Response Group workflow. For example, the Description might include contact information for the owner of the workflow. This description appears in the Skype for Business contact card for the workflow.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "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" }, "BusinessHoursID": { "__type_requested": "RgsIdentity", "__type_mapping_type": "Complex.RgsIdentity", "description": "Days of the week and times of the day that workflow agents are available to answer calls. The business hour Identities can be retrieved by using the Get-CsRgsHoursOfBusiness cmdlet.", "title": "BusinessHoursID", "format": "uri", "required": false, "target_title": "Name", "target_attr": "Identity", "readonly": true, "target": "/api/device/skypeforbusinesshybrid/CsRgsHoursOfBusiness/choices/?choice_title=Name&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/skypeforbusinesshybrid/CsRgsHoursOfBusiness", "choices": [], "type": "string", "name": "BusinessHoursID" }, "Managed": { "__type_requested": "$true | $false", "required": false, "description": "When set to True indicates that the workflow will be managed by one or more users. Those users can be specified by using the ManagedByUri parameter.", "title": "Managed", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Managed" }, "PrimaryUri": { "__type_requested": "string", "required": true, "description": "SIP address for the workflow. For example: -PrimaryUri \"sip:[email protected]\". The PrimaryUri must begin with the \"sip:\" prefix.", "title": "PrimaryUri", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "PrimaryUri" }, "HolidayAction": { "__type_requested": "Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction", "required": false, "description": "Action to be taken if a call is received on a holiday. The HolidayAction must be defined by using the New-CsRgsCallAction cmdlet.", "title": "HolidayAction", "__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": "HolidayAction" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsRgsWorkflow 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/CsRgsWorkflow/ | 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/CsRgsWorkflow/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?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/CsRgsWorkflow |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsRgsWorkflow |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsRgsWorkflow; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid1]", "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/[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/CsRgsWorkflow and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsWorkflow.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsRgsWorkflow | POST | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/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/CsRgsWorkflow/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/CsRgsWorkflow/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/ |
|
The device/skypeforbusinesshybrid/CsRgsWorkflow schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsRgsWorkflow instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?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/CsRgsWorkflow/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/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/CsRgsWorkflow", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/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/CsRgsWorkflow/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsRgsWorkflow/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsRgsWorkflow", "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": "Name", "title": "Name" }, { "name": "Description", "title": "Description" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusinesshybrid/CsRgsWorkflow. | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsRgsWorkflow as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[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/CsRgsWorkflow/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsRgsWorkflow/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsRgsWorkflow | 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/CsRgsWorkflow; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[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/CsRgsWorkflow and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsRgsWorkflow.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsRgsWorkflow instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsRgsWorkflow. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsRgsWorkflow/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |