Get Entity Sets from OData

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

Figure: OData Query Entity Configuration > Query String Options tab

Query String Options tab
Figure: OData Query Entity Configuration > Create Conditions screen

Create Conditions screen
Figure: OData Query Entity Configuration > Response tab

Response tab

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. Do one of these:
    • Add an activity:
      1. In Process Builder, in the Activity Library, open the Web Services tab.

        Open Web Services tab
      2. On the Web Services tab, drag the OData Query Entity activity onto your process.

        Drag OData Query Entity activity
    • 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 Create Add Token icon. For more information, refer to Access Token for OData Service.

  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 NameDefinition

      Comparer
      Description:
      Specifies the operator to use in your query.
      Allowed 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 Indent Right Indent Right icon.
    7. To save your condition, click Back Back icon.
  4. (Optional) complete these fields as necessary:
    Field NameDefinition

    Configuration
    Description:
    Specifies the type of configuration.
    Allowed 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 Variables:
    No

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

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

    Top
    Description:
    Specifies how many records to retrieve from the top of the entity result list.
    To Open this Field:
    1. Click Quick Config.
    Allowed Values:
    An integer.

    Range:

    • Greater than 0
    Default Value:
    None

    Skip
    Description:
    Specifies how many records to ignore from the top of the entity results.
    To Open this Field:
    1. Click Quick Config.
    Allowed Values:
    An integer.

    Range:

    • Greater than 0
    Default Value:
    None

    Query String Parameter
    Description:
    Specifies the query string to retrieve entity sets from OData.
    To Open this Field:
    1. Click Manual Setup.
    Allowed Values:
    One line of text (a string).

    Accepted:

    • Letters
    • Numbers
    • Special characters

    Not Accepted:

    • Spaces
    Default Value:
    None
    Accepts Variables:
    Yes
    Limitations:

    Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

  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 NameDefinition

      Map Response to AgilePoint Schema
      Description:
      Maps information about entity sets from the OData data model to your process schema.
      Allowed 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
      Example:
      Refer to:
    • To connect the response to a process data variable, complete this field as necessary:
      Field NameDefinition

      Store the Response in this Variable
      Description:
      Specifies the process data variable that stores information about an entity set from the OData service.
      Allowed Values:
      A process data variable that accepts an alphanumeric string in JSON format.
      Default Value:
      None
      Accepts Variables:
      Yes
      Limitations:

      Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?