DryRunDraft

POST

/api/v1/t/{tenant}/workflows/definitions/{definitionId}/draft/dry-run

const url = 'https://example.com/api/v1/t/example/workflows/definitions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/draft/dry-run';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"documentIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"proposal":{"definition":{"schemaVersion":1,"startStep":"example","steps":[{"kind":"humanTask","taskKind":"Approve","assignees":[{"when":{"kind":"compare","field":"example","value":"LastTaskOutcome","operator":"EqualTo","constants":["example"],"output":{"step":"example","key":"example"}},"assignee":{"kind":"Member","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","roleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","table":"example"}}],"fallback":{"kind":"Member","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","roleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","table":"example"},"options":{"remindAfterWorkingDays":1,"escalateAfterWorkingDays":1,"escalationTarget":{"kind":"Member","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","roleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","table":"example"},"excludeRequester":true,"excludeActorsOfSteps":["example"],"pickFile":false,"deadline":{"value":{"step":"example","key":"example"},"dateField":"example","remindBeforeWorkingDays":1,"escalateBeforeWorkingDays":1}},"next":"example","onRejected":"example","requiredFields":{"fields":["example"],"requireComment":true},"parallelApproval":{"mode":"All","approvers":[{"kind":"Member","userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","roleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","table":"example"}],"quorum":1},"name":"example","label":"example"}],"fields":[{"key":"example","kind":"Text","labelDe":"example","labelEn":"example","documentTypeIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"options":[{"key":"example","labelDe":"example","labelEn":"example"}]}],"deadlineTrigger":{"stage":"Reminder","kind":"End","ruleKey":"example"}}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/t/example/workflows/definitions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/draft/dry-run \
  --header 'Content-Type: application/json' \
  --data '{ "documentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "proposal": { "definition": { "schemaVersion": 1, "startStep": "example", "steps": [ { "kind": "humanTask", "taskKind": "Approve", "assignees": [ { "when": { "kind": "compare", "field": "example", "value": "LastTaskOutcome", "operator": "EqualTo", "constants": [ "example" ], "output": { "step": "example", "key": "example" } }, "assignee": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" } } ], "fallback": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" }, "options": { "remindAfterWorkingDays": 1, "escalateAfterWorkingDays": 1, "escalationTarget": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" }, "excludeRequester": true, "excludeActorsOfSteps": [ "example" ], "pickFile": false, "deadline": { "value": { "step": "example", "key": "example" }, "dateField": "example", "remindBeforeWorkingDays": 1, "escalateBeforeWorkingDays": 1 } }, "next": "example", "onRejected": "example", "requiredFields": { "fields": [ "example" ], "requireComment": true }, "parallelApproval": { "mode": "All", "approvers": [ { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "table": "example" } ], "quorum": 1 }, "name": "example", "label": "example" } ], "fields": [ { "key": "example", "kind": "Text", "labelDe": "example", "labelEn": "example", "documentTypeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "options": [ { "key": "example", "labelDe": "example", "labelEn": "example" } ] } ], "deadlineTrigger": { "stage": "Reminder", "kind": "End", "ruleKey": "example" } } } }'

Parameters

Path Parameters

tenant

required

string

Tenant slug

definitionId

required

string format: uuid

Request Body^required

application/json

object

documentIds

required

Array<string>

proposal

One of:

null
object

null

Responses

200

application/json

object

documents

required

Array<object>

object

documentId

required

string format: uuid

steps

required

Array<object>

object

stepName

required

string

label

required

null | string

assignee

required

One of:

null
object

null

end

required

One of:

null
object

null

stopped

required

One of:

null
object

null

leftOut

required

integer format: int32

Example

{
  "documents": [
    {
      "steps": [
        {
          "assignee": {
            "route": "Assignee",
            "reason": "StepBudgetExceeded"
          }
        }
      ],
      "end": {
        "outcome": "Running"
      },
      "stopped": {
        "reason": "Timer"
      }
    }
  ]
}

400

Bad Request

application/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

application/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

413

Payload Too Large

application/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Unsupported Media Type

application/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

application/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

DryRunDraft

Parameters

Path Parameters

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

403

Examplegenerated

404

413

Examplegenerated

415

Examplegenerated

429

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated