Actions

An OData action is an operation that can do whatever the designer of the OData endpoint has decided. Typically it changes data, unlike an OData function which does not change any data.

Actions can be found in it's own section in the operation tree

These actions are 'unbound' - meaning that they are not tied to a particular entity.

There are also 'bound' actions, which are bound to an entity or an entity set.

They are found under the corresponding entity in the operation tree. Example:

In the example above most actions are bound to a particular entity in JtTaskSet. Those actions, with name ending with (from entity), will take the entity key of the entity as input along with whatever other parameters the action requires

Actions bound to the entity set will not take an entity key, but is related to the entity set. They will end with '(from set)' in their name. They are however not very common (the ones ending with (from set) in example above are functions).

Output

While the output of an action depends on the action itself, the output is always a record containing the members listed below along with whatever the action itself outputs (if anything).

  • StatusCode - the HTTP status code returned from the OData endpoint, typically 200 if the operation was successful. A value of 0 or -1 indicates a problem in the connector (i.e, no request sent to the OData endpoint)

  • ErrorMessage - has no value if the operation succeeded, otherwise a description of what when wrong

  • HasFailed - simple value containing true if operation failed

  • Headers - is omitted by default, but if included, contains all HTTP headers returned by the OData endpoint

Last updated