Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

UI Text Box

size	medium
type	info

Use this function to execute a JWT remote action.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action")

This example executes the action called "Great action" and returns the whole JSON response.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON.:

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify a jmes path.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, jmes) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "body")

This example executes the action called "Great action" and returns only the body part of the JSON response.

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "body.data")

This example executes the action called "Great action" and returns only the data part of the JSON response's body object.

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "status")

This example executes the action called "Great action" and returns only the status code of the JSON response.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

jmes

Status


subtle	true
title	text

A valid JMES path to retrieve only specific data from the returned json object

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON (depending on the provided jmes path):

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify additional parameters.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, parameterList) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", ["query": "Demo", "path": "projects"])

This example executes the action called "Great action" and returns the whole json response. In addition, the parameters "query" and "path" will be added to the request.

Code Block

language	bash
linenumbers	true

executeRemoteAction("POST action", ["body": "{\"userId\": 12, \"name\": \"John Doe\"}"])

This example executes the action called "POST action" and returns the whole json response. In addition, the action's request body will be populated with the provided JSON.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

parameterList

Status


subtle	true
title	Parameter list

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON:

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify additional parameters and another connection.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, parameterList, connectionName) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", ["query": "Demo", "path": "projects"], "Some other connection")

This example executes the action called "Great action" and returns the whole json response. In addition, the parameters "query" and "path" will be added to the request and the connection called "Some other connection" is being used.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

parameterList

Status


subtle	true
title	Parameter list

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body

connectionName

Status


subtle	true
title	text

Name of the connection to use for the action (case sensitive)

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON:

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify a jmes path and additional parameters.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, jmes, parameterList) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "body.data", ["query": "Demo", "path": "projects"])

This example executes the action called "Great action" and returns only the data part of the response's body. In addition, the parameters "query" and "path" will be added to the request and the connection called "Some other connection" is being used.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

jmes

Status


subtle	true
title	text

A valid JMES path to retrieve only specific data from the returned json object

parameterList

Status


subtle	true
title	Parameter list

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON (depending on the provided jmes path):

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify a jmes path and another connection.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, jmes, connectionName) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "body.data", "Different connection")

This example executes the action called "Great action" and returns the whole JSON response. In addition, the connection called "Different connection" is being used.

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

jmes

Status


subtle	true
title	text

A valid JMES path to retrieve only specific data from the returned json object

connectionName

Status


subtle	true
title	text

Name of the connection to use for the action (case sensitive)

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON (depending on the provided jmes path):

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

UI Text Box

size	medium
type	info

Variant where you can specify a jmes path, a connection and additional parameters.

Code Block

language	bash
title	Syntax
linenumbers	true

executeRemoteAction(actionName, jmes, connectionName, parameterList) #Output: Text

UI Expand

title	Examples

Parser expression

Description

Code Block

language	bash
linenumbers	true

executeRemoteAction("Great action", "body.data", "cool connection", ["query": "Demo", "path": "projects"])

UI Expand

title	Additional information

Parameters used in this function

Parameter Input (data type) Description

actionName

Status


subtle	true
title	text

Name of the action to execute (case sensitive)

jmes

Status


subtle	true
title	text

A valid JMES path to retrieve only specific data from the returned json object

connectionName

Status


subtle	true
title	text

Name of the connection to use for the action (case sensitive)

parameterList

Status


subtle	true
title	Parameter list

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body

UI Expand

title	Output

The function returns a

Status


subtle	true
title	text

representing the following JSON (depending on the provided jmes path):

Code Block

linenumbers	true

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}

Page properties

hidden	true

Status

Tech review

Status

colour	Yellow
title	Ready for review

Style guide

Status

colour	Yellow
title	Ready for review

Status

title	todo

Status

colour	Yellow
title	Ready for review

Status

colour	Green
title	done

Status

colour	Red
title	flagged

Page properties

hidden	true

Short description

Execute a JWT remote action.

Output

Status


subtle	true
title	text

Label

Content

Space Tools

Versions Compared

Old Version 6

New Version 7

Key

Parameters used in this function

Parameters used in this function

Parameters used in this function

Parameters used in this function

Parameters used in this function

Parameters used in this function

Parameters used in this function