[Index]
Model ref.: device/skypeforbusiness/CsXmppAllowedPartner
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": { "ProxyFqdn": { "__type_requested": "String", "required": false, "description": "Full qualified domain name of the proxy server used by the XMPP partner.", "title": "ProxyFqdn", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ProxyFqdn" }, "EnableKeepAlive": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not the XMPP partner should periodically transmit \"keep alive\" packets in order to verify that the connection is still active.\nThe default value is True.", "title": "EnableKeepAlive", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableKeepAlive" }, "SaslNegotiation": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.SaslNegotiation", "required": false, "description": "Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication.\nAllowed values are:\nRequired (SASL negotiation must be supported)\nOptional (SASL will be used if available)\nNotSupported (SASL negotiation will not be supported)\nThe default value is Required.", "title": "SaslNegotiation", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "SaslNegotiation" }, "TlsNegotiation": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.TlsNegotiation", "required": false, "description": "Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams.\nAllowed values are:\nRequired (TLS negotiation must be supported)\nOptional (TLS will be used if available)\nNotSupported (TLS negotiation will not be support The default value is Required.)", "title": "TlsNegotiation", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "TlsNegotiation" }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide additional text regarding the XMPP allowed partner. For example, the Description might include contact information for the partner.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "SupportDialbackNegotiation": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity of Server A by contacting the authoritative DNS server for the domain that Server A claims to be from.\nNote that dialback negotiation is not as secure as SASL or TLS. Instead, it is primarily used in situations where certificates cannot be used to verify a server's identity.\nThe default value is True.", "title": "SupportDialbackNegotiation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "SupportDialbackNegotiation" }, "Domain": { "__type_requested": "String", "required": true, "description": "Primary domain of the XMPP allowed partner; for example:\n-Domain \"fabrikam.com\"\nYou can specify the primary domain by using either the Domain parameter or the Identity parameter. However, you cannot use both parameters in the same command.\nAdditional domains can be specified by using the AdditionalDomains parameter.", "title": "Domain", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Domain" }, "Element": { "__type_requested": "System.Xml.Linq.XElement", "required": false, "name": "Element", "title": "Element", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InMemory": { "__type_requested": "SwitchParameter", "required": false, "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet.", "title": "InMemory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "InMemory" }, "PartnerType": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.PartnerType", "required": false, "description": "Specifies the relationship between Skype for Business Server 2015 and the XMPP partner. Allowed values are:\nFederated (the XMPP partner is from a federated domain)\nPublicVerified\nPublicUnverified\nThe default value is PublicUnverified.", "title": "PartnerType", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "PartnerType" }, "ConnectionLimit": { "__type_requested": "UInt32", "required": false, "description": "Specifies the maximum number of simultaneous connections allowed to a specific partner.", "title": "ConnectionLimit", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "ConnectionLimit" }, "AdditionalDomains": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "description": "Additional XMPP domains belonging to the allowed partner. Multiple domains can be specified by separated domain names by using commas; for example:\n-AdditionalDomains \"fabrikam2.com\",\"fabrikam3.com\"", "title": "AdditionalDomains", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "AdditionalDomains" }, "Identity": { "__type_requested": "System.String", "required": true, "description": "Primary domain of the XMPP allowed partner; for example:\n-Identity \"fabrikam.com\"\nYou can specify the primary domain by using either the Identity parameter or the Domain parameter. However, you cannot use both parameters in the same command.\nAdditional domains can be specified by using the AdditionalDomains parameter.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/add/ |
|
The GUI Add form of device/skypeforbusiness/CsXmppAllowedPartner 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/skypeforbusiness/CsXmppAllowedPartner/ | 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/skypeforbusiness/CsXmppAllowedPartner/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid1]", "/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsXmppAllowedPartner/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsXmppAllowedPartner/[pkid1]", "/api/v0/device/skypeforbusiness/CsXmppAllowedPartner/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsXmppAllowedPartner |
|
{"hrefs": ["/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsXmppAllowedPartner |
|
{"hrefs": ["/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid1]", "/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsXmppAllowedPartner; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsXmppAllowedPartner/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid1]", "/api/device/skypeforbusiness/CsXmppAllowedPartner/[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/skypeforbusiness/CsXmppAllowedPartner and the JSON format can be used to import instances of device/skypeforbusiness/CsXmppAllowedPartner.
GET http://[host-proxy]/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsXmppAllowedPartner | POST | /api/device/skypeforbusiness/CsXmppAllowedPartner/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/skypeforbusiness/CsXmppAllowedPartner/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/ |
|
The device/skypeforbusiness/CsXmppAllowedPartner schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsXmppAllowedPartner instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsXmppAllowedPartner/?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/skypeforbusiness/CsXmppAllowedPartner/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/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/skypeforbusiness/CsXmppAllowedPartner", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/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/skypeforbusiness/CsXmppAllowedPartner/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsXmppAllowedPartner/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsXmppAllowedPartner", "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" }, { "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/skypeforbusiness/CsXmppAllowedPartner. | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsXmppAllowedPartner as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsXmppAllowedPartner/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsXmppAllowedPartner | 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/skypeforbusiness/CsXmppAllowedPartner; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/[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/skypeforbusiness/CsXmppAllowedPartner and the JSON format can be used to import instances of device/skypeforbusiness/CsXmppAllowedPartner.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsXmppAllowedPartner instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsXmppAllowedPartner. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsXmppAllowedPartner/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |