Receive Locations - Update
Update Receive Location
PUT http://localhost/BizTalkManagementService/ReceiveLocations/{receiveLocationName}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
receive
|
path | True |
string |
Request Body
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
Name | Type | Description |
---|---|---|
Address |
string |
Address property for the adapter. |
CustomData |
string |
Custom data |
Description |
string |
Description for the receive location. |
Enable |
boolean |
Status of the receive location. |
EncryptionCert |
Encryption certificate that is used to encrypt data sent through this port. |
|
FragmentMessages |
string |
Field to fragment messages |
IsPrimary |
boolean |
Determines whether the receive location is primary receive location of the receive port |
Name |
string |
Name of the receive location. |
PublicAddress |
string |
Public Address property for the adapter. |
ReceiveHandler |
string |
Receive handler for this receive location. |
ReceivePipeline |
string |
Receive pipeline used to receive a response when a message is sent out through this receive location. |
ReceivePipelineData |
string |
Custom configuration of receive pipeline specific to this instance of the usage of the pipeline. |
ReceivePortName |
string |
Receive port name to which this receive location belongs to |
Schedule |
Service window |
|
SendPipeline |
string |
Send pipeline used to send data sent through this receive location. |
SendPipelineData |
string |
Custom configuration of send pipeline specific to this instance of the usage of the pipeline. |
TransportType |
string |
Protocol for the adapter. |
TransportTypeData |
string |
Configuration specific to the adapter. |
Responses
Name | Type | Description |
---|---|---|
204 No Content |
No Content |
Definitions
Name | Description |
---|---|
Certificate |
Encryption certificate |
Receive |
Receive location model |
Receive |
Service window |
CertificateInfo
Encryption certificate
Name | Type | Description |
---|---|---|
CommonName |
string |
Common Name |
Thumbprint |
string |
Thumbprint of the certificate. |
ReceiveLocation
Receive location model
Name | Type | Description |
---|---|---|
Address |
string |
Address property for the adapter. |
CustomData |
string |
Custom data |
Description |
string |
Description for the receive location. |
Enable |
boolean |
Status of the receive location. |
EncryptionCert |
Encryption certificate that is used to encrypt data sent through this port. |
|
FragmentMessages |
string |
Field to fragment messages |
IsPrimary |
boolean |
Determines whether the receive location is primary receive location of the receive port |
Name |
string |
Name of the receive location. |
PublicAddress |
string |
Public Address property for the adapter. |
ReceiveHandler |
string |
Receive handler for this receive location. |
ReceivePipeline |
string |
Receive pipeline used to receive a response when a message is sent out through this receive location. |
ReceivePipelineData |
string |
Custom configuration of receive pipeline specific to this instance of the usage of the pipeline. |
ReceivePortName |
string |
Receive port name to which this receive location belongs to |
Schedule |
Service window |
|
SendPipeline |
string |
Send pipeline used to send data sent through this receive location. |
SendPipelineData |
string |
Custom configuration of send pipeline specific to this instance of the usage of the pipeline. |
TransportType |
string |
Protocol for the adapter. |
TransportTypeData |
string |
Configuration specific to the adapter. |
ReceiveLocationSchedule
Service window
Name | Type | Description |
---|---|---|
AutoAdjustToDaylightSaving |
boolean |
If auto adjust to day light saving |
DaysOfWeek |
string |
Days of week if recurrence schedule type is Weekly |
EndDate |
string |
End date of the service window |
EndDateEnabled |
boolean |
Flag indicating if end date of the service window is enabled. |
FromTime |
string |
Start time for the service window. |
LastDayOfMonth |
boolean |
If schedule on last day Of month |
MonthDays |
string |
Days of month if recurrence schedule type is Months |
Months |
string |
Months of year if recurrence schedule type is Months |
OrdinalDayOfWeek |
string |
Ordinal Day Of Week if recurrence schedule type is Months |
OrdinalSchedule |
string |
Ordinal type if recurrence schedule type is Months |
RecurFrom |
string |
Recur From |
RecurInterval |
integer |
Recurrence Interval |
RecurrenceSchType |
string |
Recurrence Schedule Type |
ScheduleIsOrdinal |
boolean |
if Schedule Is Ordinal |
ScheduleTimeZone |
string |
Time zone |
ServiceWindowEnabled |
boolean |
Flag that specifies whether the service window is enabled. |
StartDate |
string |
Start date of the service window |
StartDateEnabled |
boolean |
Flag indicating if start date of the service window is enabled. |
ToTime |
string |
End time for the service window. |