API Reference for device/skypeforbusinesshybrid/CsTrunkConfiguration

Model ref.: device/skypeforbusinesshybrid/CsTrunkConfiguration

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "EnablePIDFLOSupport": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. (The location will be transmitted with the call.)\nDefault: False", 
               "title": "EnablePIDFLOSupport", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnablePIDFLOSupport"
          }, 
          "OutboundTranslationRulesList": {
               "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule]", 
               "required": false, 
               "description": "A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations).\nWhile this list and these rules can be created directly with this cmdlet, it is recommended that you create the outbound translation rules with the New-CsOutboundTranslationRule cmdlet, which will create the rule and assign it to the trunk configuration with the matching scope.", 
               "title": "OutboundTranslationRulesList", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "OutboundTranslationRulesList"
          }, 
          "ScopeClass": {
               "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", 
               "required": false, 
               "name": "ScopeClass", 
               "title": "ScopeClass", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "EnableSignalBoost": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When this parameter is set to True the PSTN gateway, IP-PBX, or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server 2015 clients. If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server 2015 clients (for bypass calls).\nDefault: False", 
               "title": "EnableSignalBoost", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableSignalBoost"
          }, 
          "OutboundCallingNumberTranslationRulesList": {
               "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule]", 
               "required": false, 
               "description": "Collection of outbound calling number translation rules assigned to the trunk. You can retrieve information about the available rules by running this command:\nGet-CsOutboundCallingNumberTranslationRule", 
               "title": "OutboundCallingNumberTranslationRulesList", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "OutboundCallingNumberTranslationRulesList"
          }, 
          "EnableBypass": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The value of this parameter determines whether media bypass is enabled for this trunk. Set this value to True to enable bypass. Note that in order for the media bypass to work successfully, certain capabilities must be supported by PSTN gateways, SBCs, and PBXs, including:\n- The ability to receive forked responses to an Invite.\n- Skype for Business Server 2015 clients and the media termination point must be able to communicate directly without going through a Mediation Server.\n- The gateway subnet must be defined as being at the same site as the client's subnet or, if at a different site, the sites must not be separated by WAN links with constrained bandwidth.\nMedia bypass can be enabled only under the following circumstances:\n- The ConcentratedTopology parameter is set to True\n- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True\nNote that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass.\nFor media bypass to work for a particular trunk, it needs to be enabled globally as well as for the trunk in question. Use the New-CsNetworkMediaBypassConfiguration cmdlet to enable media bypass globally.\nDefault: False", 
               "title": "EnableBypass", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableBypass"
          }, 
          "ConcentratedTopology": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "The value of this parameter determines whether there is a well-known media termination point. (An example of a well-known media termination point would be a PSTN gateway where the media termination has the same IP as the signaling termination.) Set this value to False if the trunk does not have a well-known media termination point.\nDefault: True", 
               "title": "ConcentratedTopology", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ConcentratedTopology"
          }, 
          "EnableLocationRestriction": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. If this property is set to True (the default value is False) then you should also set the NetworkSiteId property.\nThis parameter was introduced in the February, 2013 version of Lync Server 2013.", 
               "title": "EnableLocationRestriction", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableLocationRestriction"
          }, 
          "NetworkSiteID": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Site ID of the network site associated with the new collection of trunk configuration settings. If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. Network site IDs can be retrieved by using this command:\nGet-CsNetworkSite | Select NetworkSiteID\nThis parameter was introduced in the February, 2013 release of Lync Server 2013.", 
               "title": "NetworkSiteID", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "NetworkSiteID"
          }, 
          "SipResponseCodeTranslationRulesList": {
               "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule]", 
               "required": false, 
               "description": "A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX, or SBC at the service provider. These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server 2015.\nYou can create this list and corresponding rules directly with this cmdlet. However, it is recommended that you create the SIP response code translation rules by calling the New-CsSipResponseCodeTranslationRule cmdlet. That cmdlet will create the rule and assign it to the trunk configuration with the matching scope.", 
               "title": "SipResponseCodeTranslationRulesList", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "SipResponseCodeTranslationRulesList"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A string describing the purpose of the trunk configuration.", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "MaxEarlyDialogs": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server.\nDefault: 20", 
               "title": "MaxEarlyDialogs", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxEarlyDialogs"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "A unique identifier that includes the scope of the trunk configuration. Trunk configurations can be created at the Site scope, or at the Service scope for a PSTN Gateway service. (A global configuration exists by default and cannot be removed or re-created.) For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service).", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "ForwardCallHistory": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether call history information will be forwarded through the trunk. The default value is False ($False).", 
               "title": "ForwardCallHistory", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ForwardCallHistory"
          }, 
          "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"
          }, 
          "EnableSessionTimer": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Specifies whether the session timer is enabled. Session timers are used to determine whether a particular session is still active.\nNote that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. In such a case, the Mediation Server will reply to session timer probes from the remote entity.\nDefault: False", 
               "title": "EnableSessionTimer", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableSessionTimer"
          }, 
          "EnableReferSupport": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Defines whether this trunk supports receiving Refer requests from the Mediation Server.\nMedia bypass can be enabled only under the following circumstances:\n- The ConcentratedTopology parameter is set to True\n- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True\nNote that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass.\nDefault: True", 
               "title": "EnableReferSupport", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableReferSupport"
          }, 
          "SRTPMode": {
               "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SRTPMode", 
               "required": false, 
               "description": "The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN Gateway, IP-PBX, or SBC at the service provider. For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. Media configuration is set by using the New-CsMediaConfiguration cmdlet and the Set-CsMediaConfiguration cmdlet.\nValid values:\n- Required: SRTP encryption must be used.\n- Optional: SRTP will be used if the gateway supports it.\n- NotSupported: SRTP encryption is not supported and therefore will not be used.\nNote: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported.\nDefault: Required", 
               "title": "SRTPMode", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "SRTPMode"
          }, 
          "EnableOnlineVoice": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether the SIP trunks support online voice. With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Office 365. The default value is False ($False).", 
               "title": "EnableOnlineVoice", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableOnlineVoice"
          }, 
          "Enable3pccRefer": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. 3pcc is also known as \"third party control,\" and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. The default value is False ($False).", 
               "title": "Enable3pccRefer", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "Enable3pccRefer"
          }, 
          "Anchor": {
               "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", 
               "required": false, 
               "name": "Anchor", 
               "title": "Anchor", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "EnableFastFailoverTimer": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily.\nThe default value is True.", 
               "title": "EnableFastFailoverTimer", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableFastFailoverTimer"
          }, 
          "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"
          }, 
          "PstnUsages": {
               "__type_requested": "System.Collections.Generic.IList[string]", 
               "required": false, 
               "description": "Collection of PSTN usages assigned to the trunk. You can retrieve information about the available usages by running this command:\nGet-CsPstnUsage", 
               "title": "PstnUsages", 
               "items": {
                    "type": "string"
               }, 
               "__type_mapping_type": "String[]", 
               "readonly": false, 
               "type": "array", 
               "name": "PstnUsages"
          }, 
          "RemovePlusFromUri": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resource Identifiers (URIs) before sending them on to the service provider.\nDefault: False", 
               "title": "RemovePlusFromUri", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "RemovePlusFromUri"
          }, 
          "EnableMobileTrunkSupport": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Defines whether the service provider is a mobile carrier.\nDefault: False", 
               "title": "EnableMobileTrunkSupport", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableMobileTrunkSupport"
          }, 
          "EnableRTPLatching": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether or not the SIP trunks support RTP latching. RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. The default value is False ($False).", 
               "title": "EnableRTPLatching", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableRTPLatching"
          }, 
          "ForwardPAI": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False).", 
               "title": "ForwardPAI", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "ForwardPAI"
          }, 
          "RTCPActiveCalls": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX, or SBC at the service provider for active calls. An active call in this context is a call where media is allowed to flow in at least one direction. If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server 2015 client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds.\nNote that disabling the checks for received RTCP media for active calls in Skype for Business Server 2015 elements removes an important safeguard for detecting a dropped peer and should be done only if necessary.\nDefault: True", 
               "title": "RTCPActiveCalls", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "RTCPActiveCalls"
          }, 
          "RTCPCallsOnHold": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. If Music on Hold is enabled at either the Skype for Business Server 2015 client or the trunk, the call will be considered to be active and this property will be ignored. In these circumstances use the RTCPActiveCalls parameter.\nNote that disabling the checks for received RTCP media for active calls in Skype for Business Server 2015 elements removes an important safeguard for detecting a dropped peer and should be done only if necessary.\nDefault: True", 
               "title": "RTCPCallsOnHold", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "RTCPCallsOnHold"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusinesshybrid/CsTrunkConfiguration 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/CsTrunkConfiguration/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/CsTrunkConfiguration/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/skypeforbusinesshybrid/CsTrunkConfiguration
