Components

Communication

For more information, see the communication documentation.

The communication response is extended with the wrapper object.
limit is not available in response as the result of the action should always be only one bundle
Communication can be request-less.

Static parameters

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

Mappable parameters

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

Interface

The action module should always output only one bundle.

Samples

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

Scope

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

Available IML variables

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

Variable

Description

now

Current date and time

environment

TBD

temp

Contains custom variables created via the temp directive.

parameters

Contains the module’s input parameters.

connection

Contains the connection’s data collection.

common

Contains the app’s common data collection.

data

Contains the module’s data collection.

scenario

TBD

metadata.expect

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

metadata.interface

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

Additional variables available for the response object:

Variable

Description

output

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

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

Variable

Description

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 for pagination and response objects:

Variable

Description

body

Contains the body that was retrieved from the last request.

headers

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

items

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

Action module example

{
	"url": "/api/users/create",
	"body": {
		"name": "{{parameters.name}}",
		"email": "{{lower(parameters.email)}}"
	},
	"method": "POST",
	"response": {
		"output": {
			"id": "{{body.id}}"
		}
	}
}

[]

[
	{
		"name": "email",
		"type": "email",
		"label": "Email address",
		"required": true
	},
	{
		"name": "name",
		"type": "text",
		"label": "Name",
		"required": true
	}
]

[
	{
		"name": "id",
		"type": "uinteger",
		"label": "User ID"
	}
]

{
	"id": 1
}

PreviousModule actions NextSearch

Last updated 8 months ago