[Index]
Model ref.: device/exchangehybrid/ReceiveConnector
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": {
"MessageRateLimit": {
"__type_requested": "System.String",
"required": false,
"description": "The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. The default value for a Receive connector configured on a Mailbox server is unlimited. The default value for a Receive connector configured on an Edge server is 600 messages per minute. The valid input range for this parameter is 1 to 2147483647. To remove the message rate limit on a Receive connector, enter a value of unlimited.",
"title": "MessageRateLimit",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MessageRateLimit"
},
"SizeEnabled": {
"__type_requested": "System.String",
"required": false,
"description": "The SizeEnabled parameter specifies whether the SIZE SMTP extension is enabled. Valid values for this parameter are Enabled, Disabled, or EnabledwithoutValue. The default value is Enabled. When the SizeEnabled parameter is set to Enabled, the SIZE SMTP extension is enabled, and the maximum allowed message size value from the MaxMessageSize parameter is advertised in the EHLO banner. When the SizeEnabled parameter is set to Disabled, the SIZE SMTP extension isn't used, and the maximum allowed message size value is never disclosed to the remote server. When the SizeEnabled parameter is set to EnabledWithoutValue, the SIZE SMTP extension is enabled. However, the maximum allowed message size value from the MaxMessageSize parameter isn't advertised in the EHLO banner. This allows the message to bypass message size checks for authenticated connections between Mailbox servers. The SIZE SMTP extension is defined in RFC 1870. The SIZE SMTP extension enables the source server to declare the size of the inbound message to the target server. It also allows the target server to declare the maximum message size that it's allowed to accept to the sending server. If the advertised size of the inbound message exceeds the value in the MaxMessageSize parameter, the Receive connector responds to the remote server by using an error code and closes the connection.",
"title": "SizeEnabled",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SizeEnabled"
},
"MaxHopCount": {
"__type_requested": "Int32",
"required": false,
"description": "The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received header fields that exist in a submitted message. The default value is 30. The valid input range for this parameter is from 1 through 500.",
"title": "MaxHopCount",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxHopCount"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": false,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"BareLinefeedRejectionEnabled": {
"__type_requested": "System.Boolean",
"required": false,
"name": "BareLinefeedRejectionEnabled",
"title": "BareLinefeedRejectionEnabled",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean",
"description": "The BareLinefeedRejectionEnabled parameter specifies whether this Receive connector rejects messages that contain bare line feed (LF) characters in the SMTP DATA stream.\nLine feed characters that aren't immediately preceded by carriage return (CR) characters are known as bare line feeds. Bare line feeds aren't allowed in SMTP communications. Although it may be possible for a message containing a bare line feed to be delivered successfully, such messages don't adhere to the SMTP protocol standards and may cause problems with messaging servers. If you set this parameter to $true, the Receive connector rejects any messages that contain bare line feeds.\nThe default value is $false."
},
"ProxyEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "ProxyEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ProxyEnabled"
},
"Custom": {
"__type_requested": "SwitchParameter",
"required": false,
"description": "The Custom parameter specifies the Custom usage type. The usage type specifies the default permission groups and authentication methods assigned to the Receive connector. If you use the Custom parameter, you can't use any of the following parameters:\nClient\nInternal\nInternet\nPartner\nUsage\nIf you specify the Custom parameter, you must specify a value for the following parameters:\nBindings\nRemoteIPRanges\nIf you don't provide a value for a required parameter, this command prompts you so that it may continue.",
"title": "Custom",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Custom"
},
"Usage": {
"__type_requested": "Custom | Internet | Internal | Client | Partner",
"required": true,
"description": "The Usage parameter specifies the default permission groups and authentication methods assigned to the Receive connector. The valid values for the Usage parameter are as follows: Client, Custom, Internal, Internet, and Partner.\nIf you specify a value for the Usage parameter, you can't use any of the following parameters:\nClient\nInternal\nInternet\nPartner\nCustom\nA value for the Bindings parameter is required if you specify any of the following values for the Usage parameter:\nInternet\nPartner\nCustom\nA value for the RemoteIPRanges parameter is required if you specify any of the following values for the Usage parameter:\nClient\nInternal\nPartner\nCustom\nIf you don't specify a value for a required parameter, the command ends unsuccessfully. This command won't prompt you for the missing required parameters.\nFor more information about Receive connector usage types, permission groups, and authentication methods, see Receive connectors.",
"title": "Usage",
"__type_mapping_type": "Unknown",
"name": "Usage",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"Internal": {
"__type_requested": "SwitchParameter",
"required": true,
"description": "The Internal parameter specifies the Internal usage type. The usage type specifies the default permission groups and authentication methods assigned to the Receive connector. If you use the Internal parameter, you can't use any of the following parameters:\nClient\nInternet\nPartner\nCustom\nUsage\nIf you specify the Internal parameter, you must specify a value for the RemoteIPRanges parameter. If you don't specify a value for a required parameter, the command prompts you so that it may continue.\nFor more information about Receive connector usage types, permission groups, and authentication methods, see Receive connectors.",
"title": "Internal",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Internal"
},
"Internet": {
"__type_requested": "SwitchParameter",
"required": true,
"description": "The Internet parameter specifies the Internet usage type. The usage type specifies the default permission groups and authentication methods assigned to the Receive connector. If you use the Internet parameter, you can't use any of the following parameters:\nClient\nInternal\nPartner\nCustom\nUsage\nIf you specify the Internet parameter, you must specify a value for the Bindings parameter. If you don't provide a value for a required parameter, this command prompts you so that it may continue.\nFor more information about Receive connector usage types, permission groups, and authentication methods, see Receive connectors.",
"title": "Internet",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Internet"
},
"ConnectionTimeout": {
"__type_requested": "System.String",
"required": false,
"description": "The ConnectionTimeout parameter specifies the maximum time that a connection can remain open, even if the connection is actively transmitting data. The default value for a Receive connector configured on a Mailbox server is 10 minutes. The default value for a Receive connector configured on an Edge server is 5 minutes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a connection time-out of 5 minutes, enter 00.00:05:00.\nThe value specified by the ConnectionTimeout parameter must be greater than the value specified by the ConnectionInactivityTimeout parameter. The valid input range for either parameter is from 00:00:01 through 1.00:00:00.",
"title": "ConnectionTimeout",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ConnectionTimeout"
},
"AdminDisplayName": {
"__type_requested": "System.String",
"required": false,
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AdvertiseClientSettings": {
"__type_requested": "$true | $false",
"required": false,
"description": "The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings are displayed in the Outlook Web App, accessed from Settings > Options > Account > my Account > Settings for POP or IMAP access.\nThe default value is $false.",
"title": "AdvertiseClientSettings",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AdvertiseClientSettings"
},
"ProtocolLoggingLevel": {
"__type_requested": "System.String",
"required": false,
"description": "The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for a Receive connector. A value of Verbose enables protocol logging for the connector. A value of None disables protocol logging for the connector. The default value is None. The location of the Receive connector protocol logs for all Receive connectors configured on a Mailbox server or an Edge server is specified by using the ReceiveProtocolLogPath parameter of the Set-TransportService cmdlet.",
"title": "ProtocolLoggingLevel",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ProtocolLoggingLevel"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"PermissionGroups": {
"__type_requested": "System.String",
"required": false,
"description": "The PermissionGroups parameter specifies the groups or roles that can submit messages to the Receive connector and the permissions assigned to those groups. A permission group is a predefined set of permissions granted to well-known security principals. The valid values for this parameter are as follows: None, AnonymousUsers, ExchangeUsers, ExchangeServers, ExchangeLegacyServersPartners, and Custom. The default permission groups assigned to a Receive connector depend on the connector usage type that was specified by the Usage parameter when the Receive connector was created. For more information about Receive connector usage types, see Receive connectors.",
"title": "PermissionGroups",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "PermissionGroups"
},
"MaxHeaderSize": {
"__type_requested": "System.String",
"required": false,
"description": "The MaxHeaderSize parameter specifies in bytes the maximum size of the SMTP message header that the Receive connector accepts before it closes the connection. The default value is 65536 bytes.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe valid input range for this parameter is from 1 through 2147483647 bytes.",
"title": "MaxHeaderSize",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MaxHeaderSize"
},
"ExtendedProtectionPolicy": {
"__type_requested": "System.String",
"required": false,
"description": "The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is implemented on this Receive connector. By default, this parameter is set to None. The ExtendedProtectionPolicy parameter may have the following values:\nNone Extended Protection for Authentication isn't used.\nAllow Extended Protection for Authentication is used only if the connecting host supports it. Otherwise, connections are established without Extended Protection for Authentication.\nRequire Extended Protection for Authentication is required for all incoming connections to this Receive connector. If the connecting host doesn't support Extended Protection for Authentication, the connection is rejected.\nExtended Protection for Authentication enhances the protection and handling of credentials when authenticating network connections using Integrated Windows authentication. Integrated Windows authentication is also known as NTLM. We strongly recommend that you use Extended Protection for Authentication if you are using Integrated Windows authentication.",
"title": "ExtendedProtectionPolicy",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ExtendedProtectionPolicy"
},
"ConnectionInactivityTimeout": {
"__type_requested": "System.String",
"required": false,
"description": "The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to a Receive connector is closed. The default value for a Receive connector configured on a Mailbox server is 5 minutes. The default value for a Receive connector configured on an Edge server is 1 minute.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nThe value specified by the ConnectionTimeout parameter must be greater than the value specified by the ConnectionInactivityTimeout parameter. The valid input range for either parameter is 00:00:01 to 1.00:00:00.",
"title": "ConnectionInactivityTimeout",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ConnectionInactivityTimeout"
},
"SmtpUtf8Enabled": {
"__type_requested": "System.Boolean",
"required": false,
"name": "SmtpUtf8Enabled",
"title": "SmtpUtf8Enabled",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean",
"description": "This parameter is reserved for internal Microsoft use."
},
"PipeliningEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The PipeliningEnabled parameter specifies whether the PIPELINING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid values for this parameter are $true or $false. When the PipeliningEnabled parameter is set to $true, the PIPELINING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the PipeliningEnabled parameter is set to $false, the PIPELINING EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled. The PIPELINING extension enables the remote server to send requests without waiting for a response from this Receive connector. The default value is $true.",
"title": "PipeliningEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "PipeliningEnabled"
},
"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"
},
"DefaultDomain": {
"__type_requested": "",
"required": false,
"description": "The DefaultDomain parameter specifies the domain name to append to values that are submitted to MAIL FROM or RCPT TO in the message envelope by a sending server if no domain name is provided.",
"title": "DefaultDomain",
"__type_mapping_type": "Unknown",
"name": "DefaultDomain",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ServiceDiscoveryFqdn": {
"__type_requested": "Fqdn",
"required": false,
"description": "The service discovery fully-qualified domain name (FQDN).",
"title": "ServiceDiscoveryFqdn",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ServiceDiscoveryFqdn"
},
"BinaryMimeEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The BinaryMimeEnabled parameter specifies whether the BINARYMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid values for this parameter are $true or $false. The default value is $true. When the BinaryMimeEnabled parameter is set to $true, the BINARYMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the BinaryMimeEnabled parameter is set to $false, the BINARYMIME EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled.",
"title": "BinaryMimeEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "BinaryMimeEnabled"
},
"MaxInboundConnectionPerSource": {
"__type_requested": "System.String",
"required": false,
"description": "The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. The default value is 100. The valid input range for this parameter is from 1 through 10000. To disable the inbound connection per source limit on a Receive connector, enter a value of unlimited.",
"title": "MaxInboundConnectionPerSource",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MaxInboundConnectionPerSource"
},
"TarpitInterval": {
"__type_requested": "System.String",
"required": false,
"description": "The TarpitInterval parameter specifies the amount of time to delay an SMTP response to a remote server that may be abusing the connection. Authenticated connections are never delayed in this manner. The default value is 5 seconds.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nThe valid input range for this parameter is from 00:00:00 through 00:10:00. When you set the value to 00:00:00, you disable the tarpit interval.",
"title": "TarpitInterval",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "TarpitInterval"
},
"MaxInboundConnectionPercentagePerSource": {
"__type_requested": "Int32",
"required": false,
"description": "The MaxInboundConnectionPercentagePerSource parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, expressed as the percentage of available remaining connections on a Receive connector. Enter the value as an integer without the percent sign (%). The default value is 2 percent. The valid input range for this parameter is 1 to 100.",
"title": "MaxInboundConnectionPercentagePerSource",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxInboundConnectionPercentagePerSource"
},
"EnhancedStatusCodesEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid values for this parameter are $true or $false. The default value is $true. When the EnhancedStatusCodesEnabled parameter is set to $true, the ENHANCEDSTATUSCODES EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the EnhancedStatusCodesEnabled parameter is set to $false, the ENHANCEDSTATUSCODES EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled. The ENHANCEDSTATUSCODES extension provides enhanced error and status information in delivery status notification messages sent to remote servers.",
"title": "EnhancedStatusCodesEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnhancedStatusCodesEnabled"
},
"Banner": {
"__type_requested": "String",
"required": false,
"description": "The Banner parameter specifies an SMTP 220 banner and overrides the default SMTP 220 banner. When the value of the Banner parameter is blank, the default SMTP banner is the following:\n220 <Servername> Microsoft ESMTP MAIL service ready at <RegionalDay-Date-24HourTimeFormat> <RegionalTimeZoneOffset>\nWhen you specify a value for the Banner parameter, you must use the following syntax:\n220 <RemainingBannerText>.\n220 is the default Service ready SMTP response code as defined in RFC 2821.",
"title": "Banner",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Banner"
},
"MaxLocalHopCount": {
"__type_requested": "Int32",
"required": false,
"description": "The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers with local server addresses in a submitted message. The default value is 8. The valid input range for this parameter is 0 to 50. When you specify a value of 0, the message is never rejected based on the number of local hops.",
"title": "MaxLocalHopCount",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxLocalHopCount"
},
"Identity": {
"__type_requested": "System.String",
"required": false,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": true,
"type": "string",
"description": "Specifies the GUID or connector name that represents a specific Receive connector. You can also include the server name using the format ServerName\\ConnectorName.\nYou can omit the parameter label so that only the connector name or GUID is supplied."
},
"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"
},
"EightBitMimeEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EightBitMimeEnabled parameter specifies whether the 8BITMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid values for this parameter are $true or $false. The default value is $true. When the EightBitMimeEnabled parameter is set to $true, the 8BITMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the EightBitMimeEnabled parameter is set to $false, the 8BITMIME EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled.",
"title": "EightBitMimeEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EightBitMimeEnabled"
},
"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 administrator-supplied name of the connector. Enter the Name parameter as a string, for example: \"New Receive Connector\".",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Name"
},
"EnableAuthGSSAPI": {
"__type_requested": "$true | $false",
"required": false,
"description": "The EnableAuthGSSAPI parameter specifies the advertisement of the Generic Security Services application programming interface (GSSAPI) authentication method, when Integrated Windows authentication is enabled on this connector. If the AuthMechanism parameter contains Integrated, and the EnableAuthGSSAPI parameter is set to $true, the AUTH GSSAPI NTLM keyword is advertised in the EHLO response of the Receive connector. Clients may use Kerberos or NTLM to authenticate with the Receive connector. If the AuthMechanism parameter contains Integrated, and the EnableAuthGSSAPI parameter is set to $false, the AUTH NTLM keyword is advertised in the EHLO response of the Receive connector. Clients may use only NTLM to authenticate with the Receive connector.\nIf you have Internet Information Services (IIS) messaging servers that authenticate with this Receive connector, you should set the value of the EnableAuthGSSAPI parameter to $false. Authentication with computers running Microsoft Exchange Server 2003 aren't affected by the value of the EnableAuthGSSAPI parameter. Exchange 2003 servers use the authentication methods advertised in the X-EXPS keyword. The X-EXPS keyword is advertised in the EHLO response of the Receive connector when the AuthMechanism parameter contains ExchangeServer.\nThe valid values for this parameter is $true or $false. The default value is $false. By default, the EnableAuthGSSAPI parameter is set to $true only on the default Receive connector Client <Server Name> created only in the Transport service on a Mailbox server.",
"title": "EnableAuthGSSAPI",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableAuthGSSAPI"
},
"Enabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The Enabled parameter specifies whether to enable the connector. Valid values for this parameter are $true or $false. The default value is $true. Use the Enabled parameter to enable or disable the connector.",
"title": "Enabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Enabled"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"ChunkingEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The ChunkingEnabled parameter specifies whether the CHUNKING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid input for this parameter is $true or $false. The default value is $true. When the ChunkingEnabled parameter is set to $true, the CHUNKING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the ChunkingEnabled parameter is set to $false, the CHUNKING EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled.",
"title": "ChunkingEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ChunkingEnabled"
},
"SuppressXAnonymousTls": {
"__type_requested": "$true | $false",
"required": false,
"description": "The SuppressXAnonymousTls parameter specifies whether this Receive connector supports the standard TLS encryption for incoming connections. By default, all communications between servers is protected with TLS. However, if you need to disable TLS on a specific connection in your organization, you can create a specific Receive connector and set the SuppressXAnonymousTls parameter to $true. The default value is $false.\nBefore you can set this parameter to $true, you must use the Set-TransportService cmdlet to set the UseDownGradedExchangeServerAuth parameter to $true on the server this Receive connector is configured.",
"title": "SuppressXAnonymousTls",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "SuppressXAnonymousTls"
},
"Fqdn": {
"__type_requested": "Fqdn",
"required": false,
"description": "The Fqdn parameter specifies the FQDN used as the destination server for connected messaging servers that use the Receive connector to send incoming messages. The value of this parameter is displayed to connected messaging servers whenever a destination server name is required, as in the following examples:\nIn the default SMTP banner of the Receive connector\nIn the EHLO/HELO response of the Receive connector\nIn the most recent Received header field in the incoming message when the message enters the Transport service of a Mailbox server or an Edge server\nDuring TLS authentication\nThe default value of the Fqdn parameter is the FQDN of the Mailbox server or Edge server that contains the Receive connector.\nDon't modify the FQDN value on the default Receive connector Default <Server Name> that's automatically created in the Transport service of a Mailbox server. If you have multiple Mailbox servers in your Exchange organization and you change the FQDN value on the Default <Server Name> Receive connector, internal mail flow between Mailbox servers will fail.",
"title": "Fqdn",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Fqdn"
},
"LongAddressesEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method.\nWhen the value of this parameter is $false, the maximum length for a complete SMTP email address is 571 characters.\nWhen the value of this parameter is $true, the following changes are made:\nThe XLONGADDR keyword is advertised in the EHLO response of the Receive connector.\nThe accepted line length of an SMTP session is increased to 8,000 characters.\nValid long addresses are accepted by the MAIL FROM and RCPT TO SMTP commands.\nTherefore, X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation.\nThe valid values for this parameter are $true or $false. The default value is $false. You can modify this parameter only on Receive connectors configured in the Transport service on a Mailbox server.",
"title": "LongAddressesEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "LongAddressesEnabled"
},
"DomainSecureEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The DomainSecureEnabled parameter enables mutual Transport Layer Security (TLS) authentication for the domains serviced by this Receive connector. Mutual TLS authentication functions correctly only if the following conditions are true:\nThe value of the DomainSecureEnabled parameter is $true.\nThe AuthMechanism parameter contains the value Tls and doesn't contain the value ExternalAuthoritative.\nThe value of the AuthMechanism parameter contains Tls.\nThe TLSReceiveDomainSecureList parameter in the Get-TransportConfig command contains at least one domain serviced by this Receive connector. The wildcard character (*) isn't supported in domains that are configured for mutual TLS authentication. The same domain must also be defined on the corresponding Send connector, and in the value of the TLSSendDomainSecureList parameter in the Get-TransportConfig command.\nThe default value for the DomainSecureEnabled parameter is $false for the following types of Receive connectors:\nAll Receive connectors defined in the Transport service on a Mailbox server\nUser-created Receive connectors defined on an Edge server\nThe default value for the DomainSecureEnabled parameter is $true for default Receive connectors defined on an Edge server.",
"title": "DomainSecureEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DomainSecureEnabled"
},
"MaxMessageSize": {
"__type_requested": "System.String",
"required": false,
"description": "The MaxMessageSize parameter specifies the maximum size of a message. The default value is 25 MB.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are treated as bytes.\nThe valid input range for this parameter is from 65536 through 2147483647 bytes.",
"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"
},
"MaxLogonFailures": {
"__type_requested": "Int32",
"required": false,
"description": "The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. The default value is 3. The valid input range for this parameter is from 0 through 10. When you specify a value of 0, the connection is never closed because of logon failures.",
"title": "MaxLogonFailures",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxLogonFailures"
},
"DeliveryStatusNotificationEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The DeliveryStatusNotificationEnabled parameter specifies whether the delivery status notification (DSN) EHLO keyword is advertised in the EHLO response to the remote server and is available for use. Valid values for this parameter are $true or $false. The default value is $true. When the DeliveryStatusNotificationEnabled parameter is set to $true, the DSN EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the DeliveryStatusNotificationEnabled parameter is set to $false, the DSN EHLO keyword isn't advertised in the EHLO response to the remote server and is disabled. The DSN extension to extended SMTP (ESMTP) provides enhanced DSN functionality specified in RFC 1891.",
"title": "DeliveryStatusNotificationEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DeliveryStatusNotificationEnabled"
},
"MaxInboundConnection": {
"__type_requested": "System.String",
"required": false,
"description": "The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. The default value is 5000. The valid input range for this parameter is from 1 through 2147483647. To disable the inbound connection limit on a Receive connector, enter a value of unlimited.",
"title": "MaxInboundConnection",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MaxInboundConnection"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": false,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Server": {
"__type_requested": "System.String",
"required": false,
"description": "The Server parameter specifies the server on which the new Receive connector is created.",
"title": "Server",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Server"
},
"Client": {
"__type_requested": "SwitchParameter",
"required": true,
"description": "The Client parameter specifies the Client usage type. The usage type specifies the default permission groups and authentication methods assigned to the Receive connector. If you use the Client parameter, you can't use any of the following parameters:\nInternal\nInternet\nPartner\nCustom\nUsage\nIf you specify the Client parameter, you must specify a value for the RemoteIPRanges parameter. If you don't specify a value for a required parameter, this command prompts you so that it may continue.\nFor more information about Receive connector usage types, permission groups, and authentication methods, see Receive connectors.",
"title": "Client",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Client"
},
"TlsDomainCapabilities": {
"__type_requested": "MultiValuedProperty",
"required": false,
"description": "The TlsDomainCapabilities parameter specifies the capabilities this Receive connector will make available to specific hosts outside your organization. TLS with certificate validation is used to authenticate remote hosts before these capabilities are offered.\nTo specify capabilities for a domain, use the following syntax:\n<domain name 1>:<capability 1, capability 2,\u2026,capability N>\nIf you're specifying capabilities for multiple domains, list the configuration for each domain in quotation marks (\"), separated by commas. For example:\n\"contoso.com:AcceptOorgProtocol\",\"fabrikam.com:AcceptOorgProtocol,AcceptOorgHeader\"\nYou can configure the capabilities for non-TLS encrypted incoming connections using the special \"NO-TLS\" domain.\nYou can configure the following capabilities for a domain:\nAcceptOorgProtocol\nAcceptOorgHeader",
"title": "TlsDomainCapabilities",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "TlsDomainCapabilities"
},
"TlsCertificateName": {
"__type_requested": "",
"required": false,
"description": "The TlsCertificateName parameter specifies the X.509 certificate to use with TLS sessions and secure mail. Valid input for this parameter is [I]Issuer[S]Subject. The Issuer value is found in the certificate's Issuer field, and the Subject value is found in the certificate's Subject field. You can find these values by running the Get-ExchangeCertificate cmdlet.",
"title": "TlsCertificateName",
"__type_mapping_type": "Unknown",
"name": "TlsCertificateName",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"MaxProtocolErrors": {
"__type_requested": "System.String",
"required": false,
"description": "The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. The default value is 5. The valid input range for this parameter is from 0 through 2147483647. When you specify a value of unlimited, a connection is never closed because of protocol errors.",
"title": "MaxProtocolErrors",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MaxProtocolErrors"
},
"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"
},
"Bindings": {
"__type_requested": "MultiValuedProperty",
"required": true,
"description": "The Bindings parameter specifies the local IP address and TCP port number used by the Receive connector to listen for inbound messages. Valid syntax for this parameter is <IP Address>:<TCP Port>, such as 192.168.1.1:25. The IP address 0.0.0.0 indicates that the Receive connector uses all IP addresses configured on all network adapters to listen for inbound messages.\nYou must specify a local IP address that's valid for the Mailbox server or Edge server on which the Receive connector is located. If you specify an invalid local IP address, the Microsoft Exchange Transport service may fail to start when the service is restarted.\nYou must specify a value for the Bindings parameter when the following parameters are specified:\nInternet or Usage parameter with a value of Internet\nPartner or Usage parameter with a value of Partner\nCustom or Usage parameter with a value of Custom\nThe values that you specify using the Bindings parameter must satisfy one of the following requirements for uniqueness:\nYou can specify a unique combination of IP address and TCP port that doesn't conflict with the IP address or TCP port used in the Bindings parameter of another Receive connector on the server.\nYou can use an existing combination of IP address and TCP port, but use the RemoteIPRanges parameter to restrict the remote servers serviced by the Receive connector. However, when you use this command to create a Receive connector, you can only use the RemoteIPRanges parameter and the Bindings parameter together when the following parameters are specified: Custom or Usage parameter with a value of Custom. Partner or Usage parameter with a value of Partner.\nYou can't specify a value for the Bindings parameter with this command when the following parameters are specified:\nClient or Usage parameter with a value of Client. The default value of the Bindings parameter is 0.0.0.0:587. This value indicates that the connector accepts connections on TCP port 587 on all IP addresses configured on all network adapters in the server.\nInternal or Usage parameter with a value of Internal. The default value of the Bindings parameter is 0.0.0.0:25. This value indicates that the connector accepts connections on TCP port 25 on all IP addresses configured on all network adapters in the server.",
"title": "Bindings",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "Bindings"
},
"RequireTLS": {
"__type_requested": "$true | $false",
"required": false,
"description": "The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for thisparameter are $true or $false. The default value is $false. When the RequireTLS parameter is set to $true, all messages received by this connector require TLS transmission.",
"title": "RequireTLS",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "RequireTLS"
},
"RemoteIPRanges": {
"__type_requested": "MultiValuedProperty",
"required": true,
"description": "The RemoteIPRanges parameter specifies the remote IP addresses from which this connector accepts messages. Valid syntax for this parameter is <Starting IP Address>-<Ending IP Address>, such as 192.168.1.1-192.168.1.10. You can specify multiple IP address ranges separated by commas.\nYou must specify a value for the RemoteIPRanges parameter when the following parameters are specified:\nClient or Usage parameter with a value of Client\nInternal or Usage parameter with a value of Internal\nPartner or Usage parameter with a value of Partner\nCustom or Usage parameter with a value of Custom\nMultiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another IP address. When remote IP address ranges overlap, the remote IP address range with the most specific match to the IP address of the connecting server is used.\nThe default value of the RemoteIPRanges parameter for the Internet usage type is 0.0.0.0-255.255.255.255. This value indicates that the connector accepts connections from all remote IP addresses.",
"title": "RemoteIPRanges",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"name": "RemoteIPRanges"
},
"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"
},
"AuthMechanism": {
"__type_requested": "System.String",
"required": false,
"description": "The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms. The authentication options are None, Tls, Integrated, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. You can enter multiple values for the AuthMechanism parameter by separating the values with commas. If the RequireTLS parameter is set to $true, the AuthMechanism parameter must be set to Tls. If you set the AuthMechanism parameter to BasicAuthRequireTLS, you must also select BasicAuth and Tls. The AuthMechanism parameter value ExternalAuthoritative may only coexist with the value Tls. If you set the AuthMechanism parameter to ExternalAuthoritative, the PermissionGroups parameter must also have the value ExchangeServers.",
"title": "AuthMechanism",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "AuthMechanism"
},
"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"
},
"MessageRateSource": {
"__type_requested": "System.String",
"required": false,
"description": "The MessageRateSource parameter specifies how the message submission rate is calculated. It can have one of the following values:\nNone: The message submission rate isn't calculated.\nUser: The message submission rate is calculated for sending users (specified with the MAIL FROM SMTP command).\nIPAddress: The message submission rate is calculated for sending hosts.\nAll: The message submission rate is calculated for both sending users and sending hosts.",
"title": "MessageRateSource",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MessageRateSource"
},
"ObjectState": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"OrarEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "The OrarEnabled parameter enables the Originator Requested Alternate Recipient (ORAR). When the value of this parameter is $false, ORAR isn't supported. When the value of this parameter is $true, ORAR is supported by advertising the XORAR keyword in the EHLO response of the Receive connector. The actual ORAR information is transmitted in the RCPT TO SMTP command.\nThe valid values for this parameter are $true or $false. The default value is $false. If the email address specified in the ORAR information is a long X.400 email address, the LongAddressesEnabled parameter must be $true.",
"title": "OrarEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "OrarEnabled"
},
"MaxRecipientsPerMessage": {
"__type_requested": "Int32",
"required": false,
"description": "The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. The default value is 200. The valid input range for this parameter is 1 to 512000.",
"title": "MaxRecipientsPerMessage",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxRecipientsPerMessage"
},
"RequireEHLODomain": {
"__type_requested": "$true | $false",
"required": false,
"description": "The RequireEHLODomain parameter specifies whether the remote computer must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values for this parameter are $true or $false. The default value is $false. When the RequireEHLODomain parameter is set to $true, the remote computer must provide a domain name in the EHLO handshake after the SMTP connection is established. If the remote computer doesn't provide the domain name, the SMTP connection is closed.",
"title": "RequireEHLODomain",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "RequireEHLODomain"
},
"Partner": {
"__type_requested": "SwitchParameter",
"required": true,
"description": "The Partner parameter specifies the Partner usage type. The usage type specifies the default permission groups and authentication methods assigned to the Receive connector. If you use the Partner parameter, you can't use any of the following parameters:\nClient\nInternal\nInternet\nCustom\nUsage\nIf you specify the Partner parameter, you must specify a value for the following parameters:\nBindings\nRemoteIPRanges\nIf you don't provide a value for a required parameter, this command prompts you so that it may continue.",
"title": "Partner",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "Partner"
},
"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"
},
"MaxAcknowledgementDelay": {
"__type_requested": "System.String",
"required": false,
"description": "This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment.\nThe MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgement until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgement anyway.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nThe default value is 30 seconds.",
"title": "MaxAcknowledgementDelay",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MaxAcknowledgementDelay"
},
"Id": {
"__type_requested": "System.String",
"required": false,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"TransportRole": {
"__type_requested": "System.String",
"required": false,
"description": "The TransportRole parameter designates the server role associated with this connector. Types include FrontendTransport and HubTransport. Typically used to specify the server role when you host multiple server roles on a single computer.",
"title": "TransportRole",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "TransportRole"
},
"LiveCredentialEnabled": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter is reserved for internal Microsoft use.",
"title": "LiveCredentialEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "LiveCredentialEnabled"
}
},
"schema_version": "15312"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/exchangehybrid/ReceiveConnector/add/ |
|
The GUI Add form of device/exchangehybrid/ReceiveConnector 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/ReceiveConnector/ | 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/ReceiveConnector/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangehybrid/ReceiveConnector/[pkid1]", "/api/device/exchangehybrid/ReceiveConnector/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangehybrid/ReceiveConnector/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangehybrid/ReceiveConnector/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangehybrid/ReceiveConnector/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/ReceiveConnector/[pkid1]", "/api/v0/device/exchangehybrid/ReceiveConnector/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/ReceiveConnector/?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/ReceiveConnector |
|
{"hrefs": ["/api/device/exchangehybrid/ReceiveConnector/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/ReceiveConnector |
|
{"hrefs": ["/api/device/exchangehybrid/ReceiveConnector/[pkid1]", "/api/device/exchangehybrid/ReceiveConnector/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/ReceiveConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/ReceiveConnector/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/ReceiveConnector/[pkid1]", "/api/device/exchangehybrid/ReceiveConnector/[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/ReceiveConnector and the JSON format can be used to import instances of device/exchangehybrid/ReceiveConnector.
GET http://[host-proxy]/api/device/exchangehybrid/ReceiveConnector/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/ReceiveConnector | POST | /api/device/exchangehybrid/ReceiveConnector/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/ReceiveConnector/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/ReceiveConnector/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangehybrid/ReceiveConnector/ |
|
The device/exchangehybrid/ReceiveConnector schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/ReceiveConnector instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangehybrid/ReceiveConnector/?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/ReceiveConnector/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/exchangehybrid/ReceiveConnector/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangehybrid/ReceiveConnector/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/ReceiveConnector",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangehybrid/ReceiveConnector/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/ReceiveConnector/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangehybrid/ReceiveConnector/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangehybrid/ReceiveConnector/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangehybrid/ReceiveConnector/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangehybrid/ReceiveConnector/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangehybrid/ReceiveConnector/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangehybrid/ReceiveConnector",
"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": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangehybrid/ReceiveConnector. | GET | /api/device/exchangehybrid/ReceiveConnector/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/ReceiveConnector as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangehybrid/ReceiveConnector/[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/ReceiveConnector/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/ReceiveConnector/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/ReceiveConnector/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/ReceiveConnector | 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/ReceiveConnector; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/ReceiveConnector/[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/ReceiveConnector and the JSON format can be used to import instances of device/exchangehybrid/ReceiveConnector.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangehybrid/ReceiveConnector/[pkid]/ | hierarchy=[hierarchy] | The device/exchangehybrid/ReceiveConnector instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangehybrid/ReceiveConnector/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/ReceiveConnector. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangehybrid/ReceiveConnector/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |