Workflow REST API

The Workflow REST API allows you to create, modify, and execute Workflows and Workflow actions via standard REST API calls.

Common Operations

The most commonly used Workflow operations are to find which Workflow Actions are available to a specific content item or Content Type, and to execute a Workflow action for a specific piece of content. The following endpoints perform the common operations.

In addition to the most common operations, you also may use the Workflow API to create, modify, and delete all parts of Workflows, including Workflow Schemes, Workflow Steps, and Workflow Actions. The following sections list all endpoints in the Workflow REST API.

Workflow Schemes

Workflow Steps

Updating a Workflow Step

The addStep and updateStep methods expect data in the following format within the body of the request:

{
    "stepOrder":{ORDER},
    "stepName":"{STEP_NAME}",
    "enableEscalation":{true|false},
    "escalationAction":"{ACTION_ID}",     // Optional
    "escalationTime":"0",                 // Optional
    "stepResolved":{true|false}
}

Workflow Actions

• Executing Actions
• Finding Actions
• Adding and Updating Actions

Executing Actions

The fire endpoint executes a Workflow Action. The fire endpoint may be called using either the Workflow Action identifier or the Workflow Action name:

Contents of the Request

The fire endpoint expects data in the body of the request with the JSON name "contentlet", which includes a list of the fields of the content and a “name” field which specifies the name of the application accessing the endpoint (for logging purposes).

If you wish to specify the Workflow Action via the action name, you must include an actionname field as well. This field is not required when specifying the Workflow Action identifier in the URL.

{
    "actionname" : "save",
    "contentlet" : {
        "stInode" : "{Action Inode}",
        "languageId" : {LANGUAGE_ID},
        "name": "{Application Name}"
    }
}

For information on how to send different Content Type Fields, please see the Save Content Using the REST API documentation.

Example

The following curl command demonstrates how to submit a full fire endpoint request (for the fileAsset Content Type), including specification of a Binary field using a multipart upload:

curl -v -u admin@dotcms.com:admin -X PUT \ http://localhost:8082/api/v1/workflow/actions/b9d89c803d/fire?identifier=b105eddc-e4b0-4a7f-85ad-b09d29a1c31b -F "json={ 'contentlet': { "contentType":"fileAsset", "languageId":1, "hostFolder":"demo.dotcms.com", "fileName":"liz2.jpg", "title":"liz!" } }; type=application/json" -F "file=@//Users/fabrizzio/Downloads/liz.jpg; type=application/jpg"

Finding Actions

Adding and Updating Actions

Saving or Updating an Action

The saveAction and updateAction methods expect data in the following format within the body of the request:

{
   "stepId": "{STEP_ID}",
      "actionName": "{Name of the new Action}",
      "schemeId": "{SCHEME_ID}",
      "actionCondition": "",
      "actionNextStep": "{STEP_ID or 'currentStep'}",
      "actionNextAssign": "{USER_ID or ROLE_ID}",
      "actionRoleHierarchyForAssign": false,
      "actionAssignable": false,
      "actionCommentable": true,
      "whoCanUse":[],
      "showOn": [
        "UNPUBLISHED",
        "NEW",
        "LOCKED",
        "PUBLISHED"
      ]
}