website logo
👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Overview
Reference
Actions
Data
UI
Widgets
Docs powered by
Archbee
Reference
Actions

ja-execute-entity

370min


Sub Schemas

The schema defines the following additional types:

JAExecuteEntityConfig (JAExecuteEntityInBackgroundConfig | JAExecuteEntityOnButtonConfig)

The object must be any of the following types:

JAExecuteEntityConfig (JAExecuteEntityInBackgroundConfig)

JAExecuteEntityConfig (JAExecuteEntityOnButtonConfig)

JAExecuteEntityInBackgroundConfig (action.execute-entity)

Properties of the JAExecuteEntityInBackgroundConfig object:

Property

Type

Required

Description

type

action.execute-entity

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false

When the property is set to 'false', the action will not execute. Default is 'true'.

options

DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options

true

Options related to Jig Actions on bottom panel

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options, required)

Options related to Jig Actions on bottom panel

The object must be any of the following types:

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

create

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

update

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

id

string | string

true

The id of the record

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

save

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

id

string | string

false

The id of the record

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

delete

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

tokenType

string | string

true

Token type

id

string | string

true

The id of the record

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

download

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

id

string | string

true

The id of the record

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

string

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

method (string, required)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

fileName

string | string

false

The name of the file

file

string | string

false

The file path

tokenType

string | string

true

Token type

id

string | string

false

The id of the record

fileName (string | string)

The name of the file

The object must be any of the following types:

fileName (string)

file (string | string)

The file path

The object must be any of the following types:

file (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_DYNAMIC)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_DYNAMIC

true



entity

data-provider-definition | string

true



method

create

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

id

string | string

false

The id of the record

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_DYNAMIC)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_DYNAMIC

true



entity

data-provider-definition | string

true



method

update

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

id

string | string

true

The id of the record

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_DYNAMIC)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_DYNAMIC

true



entity

data-provider-definition | string

true



method

save

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

id

string | string

false

The id of the record

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_DYNAMIC)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_DYNAMIC

true



entity

data-provider-definition | string

true



method

delete

true



data

IdParameter | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (IdParameter | string, required)

The object must be any of the following types:

data (IdParameter)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_DYNAMIC)

Properties of the options object:

Property

Type

Required

Description

provider

DATA_PROVIDER_DYNAMIC

true



entity

data-provider-definition | string

true



method

string

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

method (string, required)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

id

string | string

false

The id of the record

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (Generic Options)

Properties of the options object:

Property

Type

Required

Description

provider

data-provider-definition | string

true



method

data-provider-definition | string

true



entity

data-provider-definition | string

false



function

string | string

false



functionParameters

Expression | Primitive

false



data

Expression | Primitive | string

false



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



provider (data-provider-definition | string, required)

The object must be any of the following types:

provider (data-provider-definition)

provider (string)

method (data-provider-definition | string, required)

The object must be any of the following types:

method (data-provider-definition)

method (string)

entity (data-provider-definition | string)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

function (string | string)

The object must be any of the following types:

function (string)

function (string)

functionParameters (Expression | Primitive)

data (Expression | Primitive | string)

The object must be any of the following types:

data (Expression | Primitive)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

IdParameter (Parameters)

Named parameters with values or expressions

Properties of the IdParameter object:

Property

Type

Required

Description

id

string | string

true

The id of the record

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

JAExecuteEntityOnButtonConfig (action.execute-entity)

Properties of the JAExecuteEntityOnButtonConfig object:

Property

Type

Required

Description

type

action.execute-entity

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false

When the property is set to 'false', the action will not execute. Default is 'true'.

options

DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options

true

Options related to Jig Actions on bottom panel

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options, required)

Options related to Jig Actions on bottom panel

The object must be any of the following types:

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

create

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

update

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

id

string | string

true

The id of the record

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

save

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

file

string | string

true

The file path

fileName

string | string

true

The name of the file

tokenType

string | string

true

Token type

id

string | string

false

The id of the record

file (string | string, required)

The file path

The object must be any of the following types:

file (string)

fileName (string | string, required)

The name of the file

The object must be any of the following types:

fileName (string)

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

provider

DATA_PROVIDER_ONEDRIVE

true



entity

data-provider-definition | string

true



method

delete

true



data

Parameters | string

true



goBack

enum<string>

false



onSuccess

keg-action-in-background | ja-submit-form

false



title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

entity (data-provider-definition | string, required)

The object must be any of the following types:

entity (data-provider-definition)

entity (string)

data (Parameters | string, required)

The object must be any of the following types:

data (Parameters)

Named parameters with values or expressions

Properties of the data object:

Property

Type

Required

Description

tokenType

string | string

true

Token type

id

string | string

true

The id of the record

tokenType (string | string, required)

Token type

The object must be any of the following types:

tokenType (string)

id (string | string, required)

The id of the record

The object must be any of the following types:

id (string)

data (string)

goBack (enum<string>)

onSuccess (keg-action-in-background | ja-submit-form)

The object must be any of the following types:

onSuccess (keg-action-in-background)

onSuccess (ja-submit-form)

options (DATA_PROVIDER_ONEDRIVE)

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

provider

DATA_PROVIDER_ONEDRIVE

true