Skip to content
AcrivaDocs

GetDraft

GET
/api/v1/t/{tenant}/workflows/definitions/{definitionId}/draft
curl --request GET \
  --url https://example.com/api/v1/t/example/workflows/definitions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/draft

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

definitionId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
definitionId
required
string format: uuid
definition
required
object
schemaVersion
required
integer format: int32
startStep
required
string
steps
required
Array<object>
Any of: discriminator: kind
object
kind
required
string
Allowed values: humanTask
taskKind
required
Allowed values: Approve Review Acknowledge Fix Capture SignatureFieldReview
assignees
required
Array<object>
object
when
required
One of:
null
assignee
required
object
kind
required
Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner
userId
null | string format: uuid
roleId
null | string format: uuid
table
null | string
fallback
required
object
kind
required
Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner
userId
null | string format: uuid
roleId
null | string format: uuid
table
null | string
options
required
object
remindAfterWorkingDays
required
null | integer format: int32
escalateAfterWorkingDays
required
null | integer format: int32
escalationTarget
required
One of:
null
excludeRequester
required
boolean
excludeActorsOfSteps
required
Array<string>
pickFile
boolean
deadline
One of:
null
next
required
string
onRejected
null | string
requiredFields
One of:
null
parallelApproval
One of:
null
name
required
string
label
null | string
fields
Array<object> | null
object
key
required
string
kind
required
Allowed values: Text Number Date Money Enumeration
labelDe
required
string
labelEn
required
string
documentTypeIds
required
Array<string>
options
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
deadlineTrigger
One of:
null
form
required
object
positions
required
object
key
additional properties
object
x
required
number format: double
y
required
number format: double
invoiceSettings
required
One of:
null
dataTables
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
columns
required
Array<object>
object
key
required
string
labelDe
required
string
labelEn
required
string
kind
required
Allowed values: Text Number Money Date Boolean
isKey
required
boolean
rows
required
Array<object>
object
name
required
string
triggerDocumentTypeId
required
null | string format: uuid
basedOnVersion
required
integer format: int32
version
required
null | integer format: uint32
savedBy
required
null | string format: uuid
savedAt
required
null | string format: date-time
savedByApiKey
null | string
previousDraft
One of:
null
aiProposed
boolean
Example
{
  "definition": {
    "steps": [
      {
        "kind": "humanTask",
        "taskKind": "Approve",
        "assignees": [
          {
            "when": {
              "kind": "compare",
              "value": "LastTaskOutcome",
              "operator": "EqualTo"
            },
            "assignee": {
              "kind": "Member"
            }
          }
        ],
        "fallback": {
          "kind": "Member"
        },
        "options": {
          "escalationTarget": {
            "kind": "Member"
          },
          "pickFile": false
        },
        "parallelApproval": {
          "mode": "All",
          "approvers": [
            {
              "kind": "Member"
            }
          ]
        }
      }
    ],
    "fields": [
      {
        "kind": "Text"
      }
    ],
    "deadlineTrigger": {
      "stage": "Reminder",
      "kind": "End"
    }
  },
  "form": {
    "dataTables": [
      {
        "columns": [
          {
            "kind": "Text"
          }
        ]
      }
    ]
  },
  "aiProposed": false
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}