```
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/skypeforbusinesshybrid/CsTrunkConfiguration device/skypeforbusinesshybrid/CsTrunkConfiguration schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsTrunkConfiguration	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsTrunkConfiguration	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsTrunkConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[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/CsTrunkConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsTrunkConfiguration.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/skypeforbusinesshybrid/CsTrunkConfiguration:

 GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsTrunkConfiguration	POST	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/skypeforbusinesshybrid/CsTrunkConfiguration	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusinesshybrid/CsTrunkConfiguration schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusinesshybrid/CsTrunkConfiguration instances)

GET http://[host]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Description", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?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/CsTrunkConfiguration/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/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/CsTrunkConfiguration", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/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/CsTrunkConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusinesshybrid/CsTrunkConfiguration", 
          "model_specific_actions": [
               "get", 
               "list", 
               "add", 
               "remove", 
               "update", 
               "powershell_test", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Description", 
                    "title": "Description"
               }, 
               {
                    "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/CsTrunkConfiguration.	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusinesshybrid/CsTrunkConfiguration as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[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/CsTrunkConfiguration/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/skypeforbusinesshybrid/CsTrunkConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsTrunkConfiguration	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/CsTrunkConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusinesshybrid/CsTrunkConfiguration instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/skypeforbusinesshybrid/CsTrunkConfiguration.

Task	Call	URL	Parameters	Payload
Powershell Test	POST	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/+powershell_test/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/skypeforbusinesshybrid/CsTrunkConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/skypeforbusinesshybrid/CsTrunkConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Powershell Test

Purge