Unifize Knowledge Base
  • Quickstart
    • Welcome to Unifize!
  • Getting started
    • Setting up your Unifize account
      • Signing up with invite link
      • Logging in with email
    • Quickstart demo
    • Key features & navigation
      • Records
      • Conversations
      • Checklists
    • First steps for new users
      • Creating a new record
      • Creating records from inbound email
      • Filling checklist metadata
      • Linking related records
      • Sharing conversations as email
      • Sending and receiving emails in Unifize
      • Inviting people
      • Changing your preferred language
      • Filtering records in My Inbox
      • Generating PDF reports
      • Creating custom reports
      • Creating custom dashboards
    • Using Unifize AI
  • Troubleshooting & support guide
  • User Guide
    • Definitions
      • Process
      • Record
      • Conversation
      • Report
      • Chart
      • Checklist
      • Org
    • Navigating the platform
      • Profile
      • My Inbox
      • Manage
      • Homescreen
      • Contacts
      • Direct Messages
      • Dashboard
    • Data & process management
      • File Management
      • Checklists & Forms
      • Rich text in checklist
      • Working with records
        • Due dates & priorities of a record
    • User & role management
      • Understanding roles & access
      • Managing permissions
      • Deactivating users
      • Team & organization
    • Mobile & web accessibility
      • Unifize Lite
      • Mobile app
      • Web app vs Unifize Lite
    • Security, compliance & infrastructure
    • Personalizations
      • Set your profile picture
      • Reset your Passwords
      • Customizing Homescreen
      • Set your email notification preferences
    • Profile
      • Org Settings
        • Home Screen
        • Org Details
        • Role Management
        • Home Screen
        • Org details
        • Role management
        • SSO
    • My Inbox
      • Process Builder
        • Checklist
          • Linked Field
            • Linked table
          • Picklist
      • Checklist
        • Attach File
          • SharePoint
            • Configuring SharePoint on Unifize
          • Unifize file store
          • Computer
      • Conversation window
  • Product Help
    • Unifize Document Management System (DMS)
      • Document Control
      • Change Control
      • Training Management
      • Onboarding guide for DMS
      • Troubleshooting & support guide for DMS
  • Admin Guide
    • Multi-language translation support
      • Enabling and configuring language support
      • Managing user language preferences at scale
      • Using the translation editor to customize UI
    • Customization & configuration
      • Configuring processes
      • Configuring revision fields
      • Configuring approval workflows
      • Configuring reminders on processes
      • Checklist layout settings
      • Custom language settings
      • Creating a chart from reports
      • Configuring Microsoft Office 365
        • Permissions required for SharePoint
    • Profile
      • Org Settings
        • Home Screen
        • Org Details
        • Role Management
        • Apps
        • SSO
          • Logging in with SSO
          • SSO using SAML
        • Translations
  • Manage
    • Processes
      • Checklist
        • File Upload
          • Computer
          • Unifize file store
          • SharePoint
            • Configuring SharePoint on Unifize
        • Linked Field
        • Picklist
        • Universal Checklist settings
  • Developer Documentation
    • Introduction
      • Concepts & terminologies
    • Authentication
      • App management
      • App tokens
    • Usage
      • Fair usage policy
      • Testing environment
      • Quickstart
    • API Reference
      • Applications
      • Processes
      • Records
      • Field values
  • RELEASE NOTES
    • February 2025
    • March 2025
    • April 2025
      • Rich Text Fields in Checklist
      • Filling Checklist Metadata with AI
      • 'My Conversations' is now 'My Inbox'
      • Feature Enhancements
    • May 2025
      • SharePoint
      • Unifize Lite
      • SSO
      • Feature Enhancements
Powered by GitBook
On this page
Export as PDF
  1. Developer Documentation
  2. API Reference

Processes

PreviousApplicationsNextRecords

Last updated 1 month ago

Examples

The examples below will take you through creating your first process, to customizing it, and deleting it.

Creating a blank process

As a bare minimum, you need to provide the titlekey.

{
    "title": "My first process"
}

Congratulations, you have created your first process!

Adding a checklist field

A process, on its own, is not very useful. Let's add a checklist field.

Here are some code snippets demonstrating how to convert a JSON object to a Transit encoded string:

Using transit-js

// npm install @cognitect/transit-js

import transit from '@cognitect/transit-js';

// Create a Transit writer
const writer = transit.writer('json-verbose');

// Convert your JSON object
const jsonObject = {
  key: "value",
  number: 42,
  active: true
};

const transitString = writer.write(jsonObject);

Using transit

# pip install transit

import transit

# Create a Transit writer
writer = transit.writer('json-verbose')

# Convert your JSON object
json_object = {
  "key": "value",
  "number": 42,
  "active": True
}

transit_string = writer.write(json_object)

Using transit-java

// <dependency>
//    <groupId>com.cognitect</groupId>
//    <artifactId>transit-java</artifactId>
//    <version>1.0.0</version>
// </dependency>

import cognitect.transit.TransitFactory;
import cognitect.transit.Writer;

// Create a Transit writer
Writer writer = TransitFactory.writer(TransitFactory.Format.JSON_VERBOSE);

// Convert your JSON object
Map<String, Object> jsonObject = new HashMap<>();
jsonObject.put("key", "value");
jsonObject.put("number", 42);
jsonObject.put("active", true);

String transitString = writer.writeToString(jsonObject);

For example, given a checklist configuration as a JSON object such as

{
  "text": {
    "label": "My Text Field",
    "settings": {
      "multiline": true,
      "placeholder": "FooBar",
      "defaultValue": "abc"
    }
  }
}

After converting it to Transit encoded JSON string and escaping it, it should look like

"{\"~#text\":{\"label\":\"My Text Field\",\"settings\":{\"~#text\":{\"multiline\":true,\"placeholder\":\"FooBar\",\"defaultValue\":\"abc\"}}}}"

which can then be used in the payload as

{
  "checklistFields": [
    {
      "attrs": "{\"~#text\":{\"label\":\"My Text Field\",\"settings\":{\"~#text\":{\"multiline\":true,\"placeholder\":\"FooBar\",\"defaultValue\":\"abc\"}}}}"
    }
  ]
}

Text Field

Available configuration

  • Label

  • Multiline

  • Placeholder

  • Default value

  • Supressing notification for default value

{
  "text": {
    "label": "My Text Field",
    "settings": {
      "multiline": true,
      "placeholder": "FooBar",
      "defaultValue": "abc",
      "suppressDefaultNotification": false
    }
  }
}

Date Field

Available configuration

  • Label

  • Placeholder

{
  "date": {
    "label": "My Date Field",
    "settings": {
      "placeholder": "Click to add date"
    }
  }
}

User Field

Available configuration

  • Label

  • Default users

  • Supressing notification for default value

  • Multivalued toggle (default off)

{
  "user": {
    "label": "My User Field",
    "settings": {
      "users": [
        "GJuQurhdUOR9liGN1xGuACGM7pD2",
        "tOnGEe0vK7ZZ1B9798FISTPcdCz2"
      ],
      "suppressDefaultNotification": false,
      "multiple": true
    }
  }
}

Number Field

Available configuration

  • Label

  • Placeholder

  • Max value

  • Min value

  • Step (only applicable to the web UI)

  • Default value

  • Supressing notification for default value

  • Minimum places to display after decimal point (only applicable to the web UI)

  • Round off if number digits entered after decimal are more than configured (default false, only applicable to web UI)

{
  "number": {
    "label": "My Number Field",
    "settings": {
      "placeholder": "5",
      "max": 10,
      "min": 5,
      "step": 2,
      "defaultValue": 20,
      "suppressDefaultNotification": false,
      "format": {
        "decimalPlaces": 0,
        "roundOff": false
      }
    }
  }
}

Section Field

Available Configuration

  • Open by default (when status is set to)

{
  "section": {
    "label": "My Section",
    "settings": {
      "status": [10]
    }
  }
}

Subsection Field

{
  "section": {
    "label": "My Subsection",
    "settings": {
      "level": 1
    }
  }
}

File Field

Available Configuration

  • Label

  • Multivalued toggle

  • Show full preview toggle (only applicable to web UI)

  • Sorting by file name through name or upload date using date

  • Default files

  • Suppressing notification for default value

  • Restrict upload sources

