Skip to main content
Version: v41

workflow_step

Approval step in the workflow. These are read-only for requests.

namestringrequired

Workflow-step name

matchstringrequired

All approvers must approve or any approver can approve. When enabled, AUTO steps means that these will be automatically approved.

Possible values: [ALL, ANY, AUTO]

approvers object[]required

Who are the approvers in this step

  • Array [
  • role objectrequired

    Approving role's ID and display name

    idstring<uuid>
    namestring
    deletedboolean

    It indicates whether a role is present in the system or not. Create/Update workflow/request operations doesn't need to pass any value to this attribute. This field is not read during the Write operations.

  • ]
  • workflow_step
    {
    "name": "string",
    "match": "ALL",
    "approvers": [
    {
    "role": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "deleted": true
    }
    }
    ]
    }