Workflows

workflow_action_submit_summary

workflow_action_submit_description

post/pimcore-studio/api/workflows/action

Request

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

Request body

actionTypestring required

type of the action

elementIdinteger required

Id of the element

elementTypestring required

Type of the element

workflowIdstring required

Id of the workflow

transitionIdstring required

Id of the transition

workflowOptionsobject nullable required

workflowOptions

Example request

{
  "actionType": "transition",
  "elementId": 50,
  "elementType": "data-object",
  "workflowId": "my_first_workflow",
  "transitionId": "start_workflow"
}

Response

workflow_action_submit_success_response

workflowNamestring
actionNamestring
actionTypestring

Example response

{
  "workflowName": "MyAwesomeWorkflow",
  "actionName": "MyAwesomeAction",
  "actionType": "transition"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.