action

Add Action

Changed on

Add a new Action

post/action

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/action
  • Auth
    none declared

Request body application/x-www-form-urlencoded

layoutIdinteger required

LayoutId associted with this Action

actionTypestring required

Action type, next, previous, navLayout, navWidget

targetstring required

Target for this action, screen or region

targetIdstring

The id of the target for this action - regionId if the target is set to region

sourcestring

Source for this action layout, region or widget

sourceIdinteger

The id of the source object, layoutId, regionId or widgetId

triggerTypestring

Action trigger type, touch or webhook

triggerCodestring

Action trigger code

widgetIdinteger

For navWidget actionType, the WidgetId to navigate to

layoutCodestring

For navLayout, the Layout Code identifier to navigate to

Response

successful operation

actionIdinteger

The Action Id

ownerIdinteger

The Owner Id

triggerTypestring

The Action trigger type

triggerCodestring

The Action trigger code

actionTypestring

The Action type

sourcestring

The Action source (layout, region or widget)

sourceIdinteger

The Action source Id (layoutId, regionId or widgetId)

targetstring

The Action target (region)

targetIdinteger

The Action target Id (regionId)

widgetIdinteger

Widget ID that will be loaded as a result of navigate to Widget Action type

layoutCodestring

Layout Code identifier

layoutIdinteger

Layout Id associated with this Action

Changes