OData Modify Activity

You can use the OData Modify activity to create, update, and delete data from an OData server.

General

In the General tab, you can establish a connection to an OData server, specify the operation you want to do, and generate the URI to modify.

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

Field Module Property? Description
Name No The name to be displayed as the label for 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. For more details, see Creating an OData Connection.

Operation No The operation that you want to perform. Select an operation from the list.
  • Create: select it to create an entity or add reference.
  • Update: select it to update an entity, property, or reference.
  • Delete: select it to delete an entity or reference.
Note: Create is selected by default.
Update Type No The update type of update operation. It is only available when Update in the Operation list is selected.
  • Patch: select it to only modify the field values specified in the input items. It is selected by default.
  • Replace: select it to replace all values of structural properties with the values specified in the input items.
OData URI No It is used to generate the URI to modify.

Two buttons are provided in the area.

  • URI Builder: click this button to open the OData URI Builder tools. For more details, see Modify URI Builder.
  • Clear: click this button to clear the OData URI field value.

Description

In the Description tab, you can enter a short description for the OData Modify activity.

Input

In the Input tab, you can specify the required input of the OData Modify activity.

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

Input Item Data Type Description
Headers Complex The header of the OData request. It includes the following items:
  • Accept: it is used by user agents to specify response media types that are acceptable.
  • Content-Type: it is the media type of the entity body sent to the OData server.
  • Content-Encoding: it is used as a modifier to the media-type.
  • Content-Language: it indicates the natural language of the intended audience for the enclosed message body.
  • Content-Length: it indicates the size of the entity body sent to the server.
  • OData-Version: it specifies the version of the protocol used to generate the request.
Note: The header structure is defined by the HTTP protocol. See the HTTP protocol specification for more information about the fields and content of the header of an HTTP request.
DynamicHeaders Complex The dynamic header is an additional header parameter which is added into runtime headers of the outgoing OData request messages. The DynamicHeaders element includes the following items:
  • Name: the name of the header
  • Value: the value of the header
ODataRequest Complex This element indicates the OData related items which are dynamically generated by using the variables in the OData URI area of the General Tab. The input items are changed according to the configurations in Modify URI Builder.
  • Create
    • Create Entity: it shows all properties of entities, and navigation properties.
    • Create Reference: it shows the key parameter items and the RefLink item.
  • Update
    • Update Entity: it shows the entity key parameter items and all properties.
    • Update property: it shows the entity key parameter items and property items.
    • Change Reference: it shows all the key parameter items and the RefLink item.
  • Delete
    • Delete Entity: it shows the key parameter items.
    • Delete Reference: it shows the key parameter items and the RefLink item.

Output

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

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

Output Item Data Type Description
StatusCode String The OData response status code.
StatusMessage String The OData response status message.
Entity/Reference Complex The output items are changed according to your configurations in Modify URI Builder.
  • Create:
    • Create Entity: it shows all properties of entities, and navigation properties.
  • Update:
    • Update Entity: it shows all properties of entities, and navigation properties.
    • Update property: it shows updated property.
  • Delete:
    • This item is invisible in the delete operation mode.

Fault

In the Fault tab, you can find the error code and error message of the OData Modify activity.

The following table lists 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 stacktrance description that is returned by the OData server.