Data-API-request-step docs

With this Action function you can define which data (properties, relations and their properties etc., or the total count of a collection) you want to retrieve in your Betty Blocks actions. This offers more flexibility when using other steps with using relations for example in generating email and PDF templates.

Eventually this step generates a Data API call, so it's necessary to have a basic knowledge about Data API queries (see: https://docs.bettyblocks.com/en/articles/5598057-data-api-queries)

How to use

1. Select a model based as "startingpoint".

2. Select a type which defines if you want to retrieve a record (one item), or a collection of records (multiple items).

   

3. Define your filter (in Data API/GraphQL syntax) and variables which you want to use based on the selected model. Variables can be exposed with curly braces in the filter option. Make sure to always use spaces in the filter objects itself, else these will conflict with the curly braces.

   For example:

   

Note when using the IN filter which needs to have an array as input please make sure to have a stringified array (Text) instead of regular array variable. The expression step can be used to convert an array to Text (or use the Text output option).

5. Optional you can use "Skip" and "Take" when the type is set to "Collection". "Skip" defines how many records are skipped when the query is executed. For example when you have a total of 100 records and skip is set to 10 the first record which is retrieved is the 11th. "Take" defines how many records you want to query with a maximum of 200 records.

6. Define your query by starting directly with the (relational) properties of the selected model in step 1. Please make sure to use the Data API name format when querying relations or properties with underscores in the database name (which will result in the database name in camelCase without underscores).

   Tip: Use the Betty Blocks Playground to verify the correct syntax of your query. The URL of the Playground of your app is as follows: https://[APPLICATION_IDENTIFIER].betty.app/api/runtime/[APPLICATION_UUID].

   For example:

   id
   name
   value
   propertyName
   hasManyRelation {
       id
       name
   }
   belongsToRelation {
       id
       name
   }
   

7. Define the output type. By default this option is set to query the results body you have defined in step 4, however you are able to get the total count of a certain collection as well. This can be useful when you need to loop through a collection larger than 200 records and/or want to process data in batches.

   Note This option is only relevant when querying a collection of records.

8. Choose a variable name for the result and define the type of the output variable which can be used in subsequent steps.