{
  "file": {
    "label": "My File Field",
    "settings": {
      "multiple": true,
      "preview": true,
      "sortBy": "name",
      "defaultFile": [],
      "suppressDefaultNotification": false,
      "uploadOptions": [
        "computer",
        "unifize"
      ],
    }
  }
}

PDF Field

Available Configuration

  • Label

  • Optional file field to attach the PDF to, instead of PDF field

  • Customize checklist behavior through preview (don't attach to checklist, attach only latest to checklist, attach all to checklist, respectively)

  • Sequence of PDFs to stitch

    • Generate from a template using PDFGeneratorAPI, specify a templateId

    • Generate from a template using Adobe, specify name (a file, which is a template)

    • Generate from a native file, specify fieldId (a file field)

  • Button text (by default Generate PDF)

{
  "pdf": {
    "label": "My PDF Field",
    "settings": {
      "targetField": 30,
      "preview": "none | latest | all",
      "pdf": [
        {
          "seqNo": 0,
          "templateId": "123"
        },
        {
          "seqNo": 1,
          "name": "e097504a-9b09-409c-90ed-16ebbbc1eadd"
        },
        {
          "seqNo": 2,
          "fieldId": 10
        }
      ],
      "buttonText": "abc"
    }
  }
}

Revision Field

Available Configuration

  • Label

  • Who is authorized to create a revision

    • All the participants

    • The owner

    • Roles

    • Specific users

    • Groups

    • Users from a field (must be a user field)

  • Who is authorized to mark a revision current

    • All the participants (of the current revision)

    • All the participants (of the revision being marked current)

    • The owner (of the current revision)

    • The owner (of the revision being marked current)

    • Roles

    • Specific users

    • Groups

    • Users from a field (of the current revision) (must be a user field)

    • Users from a field (of the revision being marked current) (must be a user field)

    • Only when a specific status is set

  • Fields to copy

  • Navigate to new revision automatically when created (Only applicable for web UI)

  • Mandate writing comment when creating revision

  • Automations

    • On the new current revision

      • Add participants

      • Remove participants

      • Add participants to fields

      • Send message

      • Update privacy

      • Unarchive

    • On the old current revision

      • Add participants

      • Remove participants

      • Add participants to fields

      • Send message

      • Update privacy

      • Update status

      • Auto archive

{
  "revision": {
    "label": "revision",
    "settings": {
      "version": 2,
      "authorizedToCreate": {
        "allParticipants": true,
        "owner": true,
        "roles": [
          619
        ],
        "users": [
          "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
        ],
        "groups": [
          73
        ],
        "fields": [
          340443
        ]
      },
      "authorizedToMarkCurrent": {
        "allParticipants": true,
        "owner": true,
        "roles": [
          619
        ],
        "users": [
          "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
        ],
        "groups": [
          73
        ],
        "fields": [
          340443
        ],
        "statuses": [
          -2
        ],
        "allParticipantsOfCurrent": true,
        "ownerOfCurrent": true,
        "fieldsOfCurrent": [
          340443
        ]
      },
      "copyableFields": [
        340441
      ],
      "navigateToNewRevision": true,
      "commentRequired": true,
      "automations": {
        "newCurrent": [
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "addParticipantsFromFields",
            "data": [
              340443
            ]
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "This is the current version now."
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "content",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": true,
            "action": "archive",
            "data": false
          }
        ],
        "oldCurrent": [
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "addParticipantsFromFields",
            "data": [
              340443
            ]
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "This is no longer the current version."
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "full",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": true,
            "action": "updateStatus",
            "data": -2
          },
          {
            "active": true,
            "action": "archive",
            "data": true
          }
        ]
      }
    }
  }
}

Approval Field

Available Configuration

  • Label

  • Show "Request Approval" button

  • Minimum required approvers

  • Required approvers

    • Set to some to let anyone sign

    • Set to adhoc to dynamically choose who can sign (Will override Minimum required approvers and Show "Request Approval" button )

  • Who can approve

    • All participants

    • The owner

    • Prevent requester from approving

    • Users

    • Roles

    • Groups

    • Users in field(s) (Must be a user field)

  • Who can cancel

    • All participants

    • Approvers/signatories

    • Prevent requester from approving

    • Users

    • Roles

    • Groups

    • Users in field(s) (Must be a user field)

    • Can cancel when

      • Allow cancellation post approval (allowCancelOnApproval)

      • Allow cancelling of approvals in progress (canCancelPartialApproval)

  • Require comments

    • During approval

    • During rejection

    • During cancellation

  • Contingent of previous approval(s)

    • Hide/disable when inactive

    • Disable previous approvals while field is approved or in progress

  • Lock fields

    • When mode is set to new, fields will be locked during and post approval/rejection

    • When mode is set to inherit, fields will continue to be locked under previous approval

  • Lock status

    • On start / request of signature

    • On approval

    • On rejection

    • On cancellation

  • Cancel all contingent approvals on rejection

  • Automations

    • On start / request of signature

      • Update status

      • Add participants

      • Remove participants

      • Change owner

      • Send message

      • Update privacy

    • On approval

      • Update status

      • Add participants

      • Remove participants

      • Change owner

      • Send message

      • Update privacy

      • Mark revision as current

    • On rejection

      • Update status

      • Add participants

      • Remove participants

      • Change owner

      • Send message

      • Update privacy

    • On cancellation

      • Update status

      • Add participants

      • Remove participants

      • Change owner

      • Send message

      • Update privacy

 {
  "approval": {
    "label": "approval",
    "settings": {
      "version": 2,
      "minApprovers": 1,
      "requiredApprovers": "some | adhoc",
      "showRequestApprovalButton": true,
      "approvers": {
        "allParticipants": true,
        "owner": true,
        "preventRequester": true,
        "users": [
          "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
        ],
        "roles": [
          619
        ],
        "groups": [
          73
        ],
        "fields": [
          340443
        ]
      },
      "cancellers": {
        "allParticipants": true,
        "approvers": true,
        "users": [
          "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
        ],
        "roles": [
          619
        ],
        "groups": [
          73
        ],
        "fields": [
          340443
        ]
      },
      "allowCancelOnApproval": true,
      "canCancelPartialApproval": true,
      "requireComment": true,
      "requireRejectionComment": true,
      "requireCancellationComment": true,
      "contingentApprovals": [
        340458
      ],
      "inactiveBehavior": "disable | hide",
      "canCancelContingentApprovals": true,      
      "cancelContingentApprovalsOnRejection": true,
      "lockFields": {
        "mode": "new | inherit",
        "fields": [
          340441,
          340443
        ]
      },            
      "lockStatus": {
        "onStart": true,
        "onApproval": true,
        "onCancellation": true,
        "onRejection": true
      },
      "automations": {
        "started": [
          {
            "active": true,
            "action": "updateStatus",
            "data": -2
          },
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "updateOwner",
            "data": "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "abc"
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "content",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": false,
            "action": "markRevisionAsCurrent",
            "data": null
          }
        ],
        "approved": [
          {
            "active": true,
            "action": "updateStatus",
            "data": -2
          },
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "updateOwner",
            "data": "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "abc"
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "content",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": true,
            "action": "markRevisionAsCurrent",
            "data": null
          }
        ],
        "rejected": [
          {
            "active": true,
            "action": "updateStatus",
            "data": -2
          },
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "updateOwner",
            "data": "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "abc"
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "content",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": false,
            "action": "markRevisionAsCurrent",
            "data": null
          }
        ],
        "cancelled": [
          {
            "active": true,
            "action": "updateStatus",
            "data": -2
          },
          {
            "active": true,
            "action": "addParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "removeParticipants",
            "data": [
              "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
            ]
          },
          {
            "active": true,
            "action": "updateOwner",
            "data": "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
          },
          {
            "active": true,
            "action": "sendMessage",
            "data": "abc"
          },
          {
            "active": true,
            "action": "updatePrivacy",
            "data": {
              "mode": "content",
              "whitelistedUsers": [
                "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
              ]
            }
          },
          {
            "active": false,
            "action": "markRevisionAsCurrent",
            "data": null
          }
        ]
      }
    }
  }
}

Conversation Field

Available Configuration

  • Label

  • Set as child or parent conversation

  • Multiselect toggle

  • Allow selecting existing conversations through select

  • Allow creating new conversations through create

  • Autofill related conversation

  • Specify type of conversation

  • Process id through workflow (Only valid if type is set to "workflow")

  • Configure embedded fields (Only valid if type is set to workflow)

  • Show field names in preview

  • Show status and due date

  • Sort conversations

  • Select existing conversations by criteria

  • Show/hide archived conversations

  • Suppress title hyperlink to the record

{
  "conversation": {
    "label": "My Conversation Field",
    "settings": {
      "child": true,
      "multiple": true,
      "select": true,
      "create": true,
      "autoFillRelated": true,
      "type": "group | workflow | approval | conversation | task",
      "workflow": 10,
      "fields": [50 60],
      "showFieldNames": false,
      "showMetaData": false,
      "sortBy": "added | created",
      "selectExistingBy": " | title",
      "showArchived": false,
      "disableTitleHyperlink": false
    }
  }
}

Linked Field

Available Configuration

  • Label

  • Specify process and embedded fields

  • Allow linking multiple records

  • Autofill related records

  • Allow archived conversations

  • Show compressed preview

  • Show status, owner and due date

  • Disable title hyperlink to record

  • Set current process as child or parent

  • Allow selecting existing record

  • Allow creating new record

  • Allow manual revision linking

  • Select existing record by criteria

    • Title

{
  "link": {
    "label": "linked",
    "settings": {
      "workflow": 16388,
      "fields": [
        340441
      ],
      "multiple": true,
      "autoFillRelated": true,
      "showArchived": true,      
      "showCompressedPreview": true,
      "showMetaData": true,
      "disableTitleHyperlink": true,
      "child": false,
      "select": true,
      "create": true,      
      "type": "workflow",
      "alwaysAllowManualLinks": true,
      "selectExistingBy": "title"
    }
  }
}

Form Fields

Available Configuration

  • Label

  • Allow multiple

  • Specify form templates

{
  "form": {
    "label": "form",
    "settings": {
      "multiple": true,
      "selectedForms": [
        6217
      ]
    }
  }
}

Deleting a checklist field

Restoring a checklist field

Let's start by creating a blank process using the API.

Checklist fields are added/updated/removed to a process through thechecklistFieldsarray. Each element in the array represents a checklist field. The checklist field configuration is present in the attrs key, which is a encoded JSON string. To convert a JSON object to a Transit encoded JSON string, you can make use of various libraries which have implemented the Transit spec. When writing the string, ensure you use the json-verbosetype, instead of json. In the examples below, we may opt to write JSON objects for readability. You will need to convert them to Transit before making the API call.

To delete a checklist field, use the API and remove the checklist field you want to delete from the checklistFields array.

To restore a checklist field, use a combination of the and APIs.

The API should include the field you want in its response, even if it is deleted.

To restore it, set the values of deleted, deletedAt and deletedBy to null when using the API. Make sure you do not modify the rest of the checklist field object.

Transit
Create process
Update process
Get process
Update process
Get process
Update process

Get list of processes

