Search

The Search Module is a module that makes a request (or several) and returns multiple results. It doesn’t have state nor any internal complex logic.

Use this module when you need to allow the user to search for items or simply return multiple items.

Components

Communication

pageCommunication

Pagination

If API supports pagination, you can implement it by using pagination directive.

pagePagination

Static Parameters

pageStatic parameters

You can use static parameters inside the Search module without any restrictions.

Mappable Parameters

pageMappable parameters

You can use mappable parameters inside the Search module without any restrictions.

Interface

pageInterface

Unlike the Action module, the Search module can return multiple bundles at once.

Samples

pageSamples

To help the users with setting up your module, you can provide samples to it.

​Scope​

pageScope

When using an OAuth type of connection, use the Scope to define scopes required by this module.

Available IML Variables

The IML variables are variables that you are able to use in IML expressions.

These IML variables are available for you to use everywhere in this module:

  • now - Current date and time.

  • environment - TBD

  • temp - Contains custom variables created via temp directive

  • parameters - Contains module’s input parameters.

  • connection - Contains connection’s data collection.

  • common - Contains app’s common data collection.

  • data - Contains module’s data collection.

  • scenario - TBD

  • metadata.expect - Contains module’s raw parameters array the way you have specified it in the configuration.

  • metadata.interface - Contains module’s raw interface array the way you have specified it in the configuration.

Additional variables available to Response Object:

  • output - When using the wrapper directive, the output variable represents the result of the outputdirective

  • limit - When you use a limit, the process of retrieving items will stop once either the requested number of items has been obtained or if a page doesn't contain any items. Additionally, the module will return only the exact number of items that was specified.

  • iterate - Iterates the array in the response into items.

Additional variables available after using the iterate directive, i.e. in wrapper or pagination directives:

  • iterate.container.first - Represents the first item of the array you iterated

  • iterate.container.last - Represents the last item of the array you iterated

Additional variables available after using the iterate directive, i.e. in wrapper or pagination directives:

  • body - Contains the body that was retrieved from the last request.

  • headers - Contains the response headers that were retrieved from the last request.

  • item - When iterating this variable represents the current item that is being iterated.

Example

PreviousComponentsNextTrigger (polling)

Last updated