[Index]
Model ref.: device/exchangehybrid/RecipientFilterConfig
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": { "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "BlockedRecipients": { "__type_requested": "MultiValuedProperty", "required": true, "name": "BlockedRecipients", "title": "BlockedRecipients", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The BlockedRecipients parameter specifies one or more SMTP addresses. To enter multiple SMTP addresses, separate the addresses by using a comma. The maximum number of individual SMTP addresses that you can input is 800." }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RecipientValidationEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "RecipientValidationEnabled", "title": "RecipientValidationEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The RecipientValidationEnabled parameter specifies whether the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. Valid input for the RecipientValidationEnabled parameter is $true or $false. The default setting is $false. When the RecipientValidationEnabled parameter is set to $true, the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization." }, "BlockListEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "BlockListEnabled", "title": "BlockListEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The BlockListEnabled parameter specifies whether the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. Valid input for the BlockListEnabled parameter is $true or $false. The default setting is $false. When the BlockListEnabled parameter is set to $true, the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter." }, "AdminDisplayName": { "__type_requested": "System.String", "required": true, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "InternalMailEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "InternalMailEnabled", "title": "InternalMailEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing." }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ExternalMailEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "ExternalMailEnabled", "title": "ExternalMailEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The ExternalMailEnabled parameter specifies whether all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing." }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "OriginatingServer": { "__type_requested": "System.String", "required": true, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Name": { "__type_requested": "System.String", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Enabled": { "__type_requested": "System.Boolean", "required": true, "name": "Enabled", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The Enabled parameter specifies whether the Recipient Filter agent is enabled on the computer on which you're running the command. Valid input for the Enabled parameter is $true or $false. The default setting is $true. When the Enabled parameter is set to $true, the Recipient Filter agent is enabled on the computer on which you're running the command." }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "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": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Id": { "__type_requested": "System.String", "required": true, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": false, "type": "string" } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/RecipientFilterConfig/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/RecipientFilterConfig/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/RecipientFilterConfig/[pkid1]", "/api/v0/device/exchangehybrid/RecipientFilterConfig/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/RecipientFilterConfig/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/RecipientFilterConfig |
|
{"hrefs": ["/api/device/exchangehybrid/RecipientFilterConfig/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/RecipientFilterConfig |
|
{"hrefs": ["/api/device/exchangehybrid/RecipientFilterConfig/[pkid1]", "/api/device/exchangehybrid/RecipientFilterConfig/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/RecipientFilterConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/RecipientFilterConfig/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/RecipientFilterConfig/[pkid1]", "/api/device/exchangehybrid/RecipientFilterConfig/[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/exchangehybrid/RecipientFilterConfig and the JSON format can be used to import instances of device/exchangehybrid/RecipientFilterConfig.
GET http://[host-proxy]/api/device/exchangehybrid/RecipientFilterConfig/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/RecipientFilterConfig | POST | /api/device/exchangehybrid/RecipientFilterConfig/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/exchangehybrid/RecipientFilterConfig/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/RecipientFilterConfig/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/RecipientFilterConfig/ |
|
The device/exchangehybrid/RecipientFilterConfig schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/RecipientFilterConfig instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/RecipientFilterConfig/?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": "15312", "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/exchangehybrid/RecipientFilterConfig/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/exchangehybrid/RecipientFilterConfig", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/RecipientFilterConfig/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/exchangehybrid/RecipientFilterConfig/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/RecipientFilterConfig/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/RecipientFilterConfig/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/RecipientFilterConfig/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/RecipientFilterConfig/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/RecipientFilterConfig/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/RecipientFilterConfig", "model_specific_actions": [ "get", "list", "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/exchangehybrid/RecipientFilterConfig. | GET | /api/device/exchangehybrid/RecipientFilterConfig/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/RecipientFilterConfig as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/RecipientFilterConfig/[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/exchangehybrid/RecipientFilterConfig/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/RecipientFilterConfig/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/RecipientFilterConfig | 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/exchangehybrid/RecipientFilterConfig; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/RecipientFilterConfig/[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/exchangehybrid/RecipientFilterConfig and the JSON format can be used to import instances of device/exchangehybrid/RecipientFilterConfig.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/RecipientFilterConfig/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/RecipientFilterConfig instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/RecipientFilterConfig/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/RecipientFilterConfig. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/RecipientFilterConfig/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |