Methods

The OpenProcess API enables third party/external applications to interact with the OpenProcess application.

The API is REST API driven and each method/endpoint is documented below. Where licensed these APIs can be tested using the actual Swagger UI endpoint in OpenProcess.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

Start a process

post /open-api/processes

A change has been made to Open Process API (available in OP Test from Aug 24) to allow the following in respect of Start a Process API - this is now available in Open Process Test

1. Pass in Fields of data (Text fields initially)

2. Start a process without needing a customer account linked

Sample request with Field data:

(note the "FieldId" is no longer used, "Code" is used to map the value)

{

  "processTypeId": "b659adbb-37c0-40a4-8b3b-668add367a91",

  "accounts": [],

  "documents": [],

  "notes": [

    {

      "contents": "Notes go here",

      "visibleToAccounts": false

    }

  ],

  "fields": [

    {    

      "name": "Surname",

      "value": "Surname go here",

      "fieldId": "00000000-0000-0000-0000-000000000001",

      "code": "FIELDVALUE1",

      "description": "Dummy Field Value",

      "fieldType": "Text",

      "confidential": false

    },

    {    

      "name": "Extra Details",

      "value": "Extra Details go here",

      "fieldId": "00000000-0000-0000-0000-000000000002",

      "code": "FIELDVALUE2",

      "description": "Dummy Field Value",

      "fieldType": "Text",

      "confidential": false

    },

    {    

      "name": "Extra Details 1",

      "value": "Extra Details 1 go here",

      "fieldId": "00000000-0000-0000-0000-000000000003",

      "code": "FIELDVALUE3",

      "description": "Dummy Field Value",

      "fieldType": "Text",

      "confidential": false

    }

  ]

}

Note: it is currently not possible to pass in Documents

In the example above the ProcessID is found by going to Open Process and in Set Up taking the GUID at the end of the URL for the process to be started i.e. in the process below the Process ID is "b659adbb-37c0-40a4-8b3b-668add367a91"

https://openprocess-test.ieg4.net/#/setup/process-types/6e986d6a-2f6e-4559-8deb-17df09e7ca23/details/b659adbb-37c0-40a4-8b3b-668add367a91/edit