[Index]
Model ref.: device/exchangehybrid/DeliveryAgentConnector
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": { "SourceRoutingGroup": { "__type_requested": "System.String", "required": false, "name": "SourceRoutingGroup", "title": "SourceRoutingGroup", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DeliveryProtocol": { "__type_requested": "String", "required": true, "description": "The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector.", "title": "DeliveryProtocol", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DeliveryProtocol" }, "AdminDisplayName": { "__type_requested": "System.String", "required": false, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MaxMessagesPerConnection": { "__type_requested": "Int32", "required": false, "description": "The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached, and the sending server has to initiate a new connection to send more messages. The default value is 20.", "title": "MaxMessagesPerConnection", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxMessagesPerConnection" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "SourceTransportServers": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas.\nBy default, only the local server on which the command is executed is added to this parameter.", "title": "SourceTransportServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "SourceTransportServers" }, "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" }, "IsSmtpConnector": { "__type_requested": "System.Boolean", "required": false, "name": "IsSmtpConnector", "title": "IsSmtpConnector", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ConnectedDomains": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Microsoft.Exchange.Data.ConnectedDomain,", "required": false, "name": "ConnectedDomains", "title": "ConnectedDomains", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "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 GUID or name of the delivery agent connector." }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Comment": { "__type_requested": "String", "required": false, "description": "The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks (\"), for example: \"This is an admin note\".", "title": "Comment", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Comment" }, "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 the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "AddressSpaces": { "__type_requested": "MultiValuedProperty", "required": true, "description": "The AddessSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>. You must enclose each address space in quotation marks (\").", "title": "AddressSpaces", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "AddressSpaces" }, "Enabled": { "__type_requested": "$true | $false", "required": false, "description": "The Enabled parameter specifies whether the delivery agent connector is enabled.\nThe default value is $true.", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Enabled" }, "MaxMessageSize": { "__type_requested": "System.String", "required": false, "description": "The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nUnqualified values are treated as bytes. The valid input range for this parameter is from 65536 through 2147483647 bytes. The default value is unlimited.", "title": "MaxMessageSize", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MaxMessageSize" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "MaxConcurrentConnections": { "__type_requested": "Int32", "required": false, "description": "The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address. The default value is 5.", "title": "MaxConcurrentConnections", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxConcurrentConnections" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsScopedConnector": { "__type_requested": "$true | $false", "required": false, "description": "The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site. The default value is $false.", "title": "IsScopedConnector", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsScopedConnector" }, "HomeMtaServerId": { "__type_requested": "System.String", "required": false, "name": "HomeMtaServerId", "title": "HomeMtaServerId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.\nThe DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.", "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" }, "HomeMTA": { "__type_requested": "System.String", "required": false, "name": "HomeMTA", "title": "HomeMTA", "__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" }, "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": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangehybrid/DeliveryAgentConnector/add/ |
|
The GUI Add form of device/exchangehybrid/DeliveryAgentConnector 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/exchangehybrid/DeliveryAgentConnector | 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/exchangehybrid/DeliveryAgentConnector/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/DeliveryAgentConnector/[pkid1]", "/api/device/exchangehybrid/DeliveryAgentConnector/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/DeliveryAgentConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/DeliveryAgentConnector/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/DeliveryAgentConnector/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/DeliveryAgentConnector/[pkid1]", "/api/v0/device/exchangehybrid/DeliveryAgentConnector/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/DeliveryAgentConnector/?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/DeliveryAgentConnector |
|
{"hrefs": ["/api/device/exchangehybrid/DeliveryAgentConnector/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/DeliveryAgentConnector |
|
{"hrefs": ["/api/device/exchangehybrid/DeliveryAgentConnector/[pkid1]", "/api/device/exchangehybrid/DeliveryAgentConnector/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/DeliveryAgentConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/DeliveryAgentConnector/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/DeliveryAgentConnector/[pkid1]", "/api/device/exchangehybrid/DeliveryAgentConnector/[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/DeliveryAgentConnector and the JSON format can be used to import instances of device/exchangehybrid/DeliveryAgentConnector.
GET http://[host-proxy]/api/device/exchangehybrid/DeliveryAgentConnector/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/DeliveryAgentConnector | POST | /api/device/exchangehybrid/DeliveryAgentConnector/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/DeliveryAgentConnector/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/DeliveryAgentConnector/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/DeliveryAgentConnector/ |
|
The device/exchangehybrid/DeliveryAgentConnector schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/DeliveryAgentConnector instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/DeliveryAgentConnector/?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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/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/DeliveryAgentConnector", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/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/DeliveryAgentConnector/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/DeliveryAgentConnector/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/DeliveryAgentConnector", "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/exchangehybrid/DeliveryAgentConnector. | GET | /api/device/exchangehybrid/DeliveryAgentConnector/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/DeliveryAgentConnector as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/DeliveryAgentConnector/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/DeliveryAgentConnector | 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/DeliveryAgentConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/DeliveryAgentConnector/[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/DeliveryAgentConnector and the JSON format can be used to import instances of device/exchangehybrid/DeliveryAgentConnector.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/DeliveryAgentConnector instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/DeliveryAgentConnector. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/DeliveryAgentConnector/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |