Send Ports - Get

Get Sendports

GET http://localhost/BizTalkManagementService/SendPorts

Responses

Name Type Description
200 OK

SendPort[]

OK

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
CertificateInfo

Encryption certificate

MessageBodyTracking

Message body tracking

MessagePropertyTracking

Message Property Tracking

Schedule

Service window

SendPort

Model for Send port

Tracking

Port tracking details

TransportInfo

The transport info.

CertificateInfo

Encryption certificate

Name Type Description
CommonName

string

Common Name

Thumbprint

string

Thumbprint of the certificate.

MessageBodyTracking

Message body tracking

Name Type Description
AfterReceivePipeline

boolean

Flag indicating whether body to be tracked after port processing of response message

AfterSendPipeline

boolean

Flag indicating whether body to be tracked after port processing of request message

BeforeReceivePipeline

boolean

Flag indicating whether body to be tracked before port processing of response message

BeforeSendPipeline

boolean

Flag indicating whether body to be tracked before port processing of request message

MessagePropertyTracking

Message Property Tracking

Name Type Description
AfterReceivePipeline

boolean

Flag indicating whether body to be tracked after port processing of response message

AfterSendPipeline

boolean

Flag indicating whether body to be tracked after port processing of request message

BeforeReceivePipeline

boolean

Flag indicating whether body to be tracked before port processing of response message

BeforeSendPipeline

boolean

Flag indicating whether body to be tracked before port processing of request message

Schedule

Service window

Name Type Description
FromTime

string

Start time for the service window.

ServiceWindowEnabled

boolean

Flag that specifies whether the service window is enabled.

ToTime

string

End time for the service window.

SendPort

Model for Send port

Name Type Description
ApplicationName

string

Application name to which sendport belongs to

CustomData

string

Custom data

Description

string

Description for the send port.

EncryptionCert

CertificateInfo

Encryption certificate that is used to encrypt data sent through this port.

Filter

string

Optional filter expression used for this send port.

InboundTransforms

string[]

Collection of inbound transforms of two-way send port

IsDynamic

boolean

Whether the send port is dynamic or static

IsTwoWay

boolean

Determines whether the port is two-way

Name

string

Name of the send port.

OrderedDelivery

boolean

Flag specifying whether or not the send port orders the delivery of messages.

OutboundTransforms

string[]

Collection of outbound transforms of send port

PrimaryTransport

TransportInfo

Primary transport information

Priority

integer

Priority of the send port.

ReceivePipeline

string

Receive pipeline used to receive a response when a message is sent out through this port.

ReceivePipelineData

string

Custom configuration information specific to the current instance of the receive pipeline.

RouteFailedMessage

boolean

Gets or sets a value indicating whether or not failed messages are routed to failed message subscribers.

SecondaryTransport

TransportInfo

Secondary transport of the static send port.

SendPipeline

string

Send pipeline used to send data sent through this port.

SendPipelineData

string

Custom configuration specific to this instance of the usage of the pipeline.

Status

string

Status of the send port.

StopSendingOnFailure

boolean

Flag indicating whether or not the send port stops sending messages on a failure.

Tracking

Tracking

Desired level of document tracking for the send port.

Tracking

Port tracking details

Name Type Description
Body

MessageBodyTracking

Message body tracking

Property

MessagePropertyTracking

Message property tracking

TransportInfo

The transport info.

Name Type Description
Address

string

Address property for the adapter.

OrderedDelivery

boolean

Flag that specifies whether the BizTalk Message Queuing adapter supports ordered delivery.

RetryCount

integer

Retry count for the adapter.

RetryInterval

integer

Retry interval for the adapter.

Schedule

Schedule

Service window

SendHandler

string

Send handler for this transport.

TransportType

string

Protocol for the adapter.

TransportTypeData

string

Configuration specific to the adapter.