[Index]
Model ref.: device/exchangeonline/HostedConnectionFilterPolicy
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": { "AdminDisplayName": { "__type_requested": "string", "required": false, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks (\")." }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ProxyToMailbox": { "__type_requested": "MailboxIdParameter", "required": false, "name": "ProxyToMailbox", "title": "ProxyToMailbox", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IgnoreDehydratedFlag": { "__type_requested": "switch", "required": false, "name": "IgnoreDehydratedFlag", "title": "IgnoreDehydratedFlag", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "IPBlockList": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.IPRange,", "required": false, "description": "The IPBlockList parameter specifies IP addresses from which messages are never allowed. Messages from the IP addresses you specify are blocked without any further spam scanning.\nYou enter the IP addresses using the following syntax:\nSingle IP For example, 192.168.1.1.\nIP range You can use an IP address range, for example, 192.168.0.1-192.168.0.254.\nCIDR IP You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25.\nYou can specify multiple IP addresses of the same type separated by commas. For example, <single IP1>, <single IP2> or <CIDR IP1>, <CIDR IP2>. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add=\"<single IP1>\",\"<IP range1>\",<CIDR IP1>...}.", "title": "IPBlockList", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "IPBlockList" }, "DirectoryBasedEdgeBlockMode": { "__type_requested": "System.String", "required": false, "name": "DirectoryBasedEdgeBlockMode", "title": "DirectoryBasedEdgeBlockMode", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "EnableSafeList": { "__type_requested": "bool", "required": false, "name": "EnableSafeList", "title": "EnableSafeList", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The EnableSafeList parameter enables or disables use of the safe list. The safe list is a dynamic allow list in the Microsoft datacenter that requires no customer configuration. Valid input for this parameter is $true or $false. The default value is $false." }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The Identity parameter specifies the connection filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can specify the name, GUID, or distinguished name (DN) of the connection filter policy." }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "OriginatingServer": { "__type_requested": "System.String", "required": false, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Name": { "__type_requested": "string", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IPAllowList": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.IPRange,", "required": false, "description": "The IPAllowList parameter specifies IP addresses from which messages are always allowed. Messages from the IP addresses you specify won't be identified as spam, despite any other spam characteristics of the messages.\nYou enter the IP addresses using the following syntax:\nSingle IP For example, 192.168.1.1.\nIP range You can use an IP address range, for example, 192.168.0.1-192.168.0.254.\nCIDR IP You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25.\nYou can specify multiple IP addresses of the same type separated by commas. For example, <single IP1>, <single IP2> or <CIDR IP1>, <CIDR IP2>. To specify multiple IP addresses of different types at the same time, you need to use the following multivalued property syntax: @{Add=\"<single IP1>\",\"<IP range1>\",<CIDR IP1>...}.", "title": "IPAllowList", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "IPAllowList" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "Organization": { "__type_requested": "OrganizationIdParameter", "required": false, "name": "Organization", "title": "Organization", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsDefault": { "__type_requested": "System.Boolean", "required": false, "name": "IsDefault", "title": "IsDefault", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "name": "DomainController", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ConfigurationXmlRaw": { "__type_requested": "string", "required": false, "name": "ConfigurationXmlRaw", "title": "ConfigurationXmlRaw", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "PARAMVALUE: String" }, "ProxyToServer": { "__type_requested": "string", "required": false, "name": "ProxyToServer", "title": "ProxyToServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Guid": { "__type_requested": "System.Guid", "required": false, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Id": { "__type_requested": "System.String", "required": false, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": true, "type": "string" } }, "schema_version": "2017.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/add/ |
|
The GUI Add form of device/exchangeonline/HostedConnectionFilterPolicy 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/exchangeonline/HostedConnectionFilterPolicy | 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/exchangeonline/HostedConnectionFilterPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangeonline/HostedConnectionFilterPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/HostedConnectionFilterPolicy/[pkid1]", "/api/v0/device/exchangeonline/HostedConnectionFilterPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/HostedConnectionFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/HostedConnectionFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/HostedConnectionFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/HostedConnectionFilterPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid1]", "/api/device/exchangeonline/HostedConnectionFilterPolicy/[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/exchangeonline/HostedConnectionFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/HostedConnectionFilterPolicy.
GET http://[host-proxy]/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/HostedConnectionFilterPolicy | POST | /api/device/exchangeonline/HostedConnectionFilterPolicy/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/exchangeonline/HostedConnectionFilterPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/ |
|
The device/exchangeonline/HostedConnectionFilterPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/HostedConnectionFilterPolicy instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangeonline/HostedConnectionFilterPolicy/?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": "2017.1", "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/exchangeonline/HostedConnectionFilterPolicy/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/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/exchangeonline/HostedConnectionFilterPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/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/exchangeonline/HostedConnectionFilterPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangeonline/HostedConnectionFilterPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangeonline/HostedConnectionFilterPolicy", "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": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangeonline/HostedConnectionFilterPolicy. | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/HostedConnectionFilterPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/HostedConnectionFilterPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/HostedConnectionFilterPolicy | 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/exchangeonline/HostedConnectionFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/[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/exchangeonline/HostedConnectionFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/HostedConnectionFilterPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/HostedConnectionFilterPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/HostedConnectionFilterPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangeonline/HostedConnectionFilterPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |