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.

Gets a document and its contents. The contents are returned as a base64 encoded string

get

Path parameters

documentIdstringRequired

The id of the document to retrieve

Responses

200

OK

application/jsontext/json

Responseobject

get

HTTPcURLJavaScriptPython

GET /open-api/documents/{documentId} HTTP/1.1
Host: openprocess-test.ieg4.net
Accept: */*

200

OK

{}

Gets the current in-progress step for a process

get

Path parameters

processIdstringRequired

Responses

200

OK

application/jsontext/json

Responseobject

get

HTTPcURLJavaScriptPython

GET /open-api/processes/{processId}/current-step HTTP/1.1
Host: openprocess-test.ieg4.net
Accept: */*

200

OK

{}

Gets a custom data extract. N.B. this is an optional component, currently licensed for OpenProcess point solutions such as Right to Buy.

post

Path parameters

fileDescriptorIdstringRequired

The id of the descriptor file. This defines the number and type of columns in the extract

Body

application/jsontext/jsonapplication/x-www-form-urlencoded

typeinteger · enumRead-onlyOptionalPossible values:

Responses

200

OK

application/jsontext/json

Responseobject

post

HTTPcURLJavaScriptPython

POST /open-api/extracts/{fileDescriptorId} HTTP/1.1
Host: openprocess-test.ieg4.net
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

application/jsontext/jsonapplication/x-www-form-urlencoded

200

OK

{}

Completes a step if eligible

post

Path parameters

processIdstringRequired

stepIdstringRequired

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

Responses

200

OK

application/jsontext/json

Responseobject

post

HTTPcURLJavaScriptPython

POST /open-api/processes/{processId}/steps/{stepId}/complete HTTP/1.1
Host: openprocess-test.ieg4.net
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "fields": [
    {
      "fieldId": "text",
      "code": "text",
      "name": "text",
      "description": "text",
      "fieldType": "text",
      "confidential": true
    }
  ]
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

{}

Add a note to a process

post

Path parameters

processIdstringRequired

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

contentsstringOptional

visibleToAccountsbooleanOptional

Responses

200

OK

application/jsontext/json

Responseobject

post

HTTPcURLJavaScriptPython

POST /open-api/processes/{processId}/notes HTTP/1.1
Host: openprocess-test.ieg4.net
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "contents": "text",
  "visibleToAccounts": true
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

{}

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