get
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
get
GET /workflow HTTP/1.1
Host: 
Accept: */*
[
  {
    "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "updatedAt": "2024-01-11T06:07:04.182Z",
    "updatedBy": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "checklistFields": [
      {
        "attrs": "{\"~#text\":{\"label\":\"ENTER YOUR NAME\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
        "config": {
          "label": "ENTER YOUR NAME",
          "settings": {
            "multiline": true
          },
          "autoCheck": false
        },
        "promptRules": {
          "roles": [],
          "users": []
        },
        "id": 73,
        "seqNo": 0,
        "deletedAt": "2024-01-11T06:07:04.182Z",
        "layout": {},
        "deletedBy": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
        "deleted": true,
        "target": false,
        "hidden": false,
        "fieldType": "text"
      }
    ],
    "privacy": "none",
    "reminder": [
      "text"
    ],
    "createdAt": "2023-10-10T05:52:28.348Z",
    "settings": {
      "allowArchive": true,
      "nextCount": 2,
      "dueIn": "2023-11-10T05:52:28.348Z",
      "senderNotParticipant": false,
      "creatorIsParticipant": true,
      "noConfirmation": false,
      "creatorIsOwner": true,
      "hideAutoNumber": false,
      "statusDisabled": false
    },
    "members": [
      "Q79THCOJ5CcvWRMPeIVZiq1ezu42"
    ],
    "id": 33,
    "files": [
      {}
    ],
    "privacySettings": {},
    "draft": false,
    "numberingScheme": "Approval Test ###",
    "creator": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "notificationGroups": [
      {}
    ],
    "address": "approval-test",
    "status": [
      {
        "title": "Approved",
        "id": 6,
        "active": false,
        "seqNo": 3,
        "locked": false,
        "settings": {
          "archiveMode": "ignore"
        },
        "rules": {
          "id": 213,
          "entity": "status",
          "entityId": 6,
          "field": "text",
          "blocks": [
            {}
          ],
          "defaultBehavior": {
            "state": "enabled",
            "tooltip": ""
          }
        }
      }
    ],
    "layout": {},
    "checklists": [
      {
        "description": "text",
        "checklistId": 1
      }
    ],
    "activeCount": 39,
    "title": "Approval Test",
    "deleted": false,
    "processOwners": [
      "text"
    ],
    "invocationCount": 59,
    "groups": [
      "text"
    ],
    "orgId": 1,
    "description": "New Process"
  }
]

Get process settings

get
Path parameters
idintegerRequired

ID of the workflow

Example: 13
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
get
GET /workflow/{id} HTTP/1.1
Host: 
Accept: */*
{
  "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "updatedAt": "2024-01-11T06:07:04.182Z",
  "updatedBy": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "checklistFields": [
    {
      "attrs": "{\"~#text\":{\"label\":\"ENTER YOUR NAME\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
      "config": {
        "label": "ENTER YOUR NAME",
        "settings": {
          "multiline": true
        },
        "autoCheck": false
      },
      "promptRules": {
        "roles": [],
        "users": []
      },
      "id": 73,
      "seqNo": 0,
      "deletedAt": "2024-01-11T06:07:04.182Z",
      "layout": {},
      "deletedBy": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
      "deleted": true,
      "target": false,
      "hidden": false,
      "fieldType": "text"
    }
  ],
  "privacy": "none",
  "reminder": [
    "text"
  ],
  "createdAt": "2023-10-10T05:52:28.348Z",
  "settings": {
    "allowArchive": true,
    "nextCount": 2,
    "dueIn": "2023-11-10T05:52:28.348Z",
    "senderNotParticipant": false,
    "creatorIsParticipant": true,
    "noConfirmation": false,
    "creatorIsOwner": true,
    "hideAutoNumber": false,
    "statusDisabled": false
  },
  "members": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42"
  ],
  "id": 33,
  "files": [
    {}
  ],
  "privacySettings": {},
  "draft": false,
  "numberingScheme": "Approval Test ###",
  "creator": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "notificationGroups": [
    {}
  ],
  "address": "approval-test",
  "status": [
    {
      "title": "Approved",
      "id": 6,
      "active": false,
      "seqNo": 3,
      "locked": false,
      "settings": {
        "archiveMode": "ignore"
      },
      "rules": {
        "id": 213,
        "entity": "status",
        "entityId": 6,
        "field": "text",
        "blocks": [
          {}
        ],
        "defaultBehavior": {
          "state": "enabled",
          "tooltip": ""
        }
      }
    }
  ],
  "layout": {},
  "checklists": [
    {
      "description": "text",
      "checklistId": 1
    }
  ],
  "activeCount": 39,
  "title": "Approval Test",
  "deleted": false,
  "processOwners": [
    "text"
  ],
  "invocationCount": 59,
  "groups": [
    "text"
  ],
  "orgId": 1,
  "description": "New Process"
}

Delete a process

delete
Path parameters
idintegerRequired

ID of the workflow

