Receive Ports - Get

Service:

BizTalk Server 2016

API Version:

v1

Get Receive Ports

GET http://localhost/BizTalkManagementService/ReceivePorts

Responses

Name	Type	Description
200 OK	ReceivePort[]	OK Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
MessageBodyTracking	Message body tracking
MessagePropertyTracking	Message Property Tracking
ReceivePort	Model for Receive port
Tracking	Port tracking details

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

ReceivePort

Model for Receive port

Name	Type	Description
ApplicationName	string	Application name to which receive port belongs to
CustomData	string	Custom data
Description	string	Description for the receive port.
InboundTransforms	string[]	Collection of inbound transforms of receive port
IsTwoWay	boolean	Determines whether the port is two-way
Name	string	Name of the receive port.
OutboundTransforms	string[]	Collection of outbound transforms of a two-way receive port
PrimaryReceiveLocation	string	Primary receive location name
ReceiveLocations	string[]	List of receive locations of the receive port
Tracking	Tracking	Desired level of document tracking for the receive port.

Tracking

Port tracking details

Name	Type	Description
Body	MessageBodyTracking	Message body tracking
Property	MessagePropertyTracking	Message property tracking