[Index]
Model ref.: device/skypeforbusiness/CsAccessEdgeConfiguration
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": { "MaxRejectedCertificatesStored": { "__type_requested": "uint32", "required": true, "name": "MaxRejectedCertificatesStored", "title": "MaxRejectedCertificatesStored", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Maximum number of rejected certificates cached by the Edge Server. The default value is 500." }, "EnableDiscoveredPartnerContactsLimit": { "__type_requested": "bool", "required": true, "name": "EnableDiscoveredPartnerContactsLimit", "title": "EnableDiscoveredPartnerContactsLimit", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "When set to True (the default value), enables user enumeration protection for Discovered Partner federated peers." }, "OutgoingTlsCountForFederatedPartners": { "__type_requested": "uint32", "required": true, "name": "OutgoingTlsCountForFederatedPartners", "title": "OutgoingTlsCountForFederatedPartners", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each federated partner. The minimum number of TLS connections is 1, and the maximum number is 4. By default, OutgoingTlsCountForFederatedPartners is set to 4. This parameter should not be changed unless you are instructed to do so by Microsoft support personnel." }, "RoutingMethod": { "__type_requested": "string", "required": false, "name": "RoutingMethod", "title": "RoutingMethod", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DiscoveredPartnerStandardRate": { "__type_requested": "uint32", "required": true, "name": "DiscoveredPartnerStandardRate", "title": "DiscoveredPartnerStandardRate", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The default value is 20." }, "CertificatesDeletedPercentage": { "__type_requested": "uint32", "required": true, "name": "CertificatesDeletedPercentage", "title": "CertificatesDeletedPercentage", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The default value is 20." }, "DiscoveredPartnerVerificationLevel": { "__type_requested": "AlwaysVerifiable | AlwaysUnverifiable | UseSourceVerification", "required": false, "description": "Sets the verification level for messages sent to and from the discovered partner. Allowed values are:\n* AlwaysVerifiable\n* AlwaysUnverifiable\n* UseSourceVerification", "title": "DiscoveredPartnerVerificationLevel", "__type_mapping_type": "Unknown", "name": "DiscoveredPartnerVerificationLevel", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AllowFederatedUsers": { "__type_requested": "bool", "required": true, "name": "AllowFederatedUsers", "title": "AllowFederatedUsers", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Indicates whether internal users are allowed to communicate with users from federated domains. This property also determines whether internal users can communicate with users in a split domain scenario. (In a split domain, some of your users have accounts hosted on-premises, while others have accounts hosted off-premises.) The default value is False." }, "BeClearingHouse": { "__type_requested": "bool", "required": false, "name": "BeClearingHouse", "title": "BeClearingHouse", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "Indicates whether your Edge servers are directly connected to other organizations. The default value is False. This parameter should not be changed unless you are instructed to do so by Microsoft support personnel." }, "AllowAnonymousUsers": { "__type_requested": "bool", "required": true, "name": "AllowAnonymousUsers", "title": "AllowAnonymousUsers", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Indicates whether or not anonymous users (that is, unauthenticated users) are allowed to cross the firewall and join meetings and conferences. The default value is False." }, "EnableUserReplicator": { "__type_requested": "bool", "required": true, "name": "EnableUserReplicator", "title": "EnableUserReplicator", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The default value is False ($False)." }, "DnsSrvCacheRecordCount": { "__type_requested": "uint32", "required": true, "name": "DnsSrvCacheRecordCount", "title": "DnsSrvCacheRecordCount", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Maximum number of DNS SRV records that can be maintained in the cache. SRV records are used to specify service locations and port numbers." }, "EnableArchivingDisclaimer": { "__type_requested": "bool", "required": true, "name": "EnableArchivingDisclaimer", "title": "EnableArchivingDisclaimer", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "If set to True, Edge Servers send an archiving notification header to federated and clearinghouse partners. This notification (which informs people that instant messaging (IM) conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. The default value is False." }, "MaxAcceptedCertificatesStored": { "__type_requested": "uint32", "required": true, "name": "MaxAcceptedCertificatesStored", "title": "MaxAcceptedCertificatesStored", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Maximum number of allowed certificates cached by the Edge Server. The default value is 1000." }, "Identity": { "__type_requested": "string", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Unique identifier of the Access Edge configuration settings to be returned. Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsAccessEdgeConfiguration cmdlet. However, you can use the following syntax to retrieve the global settings: -Identity global." }, "EnablePartnerDiscovery": { "__type_requested": "bool", "required": false, "name": "EnablePartnerDiscovery", "title": "EnablePartnerDiscovery", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "If True, Skype for Business Server 2015 will use DNS records to try and discover partner domains not listed in the AllowedDomains list. If False, Skype for Business Server 2015 will only federate with domains found on the AllowedDomains list. This parameter is required if you use DNS service routing. The default value is False." }, "KeepCrlsUpToDateForPeers": { "__type_requested": "bool", "required": true, "name": "KeepCrlsUpToDateForPeers", "title": "KeepCrlsUpToDateForPeers", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Determines whether or not Edge servers periodically check the certificate revocation lists (CRLs) for federated domain certificates. The default value is True." }, "DiscoveredPartnerReportPeriodMinutes": { "__type_requested": "uint32", "required": true, "name": "DiscoveredPartnerReportPeriodMinutes", "title": "DiscoveredPartnerReportPeriodMinutes", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The default value is 60." }, "SkypeSearchUrl": { "__type_requested": "string", "required": true, "name": "SkypeSearchUrl", "title": "SkypeSearchUrl", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "URL for the Skype Graph Search service. This service enables Skype for Business to search for Skype contacts." }, "AllowOutsideUsers": { "__type_requested": "bool", "required": true, "name": "AllowOutsideUsers", "title": "AllowOutsideUsers", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "Indicates whether users can access Skype for Business Server 2015 across the Internet. This includes both anonymous users and remote users who are trying to log on to the system. The default value is True." }, "MarkSourceVerifiableOnOutgoingMessages": { "__type_requested": "bool", "required": true, "name": "MarkSourceVerifiableOnOutgoingMessages", "title": "MarkSourceVerifiableOnOutgoingMessages", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. If False, outgoing messages are all marked as unverifiable. The default value is True." }, "MaxContactsPerDiscoveredPartner": { "__type_requested": "uint32", "required": true, "name": "MaxContactsPerDiscoveredPartner", "title": "MaxContactsPerDiscoveredPartner", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Maximum number of contacts allowed per discovered partner. The default value is 1000." } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid1]", "/api/v0/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsAccessEdgeConfiguration/?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/CsAccessEdgeConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsAccessEdgeConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsAccessEdgeConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/[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/CsAccessEdgeConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsAccessEdgeConfiguration.
GET http://[host-proxy]/api/device/skypeforbusiness/CsAccessEdgeConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsAccessEdgeConfiguration | POST | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/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/CsAccessEdgeConfiguration/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/CsAccessEdgeConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/ |
|
The device/skypeforbusiness/CsAccessEdgeConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsAccessEdgeConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/?skip=0&limit=3&order_by=None&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": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/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/CsAccessEdgeConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/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/CsAccessEdgeConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsAccessEdgeConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsAccessEdgeConfiguration", "model_specific_actions": [ "get", "list", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "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/skypeforbusiness/CsAccessEdgeConfiguration. | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsAccessEdgeConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsAccessEdgeConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsAccessEdgeConfiguration | 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/CsAccessEdgeConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[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/CsAccessEdgeConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsAccessEdgeConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsAccessEdgeConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsAccessEdgeConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsAccessEdgeConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |