OData Batch Activity

You can use the OData Batch activity to create, update, query, and delete a batch request from an OData server.

Note: OData Batch activity is treated as a single operation. If any of the operations within the OData Batch activity fails, the remaining operations are rolled back and the activity faults.

General Tab

On the General tab, you can establish a connection to an OData server and specify the operation for which you want to run a batch request.

The following table lists the configurations in the General tab of the OData Batch activity:

Field Module Property? Description
Name No Specify the name of the activity in the process.
OData Connection Yes

The OData Connection shared resource that is used to create a connection between the plug-in and an OData server. Click to select an OData Connection shared resource.

If no matching OData Connection shared resources are found, click Create Shared Resource to create one. See Creating an OData Connection for more details

Build Batch Request  

Click Build Batch Request to create a batch. See Build Batch Request for more details.

Description Tab

On the Description tab, you can enter a short description for the OData Batch activity.

Advanced Tab

On the Advanced tab, select the Output HTTP Response Headers checkbox to receive response headers in the OData Batch activity.

The following table lists the configurations on the Advanced tab of the OData Batch activity:

Field Module Property? Description
Output HTTP Response Headers No Select this checkbox to receive HTTP Response Headers in the output.

Input Tab

On the Input tab, you can specify the required input of the OData Batch activity.

The input schema has many operations, which are configured using the Batch Request Builder dialog. The order of the operations is maintained as seen in the dialog.

The following table lists the input elements in the Input tab of this activity:

Input Item Data Type Description
ODataOperationInput Complex
  • Create

  • Create Entity: Shows the properties of the Entity Object which are selected in the Batch builder. The entity is a repeating element. If the user receives input from an upstream with multiple records, then we can map it using the Business Works for each loop to form the batch request.

  • Create Reference: Shows the Key Parameter items and the RefLink item.

  • Update

  • Update Entity: Shows the entity Key Parameter items and all properties.

  • Update property: Shows the entity Key Parameter items and property items.

  • Change Reference: Shows all the Key Parameter items and the Reference Link item.

  • Delete

  • Delete Entity: Shows the Key Parameter items.

  • Delete Reference: Shows the Key Parameter items and the Reference Link item.

  • Query

  • ODataURI: Overrides the values in the OData URI of the query operation in batchbuilder. It's a repeating element.

    Note: Ensure that the URI matches the resultant schema of URI.
    Parameters are not supported for this item.
  • Parameters: The items under this element are the parameters in the OData URI field that is present in List of Operations for Batch in Build BatchRequest for HTTP method "QUERY".

Output Tab

On the Output tab, you can find the output schema.

The output schema has many operations, which are configured using the Batch Request Builder dialog. The order of the operations is maintained as seen in the dialog.

The following table lists the output elements in the Output tab of the OData Batch activity:

Output Item Data Type Description
StatusCode String The OData batch response status code.
StatusMessage String The OData batch response status message.
Entity Complex The output items are changed according to your configurations in Batch Builder Request. It shows all properties of entities.

Fault Tab

On the Fault tab, you can find the error code and error message of the OData Batch activity.

The following table lists the error schema elements in the Fault tab of this activity:

Error Schema Element Data Type Description
msg String The error message description that is returned by the plug-in.
msgCode String The error code that is returned by the plug-in.
innerError Complex The inner error details.
message String The error message description that is returned by the OData server.
type String The error type that is returned by the OData server.
stacktrace String The error stacktrace description that is returned by the OData server.