> For the complete documentation index, see [llms.txt](https://ieg4.gitbook.io/onevu-digital-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ieg4.gitbook.io/onevu-digital-platform/openprocess-api/methods.md).

# 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 in the Swagger page below. Where licensed these APIs can be tested using the actual Swagger UI endpoint in OpenProcess. 

<https://openprocess-test.ieg4.net/swagger>

<figure><img src="/files/M6USx7TOv7OWkoiAHzuj" alt=""><figcaption></figcaption></figure>

**Complete Step**

The schema for Complete Step does now support passing in Fields of data see further details&#x20;

{% embed url="<https://app.gitbook.com/o/-MgM_eQPRVsLiSnRDTQc/s/-MgKIYotuJ2G9zOHXIfg/~/edit/~/changes/315/openprocess-cases-and-workflow/building-processes/steps/rest-api-steps/worked-example#complete-step-with-fields>" %}
Complete Step details
{% endembed %}

**Start a process**

{% hint style="info" %}
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: &#x20;

(note the "FieldId" is no longer used, "Code" is used to map the value)
{% endhint %}

{% hint style="info" %}

```postman_json
{

  "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>
{% endhint %}

#### **June 2026 updates - Get Process by External Reference and Get Process Steps** <a href="#june-2026-updates" id="june-2026-updates"></a>

Two new APIs have been made available in Open Process.

Full details available in the Swagger page.

**Processes / Get process by reference**

Previously the only way to query a process was using the Process Id.  This new API returns process details based on the External Reference

The response includes the following:

·       Started Date

·       Completed Date

·       Location

·       Allocated user

·       Step details

·       Notes details

·       Documents details

·       Accounts details

**Steps / Get process steps**

This API returns the process steps for the given External Reference.  This API is used in the Forms platform to return the details for the new Status Tracking feature but councils could also make use of the API to build their own status tracking web page.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ieg4.gitbook.io/onevu-digital-platform/openprocess-api/methods.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.