Batches - Update
Update batch.
PUT http://localhost/BizTalkManagementService/Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
agreement
|
path | True |
string |
The agreement name. |
|
batch
|
path | True |
string |
The batch name. |
|
receiver
|
path | True |
string |
The receiver of the agreement. |
|
sender
|
path | True |
string |
The sender of the agreement. |
Request Body
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Type | Description |
|---|---|---|
| Description |
string |
Gets or sets the description. |
| EndDate |
string |
Gets or sets the end date. |
| Filter |
Gets or sets the filter predicate. |
|
| Id |
integer |
Gets or sets the id. |
| InterchangeSizeRelease |
Gets or sets the interchange size release criteria |
|
| ManualRelease |
Gets or sets the manual release criteria |
|
| MessageCountRelease |
Gets or sets the message count release criteria |
|
| Name |
string |
Gets or sets the name. |
| Protocol |
string |
Gets or sets the protocol. |
| StartDate |
string |
Gets or sets the start date. |
| TerminationCount |
integer |
Gets or sets the termination count. |
| TimeBasedRelease |
Gets or sets the time-based release criteria |
Responses
| Name | Type | Description |
|---|---|---|
| 204 No Content |
No Content |
Definitions
| Name | Description |
|---|---|
|
Batch |
Model for BatchDescription |
|
Daily |
Model for DailyRecurrence |
|
Filter |
Model for FilterGroup |
|
Filter |
Model for FilterGroup |
|
Filter |
Model for FilterStatement |
|
Hourly |
Model for HourlyRecurrence |
|
Interchange |
Model for InterchangeSizeReleaseCriteria |
|
Manual |
Model for ManualReleaseCriteria |
|
Message |
Model for MessageCountReleaseCriteria |
|
Time |
Model for TimeBasedReleaseCriteria |
|
Weekly |
Model for WeeklyRecurrence |
BatchDescription
Model for BatchDescription
| Name | Type | Description |
|---|---|---|
| Description |
string |
Gets or sets the description. |
| EndDate |
string |
Gets or sets the end date. |
| Filter |
Gets or sets the filter predicate. |
|
| Id |
integer |
Gets or sets the id. |
| InterchangeSizeRelease |
Gets or sets the interchange size release criteria |
|
| ManualRelease |
Gets or sets the manual release criteria |
|
| MessageCountRelease |
Gets or sets the message count release criteria |
|
| Name |
string |
Gets or sets the name. |
| Protocol |
string |
Gets or sets the protocol. |
| StartDate |
string |
Gets or sets the start date. |
| TerminationCount |
integer |
Gets or sets the termination count. |
| TimeBasedRelease |
Gets or sets the time-based release criteria |
DailyRecurrence
Model for DailyRecurrence
| Name | Type | Description |
|---|---|---|
| Days |
integer |
Gets or sets the days. |
| RecurrencePeriod |
string |
Gets or sets the recurrence period. |
FilterGroup
Model for FilterGroup
| Name | Type | Description |
|---|---|---|
| Statements |
Gets or sets the statements. |
FilterPredicate
Model for FilterGroup
| Name | Type | Description |
|---|---|---|
| Groups |
Gets or sets the groups. |
FilterStatement
Model for FilterStatement
| Name | Type | Description |
|---|---|---|
| Operator |
string |
Gets or sets the operator. |
| Property |
string |
Gets or sets the property. |
| Value |
string |
Gets or sets the value. |
HourlyRecurrence
Model for HourlyRecurrence
| Name | Type | Description |
|---|---|---|
| Hours |
integer |
Gets or sets the hours. |
| Minutes |
integer |
Gets or sets the minutes. |
| RecurrencePeriod |
string |
Gets or sets the recurrence period. |
InterchangeSizeReleaseCriteria
Model for InterchangeSizeReleaseCriteria
| Name | Type | Description |
|---|---|---|
| CharacterCount |
integer |
Gets or sets the character count. |
ManualReleaseCriteria
Model for ManualReleaseCriteria
MessageCountReleaseCriteria
Model for MessageCountReleaseCriteria
| Name | Type | Description |
|---|---|---|
| MessageCount |
integer |
Gets or sets the message count. |
| MessageScope |
string |
Gets or sets the message scope. |
TimeBasedReleaseCriteria
Model for TimeBasedReleaseCriteria
| Name | Type | Description |
|---|---|---|
| DailyRecurrence |
Gets or sets the recurrence schedule. |
|
| FirstRelease |
string |
Gets or sets the first release datetime. |
| HourlyRecurrence |
Gets or sets the recurrence schedule. |
|
| SendEmptyBatchSignal |
boolean |
Gets or sets a value indicating whether send empty batch signal. |
| WeeklyRecurrence |
Gets or sets the recurrence schedule. |
WeeklyRecurrence
Model for WeeklyRecurrence
| Name | Type | Description |
|---|---|---|
| RecurrencePeriod |
string |
Gets or sets the recurrence period. |
| WeekDays |
string |
Gets or sets the week days. |