Generate a description for a BPMN workflow definition using an LLM

Learn about how generate a human-readable description of a BPMN workflow definition from BPMN XML.

Overview

Use Workflow to generate a human-readable description of a BPMN workflow definition from BPMN XML.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request for generating a human-readable description of a BPMN workflow definition.

POST {host}/workflow-adapter/workflow/{tenant}/ai/steps

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenant`	String	Yes	Unique identifier of the tenant.

Replace {host} with the base URL of your environment.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/xml	Yes

Request body

This operation requires a BPMN workflow definition in XML format in the request body.

Example request

Use the following example to see how a complete request is structured with headers and an XML body.

POST {host}/workflow-adapter/workflow/{tenant}/ai/steps
Authorization: Bearer <access_token>
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<definitions>
    <!-- BPMN workflow definition goes here -->
</definitions>

Response body

The following table describes the fields returned in the response body.


Parameter	Type	Description
`stepNumber`	Integer	Sequence number of the step in the workflow description.
`id`	String	Unique identifier of the BPMN element.
`type`	String	Type of the BPMN element, such as `Start Event` or `User Task`.
`name`	String	Name of the BPMN element.
`description`	String	Human-readable description of the workflow step.

Example response

The following example shows a response with a human-readable description of the BPMN workflow definition.

[
    {
        "stepNumber": 1,
        "id": "startevent1",
        "type": "Start Event",
        "name": "Start",
        "description": "Process initiated."
    },
    {
        "stepNumber": 2,
        "id": "usertask1",
        "type": "User Task",
        "name": "DCR Review",
        "description": "A reviewer from the \"ROLE_REVIEWER\" group is assigned to review a data change request. The task has a due date of two days. The reviewer must make a decision using a form with options: \"Approve\" (default) or \"Reject\" (required). The form also displays read-only information about \"AccessTypes\" (set to \"ACCEPT_CHANGE_REQUEST\"), a \"Validator\" class (\"com.reltio.workflow.core.task.validator.DataChangeRequestValidator\"), and flags indicating that notifications are disabled for both assignment and completion. Task listeners are triggered on creation and assignment for specific logging and entity type handling."
    }
]

Unify and manage your data