[Index]
Model ref.: device/exchangeonline/MalwareFilterPolicy
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, "description": "The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks (\").", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AdminDisplayName" }, "EnableInternalSenderNotifications": { "__type_requested": "$true | $false", "required": false, "description": "The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false.", "title": "EnableInternalSenderNotifications", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableInternalSenderNotifications" }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "BypassInboundMessages": { "__type_requested": "$true | $false", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe BypassInboundMessages parameter skips or enforces malware scanning on incoming messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on incoming messages by default.", "title": "BypassInboundMessages", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "BypassInboundMessages" }, "CustomInternalBody": { "__type_requested": "String", "required": false, "description": "The CustomInternalBody parameter specifies the body of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomInternalBody", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomInternalBody" }, "CustomExternalSubject": { "__type_requested": "String", "required": false, "description": "The CustomExternalSubject parameter specifies the subject of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomExternalSubject", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomExternalSubject" }, "BypassOutboundMessages": { "__type_requested": "$true | $false", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe BypassOutboundMessages parameter skips or enforces malware scanning on outgoing messages. Valid input for this parameter is $true or $false. The default value is $false. This means malware scanning occurs on outgoing messages by default.", "title": "BypassOutboundMessages", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "BypassOutboundMessages" }, "CustomAlertText": { "__type_requested": "String", "required": false, "description": "The CustomAlertText parameter specifies the custom alert text to insert in the message when malware is detected and the value of the Action parameter is set to ReplaceWithCustomAlert. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomAlertText", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomAlertText" }, "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" }, "CustomFromName": { "__type_requested": "String", "required": false, "description": "The CustomExternalFromName parameter specifies the From name of the custom notification message that's sent to internal or external senders when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomFromName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomFromName" }, "EnableExternalSenderAdminNotifications": { "__type_requested": "$true | $false", "required": false, "description": "The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false.\nSpecify the administrator to receive the notification messages by using the ExternalSenderAdminAddress parameter.", "title": "EnableExternalSenderAdminNotifications", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableExternalSenderAdminNotifications" }, "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" }, "EnableInternalSenderAdminNotifications": { "__type_requested": "$true | $false", "required": false, "description": "The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator when malware is detected in messages from internal senders. Valid input for this parameter is $true or $false. The default value is $false.\nSpecify the administrator to receive the notification messages by using the InternalSenderAdminAddress parameter.", "title": "EnableInternalSenderAdminNotifications", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableInternalSenderAdminNotifications" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CustomInternalSubject": { "__type_requested": "String", "required": false, "description": "The CustomInternalSubject parameter specifies the subject of the custom notification message that's sent to an internal sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomInternalSubject", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomInternalSubject" }, "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 malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy." }, "CustomNotifications": { "__type_requested": "$true | $false", "required": false, "description": "The CustomNotifications parameter enables or disables the custom notification message to the sender when the message contains malware. Valid input for this parameter is $true or $false. The default value is $false.\nIf you enable custom notification messages by setting this parameter to $true, you specify the details of the custom notification message using the CustomFromAddress,CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject, and CustomInternalBody parameters.", "title": "CustomNotifications", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "CustomNotifications" }, "FileTypes": { "__type_requested": "String[]", "required": false, "description": "The FileTypes parameter specifies the file types that are blocked by common attachment blocking. The default values are:\nace\nani\napp\ndocm\nexe\njar\nreg\nscr\nvbe\nvbs\nYou enable or disable common attachment blocking by using the EnableFileFilter parameter.\nCommon attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, ps1 files are Windows PowerShell scripts, but their true type is text.\nTo replace the existing list of file types with the values you specify, use the syntax <FileType1>,<FileType2>.... To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add.\nTo add or remove file types without affecting the other file type entries, see the Examples section in the Set-MalwareFilterPolicy cmdlet topic.", "title": "FileTypes", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "FileTypes" }, "CustomExternalBody": { "__type_requested": "String", "required": false, "description": "The CustomExternalBody parameter specifies the body of the custom notification message that's sent to an external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomExternalBody", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomExternalBody" }, "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, "description": "The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks (\").", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "ExternalSenderAdminAddress": { "__type_requested": "System.String", "required": false, "description": "The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableExternalSenderAdminNotifications parameter is set to $true.", "title": "ExternalSenderAdminAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ExternalSenderAdminAddress" }, "EnableExternalSenderNotifications": { "__type_requested": "$true | $false", "required": false, "description": "The EnableExternalSenderNotifications parameter enables or disables sending notification messages to senders when malware is detected in messages from external senders. Valid input for this parameter is $true or $false. The default value is $false.", "title": "EnableExternalSenderNotifications", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableExternalSenderNotifications" }, "InternalSenderAdminAddress": { "__type_requested": "System.String", "required": false, "description": "The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableInternalSenderAdminNotifications parameter is set to $true.", "title": "InternalSenderAdminAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "InternalSenderAdminAddress" }, "EnableFileFilter": { "__type_requested": "$true | $false", "required": false, "description": "The EnableFileFilter parameter enables or disables common attachment blocking. Valid values are:\n$true Common attachment blocking is enabled.\n$false Common attachment blocking is disabled.\nTo configure the blocked file types, use the FileTypes parameter.", "title": "EnableFileFilter", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableFileFilter" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "CustomFromAddress": { "__type_requested": "System.String", "required": false, "description": "The CustomFromAddress parameter specifies the From address of the custom notification message that's sent to an internal or external sender when a message contains malware. This parameter is required when the CustomNotifications parameter is set to $true.", "title": "CustomFromAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "CustomFromAddress" }, "Action": { "__type_requested": "System.String", "required": false, "description": "The Action parameter specifies the action to take when malware is detected in a message. Valid values for this parameter are:\nBlockMessage: blocks the message when malware is detected.\nReplaceWithDefaultAlert: delivers the message, but replaces the message contents with the default alert text when malware is detected.\nReplaceWithCustomAlert: delivers the message, but replaces the message contents with the custom alert text specified by the AlertText parameter when malware is detected.\nThe default value is BlockMessage.", "title": "Action", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Action" }, "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, "description": "This parameter is available only in on-premises Exchange 2016.\nThe DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DomainController" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsValid": { "__type_requested": "System.Boolean", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "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" }, "ZapEnabled": { "__type_requested": "$true | $false", "required": false, "description": "PARAMVALUE: $true | $false", "title": "ZapEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ZapEnabled" }, "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/MalwareFilterPolicy/add/ |
|
The GUI Add form of device/exchangeonline/MalwareFilterPolicy 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/MalwareFilterPolicy | 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/MalwareFilterPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/MalwareFilterPolicy/[pkid1]", "/api/device/exchangeonline/MalwareFilterPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/MalwareFilterPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangeonline/MalwareFilterPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangeonline/MalwareFilterPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/MalwareFilterPolicy/[pkid1]", "/api/v0/device/exchangeonline/MalwareFilterPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/MalwareFilterPolicy/?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/MalwareFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/MalwareFilterPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/MalwareFilterPolicy |
|
{"hrefs": ["/api/device/exchangeonline/MalwareFilterPolicy/[pkid1]", "/api/device/exchangeonline/MalwareFilterPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/MalwareFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/MalwareFilterPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/MalwareFilterPolicy/[pkid1]", "/api/device/exchangeonline/MalwareFilterPolicy/[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/MalwareFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/MalwareFilterPolicy.
GET http://[host-proxy]/api/device/exchangeonline/MalwareFilterPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/MalwareFilterPolicy | POST | /api/device/exchangeonline/MalwareFilterPolicy/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/MalwareFilterPolicy/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/MalwareFilterPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangeonline/MalwareFilterPolicy/ |
|
The device/exchangeonline/MalwareFilterPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/MalwareFilterPolicy instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangeonline/MalwareFilterPolicy/?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/MalwareFilterPolicy/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangeonline/MalwareFilterPolicy/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangeonline/MalwareFilterPolicy/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/MalwareFilterPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangeonline/MalwareFilterPolicy/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/MalwareFilterPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangeonline/MalwareFilterPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangeonline/MalwareFilterPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangeonline/MalwareFilterPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangeonline/MalwareFilterPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangeonline/MalwareFilterPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangeonline/MalwareFilterPolicy", "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/MalwareFilterPolicy. | GET | /api/device/exchangeonline/MalwareFilterPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/MalwareFilterPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangeonline/MalwareFilterPolicy/[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/MalwareFilterPolicy/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/MalwareFilterPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/MalwareFilterPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/MalwareFilterPolicy | 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/MalwareFilterPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/MalwareFilterPolicy/[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/MalwareFilterPolicy and the JSON format can be used to import instances of device/exchangeonline/MalwareFilterPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangeonline/MalwareFilterPolicy/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/MalwareFilterPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangeonline/MalwareFilterPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/MalwareFilterPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangeonline/MalwareFilterPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |