Get Entity Sets from OData

To get entity sets from an OData service, do the procedure in this topic.

Screen



Screen



Screen



Prerequisites

Good to Know

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Web Services Web Services icon tab.
      2. On the Web Services Web Services icon tab, drag the OData Query Entity OData Query Entity icon activity onto your process
    • Change an activity:
      1. In your process, double-click your activity.
  3. Click OData Query Entity Configuration OData Query Entity Configuration icon.

Procedure

  1. On the OData Query Entity screen, in the OData Service field, select your OData access token.

    To create a new access token, click Add Token Add Token icon. For more information, refer to Access Token for OData.

  2. In the Entity field, select the entity from which you want to retrieve an entity set.
  3. To filter the records with a condition, do this procedure.
    1. On the Query String Options tab, Click Filter Filter icon.
    2. On the OData Entity Sets Configuration > Create Conditions screen, in the Column field, select the entity field to use in your query.
    3. In the Comparer field, select the operator to compare the values in your logical and arithmetic expression.
      Field Name Definition

      Comparer

      Function:
      Specifies the operator to use in your query.
      Accepted Values:
      • =
      • !=
      • >=
      • >
      • <
      • <=
      Default Value:
      =
    4. In the Value field, enter the value to compare or drag a process data variable from the Process Data screen.
    5. (Optional) Click Add Row Add Row icon to add a condition that can be connected to the previous expression with a logical AND or OR operator.
    6. (Optional) To add a statement that adds a subordinate condition to a query, click Subcondition Subcondition icon.
    7. To save your condition, click Back Back icon.
  4. (Optional) complete these fields as necessary:
    Field Name Definition

    Configuration

    Function:
    Specifies the type of configuration.
    Accepted Values:
    • Quick Config - Uses the activity configuration UI to create the query to retrieve your entity sets.
    • Manual Setup - Lets you specify an OData query string.
    Default Value:
    Quick Config
    Accepts Process Data Variables:
    No

    Order By

    Function:
    Specifies the name of the entity property to make a sequence for the query results.
    To Open this Field:
    1. Click Quick Config.
    Accepted Values:
    An entity property from the list.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes

    Sort Order

    Function:
    Specifies the sort order for the result set.
    To Open this Field:
    1. Click Quick Config.
    Accepted Values:
    • Ascending
    • Descending
    Default Value:
    None

    Top

    Function:
    Specifies how many records to retrieve from the top of the entity result list.
    To Open this Field:
    1. Click Quick Config.
    Accepted Values:
    A positive integer.
    Default Value:
    None

    Skip

    Function:
    Specifies how many records to ignore from the top of the entity results.
    To Open this Field:
    1. Click Quick Config.
    Accepted Values:
    A positive integer.
    Default Value:
    None

    Query String Parameter

    Function:
    Specifies the query string to retrieve entity sets from OData.
    To Open this Field:
    1. Click Manual Setup.
    Accepted Values:
    A text string that can have special charaters with no spaces.
    Default Value:
    None
    Accepts Process Data Variables:
    Yes
  5. Click the Response tab.
  6. To connect response data from OData to your process, do one of these.
    • To connect the response to your process schema, complete this field as necessary:
      Field Name Definition

      Map Response to AgilePoint Schema

      Function:
      Maps information about entity sets from the OData data model to your schema.
      Accepted Values:
      Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

      Use this screen to connect the response to the data model for your process.

      Default Value:
      None
    • To connect the response to a process data variable, complete this field as necessary:
      Field Name Definition

      Store the Response in this Variable

      Function:
      Specifies the process data variable that stores information about an entity set from the OData service.
      Accepted Values:
      A process data variable that accepts an alphanumeric string in JSON format.
      Default Value:
      None
      Accepts Process Data Variables:
      Yes