action

Search Actions

Changed on

Search all Actions this user has access to

get/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

Query parameters

actionIdinteger

Filter by Action Id

ownerIdinteger

Filter by Owner Id

triggerTypestring

Filter by Action trigger type

triggerCodestring

Filter by Action trigger code

actionTypestring

Filter by Action type

sourcestring

Filter by Action source

sourceIdinteger

Filter by Action source Id

targetstring

Filter by Action target

targetIdinteger

Filter by Action target Id

layoutIdinteger

Return all actions pertaining to a particular Layout

sourceOrTargetIdinteger

Return all actions related to a source or target with the provided ID

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

  • 41c04de98ec5Revision changes
    • info

      added the media type application/json for the response with the status

  • a3c40cebbafaRevision changes
    • info

      added the new optional query request parameter layoutId

    • info

      added the new optional query request parameter sourceOrTargetId