Example: 11
Responses
204
No Content
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
delete
DELETE /workflow/{id} HTTP/1.1
Host: 
Accept: */*

No content

  • GETGet list of processes
  • GETGet process settings
  • POSTCreate process
  • PATCHUpdate a process
  • DELETEDelete a process
  • POSTRestore a process
  • Examples
  • Creating a blank process
  • Adding a checklist field
  • Deleting a checklist field
  • Restoring a checklist field

Create process

post
Body
titlestringRequired

Title of the Workflow template

Example: Purchase order
descriptionstringOptional

Description of the Workflow template

Example: Get the list of items for purchase
membersstring[]Optional

List of member IDs

Example: ["Q79THCOJ5CcvWRMPeIVZiq1ezu42","fcsknAS1txaGbWyYIILvu56dtir2"]
groupsstring[]Optional

List of groups

processOwnersstring[]Optional

List of process owner IDs

ownerstringOptional

Owner ID

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42
numberingSchemestringRequired

Numbering scheme for the Workflow template

Example: Purchase order ###
checklistsinteger[]Optional

List of checklist IDs

notificationGroupsstring[]Optional

List of notification groups

filesobject[]Optional

List of file names

privacystringOptional

Privacy setting

Example: full
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
post
POST /workflow HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 914

{
  "title": "Purchase order",
  "description": "Get the list of items for purchase",
  "members": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "fcsknAS1txaGbWyYIILvu56dtir2"
  ],
  "groups": [],
  "processOwners": [],
  "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "numberingScheme": "Purchase order ###",
  "checklists": [],
  "checklistFields": [
    {
      "attrs": "{\"~#text\":{\"label\":\"Name of the Company\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
      "layout": null,
      "deleted": false,
      "hidden": false,
      "deletedBy": null,
      "deletedAt": null
    }
  ],
  "notificationGroups": [],
  "files": [],
  "privacy": "full",
  "status": [
    {
      "id": -1,
      "active": true,
      "rules": {
        "blocks": [
          "text"
        ]
      }
    }
  ],
  "privacySettings": {
    "whitelist": [
      "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
      "fcsknAS1txaGbWyYIILvu56dtir2"
    ]
  },
  "settings": {
    "allowArchive": true,
    "nextCount": 1,
    "hideAutoNumber": false,
    "statusDisabled": false,
    "creatorIsOwner": true,
    "creatorIsParticipant": true,
    "senderNotParticipant": false,
    "noConfirmation": false,
    "dueIn": 2
  }
}
{
  "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "updatedAt": "2024-02-05T03:55:20.114928Z",
  "updatedBy": null,
  "privacy": "full",
  "reminder": [
    {
      "id": 8,
      "reminderTypeId": 1,
      "reminderType": "inactivity",
      "remindIn": 1,
      "interval": "day",
      "allowDisable": true,
      "message": "Please update the values of the Purchase"
    }
  ],
  "createdAt": "2024-02-05T03:55:20.083Z",
  "settings": {
    "allowArchive": true,
    "nextCount": null,
    "dueIn": 2,
    "senderNotParticipant": false,
    "creatorIsParticipant": true,
    "noConfirmation": false,
    "creatorIsOwner": true,
    "hideAutoNumber": false,
    "statusDisabled": false
  },
  "members": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "fcsknAS1txaGbWyYIILvu56dtir2"
  ],
  "id": 43,
  "files": [],
  "privacySettings": {
    "whitelist": [
      "text"
    ]
  },
  "draft": false,
  "numberingScheme": "Purchase order ###",
  "creator": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "notificationGroups": [],
  "address": "purchase-order",
  "status": [
    {
      "title": "Pending",
      "id": -1,
      "active": true,
      "seqNo": 1,
      "locked": false,
      "settings": {},
      "rules": {}
    }
  ],
  "layout": {
    "checklistWidth": "1",
    "checklistOpenState": {
      "web": true,
      "lite": true,
      "liteMobile": false
    }
  }
}

Update a process

patch
Path parameters
idintegerRequired

ID of the workflow

Example: 11
Body
titlestringOptional

Title of the Workflow Template

Example: Workflow Template
descriptionstringOptional

Description of the Workflow Template

Example: Get the list of items for purchase
membersstring[]Optional

List of member IDs associated with the Workflow Template

Example: ["Q79THCOJ5CcvWRMPeIVZiq1ezu42","fcsknAS1txaGbWyYIILvu56dtir2"]
groupsinteger[]Optional

List of group information

processOwnersstring[]Optional

List of process owner IDs

Example: ["Q79THCOJ5CcvWRMPeIVZiq1ezu42"]
ownerstringOptional

Owner ID of the Workflow Template

Example: Q79THCOJ5CcvWRMPeIVZiq1ezu42
numberingSchemestringOptional

Numbering scheme for the Workflow Template

Example: Purchase order ###
notificationGroupsinteger[]Optional

List of notification groups

filesobject[]Optional

List of files

privacystringOptional

Privacy setting for the Workflow Template

Example: none
privacySettingsobjectOptional

Privacy settings information

Example: {"whitelist":["fcsknAS1txaGbWyYIILvu56dtir2"]}
draftbooleanOptional

Flag indicating if the Workflow Template is a draft

Example: false
Responses
200
Success
application/json
401
Authentication / Authorization error
application/json
404
Not Found
application/json
500
Internal server error
application/json
patch
PATCH /workflow/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1237

{
  "title": "Workflow Template",
  "description": "Get the list of items for purchase",
  "members": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "fcsknAS1txaGbWyYIILvu56dtir2"
  ],
  "groups": [],
  "processOwners": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42"
  ],
  "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "numberingScheme": "Purchase order ###",
  "notificationGroups": [],
  "files": [],
  "privacy": "none",
  "status": {
    "title": "Completed",
    "id": -2,
    "active": false,
    "seqNo": 2,
    "locked": false,
    "settings": {},
    "rules": {
      "blocks": [
        {}
      ]
    }
  },
  "privacySettings": {
    "whitelist": [
      "fcsknAS1txaGbWyYIILvu56dtir2"
    ]
  },
  "settings": {
    "allowArchive": true,
    "nextCount": 23,
    "dueIn": 2,
    "senderNotParticipant": false,
    "creatorIsParticipant": true,
    "noConfirmation": false,
    "creatorIsOwner": true,
    "hideAutoNumber": false,
    "statusDisabled": false
  },
  "reminder": {
    "id": 8,
    "reminderTypeId": 1,
    "reminderType": "inactivity",
    "remindIn": 1,
    "interval": "day",
    "allowDisable": false,
    "message": "Please update the values of the Purchase"
  },
  "layout": {
    "checklistWidth": "1",
    "checklistOpenState": {
      "web": true,
      "lite": true,
      "liteMobile": false
    }
  },
  "draft": false,
  "checklistFields": [
    {
      "attrs": "{\"~#text\":{\"label\":\"Name of the Company\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
      "layout": null,
      "deleted": false,
      "hidden": false,
      "deletedBy": null,
      "deletedAt": null
    }
  ]
}
{
  "title": "Workflow Template",
  "description": "Get the list of items for purchase",
  "members": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
    "fcsknAS1txaGbWyYIILvu56dtir2"
  ],
  "groups": [],
  "processOwners": [
    "Q79THCOJ5CcvWRMPeIVZiq1ezu42"
  ],
  "owner": "Q79THCOJ5CcvWRMPeIVZiq1ezu42",
  "numberingScheme": "Purchase order ###",
  "checklists": [
    35
  ],
  "notificationGroups": [],
  "files": [],
  "privacy": "none",
  "status": {
    "title": "Completed",
    "id": -2,
    "active": false,
    "seqNo": 2,
    "locked": false,
    "settings": {},
    "rules": {
      "blocks": [
        {}
      ]
    }
  },
  "privacySettings": {
    "whitelist": [
      "fcsknAS1txaGbWyYIILvu56dtir2"
    ]
  },
  "settings": {
    "allowArchive": true,
    "nextCount": 23,
    "dueIn": 2,
    "senderNotParticipant": false,
    "creatorIsParticipant": true,
    "noConfirmation": false,
    "creatorIsOwner": true,
    "hideAutoNumber": false,
    "statusDisabled": false
  },
  "reminder": {
    "id": 8,
    "reminderTypeId": 1,
    "reminderType": "inactivity",
    "remindIn": 1,
    "interval": "day",
    "allowDisable": false,
    "message": "Please update the values of the Purchase"
  },
  "layout": {
    "checklistWidth": "1",
    "checklistOpenState": {
      "web": true,
      "lite": true,
      "liteMobile": false
    }
  },
  "draft": false,
  "address": "purchase-order",
  "deleted": false,
  "checklistFields": [
    {
      "attrs": "{\"~#text\":{\"label\":\"Name of the Company\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
      "layout": null,
      "deleted": false,
      "hidden": false,
      "deletedBy": null,
      "deletedAt": null
    }
  ]
}

Restore a process

post
Path parameters
idintegerRequired

ID of the process

Example: 11
Body
restorebooleanRequired

Restore process

Example: true
Responses
200
Success
post
POST /workflow/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "restore": true
}
200

Success

No content