Workflows

workflow_get_details_summary

workflow_get_details_description

get/pimcore-studio/api/workflows/details

Request

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

Query parameters

elementIdinteger required
Example:83

ID of the element

elementType'asset' | 'document' | 'data-object' required
Example:data-object

Filter elements by matching element type.

Response

workflow_get_details_success_response

layoutIdstring required

Example response

{
  "items": [
    {
      "workflowName": "simple_asset",
      "workflowLabel": "Sample Asset Workflow",
      "workflowStatus": [
        {
          "color": "#3572b0",
          "title": "#ffa500",
          "label": "Edit Images",
          "layoutId": "someStatusLayoutId",
          "visibleInDetail": true
        }
      ],
      "graph": "<svg>...</svg>",
      "workflowLayoutId": "someWorkflowLayoutId",
      "allowedTransitions": [
        {
          "name": "start_workflow",
          "label": "Start Workflow",
          "iconCls": "pimcore_workflow_start",
          "unsavedChangesBehaviour": "warn"
        }
      ],
      "globalActions": [
        {
          "name": "start_workflow",
          "label": "Start Workflow",
          "iconCls": "pimcore_workflow_start"
        }
      ]
    }
  ]
}

Changes

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