OData Query Activity
You can use the OData Query activity to query data from an OData server.
General
In the General tab, you can establish a connection to an OData server, and generate the URI to query.
The following table lists the configurations in the General tab of the OData Query 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. |
OData URI | No | The OData URI that is used to query. You can edit the OData URI in this field. To validate the URI, you can right-click the URI and then click
Validate URI in the pop-up list.
Two buttons are provided in this area:
|
Input
In the Input tab, you can specify the required input of the activity.
The following table lists the input elements in the Input tab of the OData Query activity:
Input Item | Data Type | Description |
---|---|---|
Headers | Complex | The header of the OData request. It includes the following items:
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: |
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. It includes the following items: |
ODataURI | String | This item can override the values in the OData URI area of the General tab. |
Parameters | Complex | The items under this element are the parameters in the OData URI field of the General tab. |
Output
In the Output tab, you can find the output schema, which is the same as the schema in Output Preview of query builder. For more details, see Output Preview .
Fault
In the Fault tab, you can find the error code and error message of the OData Query 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. |