Authorization

Robocorp Process API

Fetch the list of processes in the workspace

workspaceId

Starts a process run with the provided configuration, by the following rules:
* If `type = default`: the process is started based on process default configuration. No parameters.
* If `type = workItemIds`: the process is started with given work items. Additional parameter `workItemIds` required.

processId

Start a process with the provided configuration.

limit

Starts a process run with a new work item.

If the request has a body, the body is used as a data payload for a new work item. The payload must be valid JSON (RFC 7159). Even if the body is an array, it is interpreted as a single payload (in this case an array object).

If the request has no body, a new work item is created without a payload.

Data to process. Will be used as a data payload for a new work item.

Start a process with an optional work item data payload

Starts a process run with multiple work items.

The request body is expected to contain multiple work item data payloads. The body must be a valid JSON array (RFC 7159). A new work item is created for each payload (element in the deserialized array).

Start a process with multiple work item data payloads

Proxy for `POST /workspaces/{workspaceId}/processes/{processId}/runs`.

Reads WS-KEY from the query string (value of key `token`) instead of the Authorization header.

**It is recommended that you use this only if you are unable to modify the headers of your HTTP request.**

token

After triggering the process via API you can monitor the process run status.

processRunId

robotRunId

artifactId

fileName

Fetch a list of work items for a process run

Include work item payload JSON and files metadata in the result

includeData

A count of objects to be returned, between 1 and 100.

size

state

Filter results by some free form string in the work item payload

search

Sort results by one of the available fields

sortBy

Set whether to return sorted results in ascending or descending order

sortOrder

The endpoint utilizes cursor-based pagination via the `cursor` parameter. Each response contains `nextCursor` and `previousCursor` parameters that can be used to retrieve the next and previous page of results respectively.

To retrieve the next page of results set the `cursor` parameter as `nextCursor` value.

To retrieve the previous page of results set the `cursor` parameter as `previousCursor` value.
            
The are no more results if the `nextCursor` is set as `null`.


cursor

The endpoint utilizes cursor-based pagination via the `cursor` parameter. Each response contains `nextCursor` and `previousCursor` parameters that can be used to retrieve the next and previous page of results respectively.

To retrieve the next page of results set the `cursor` parameter as `nextCursor` value.

To retrieve the previous page of results set the `cursor` parameter as `previousCursor` value.

The are no more results if the `nextCursor` is set as `null`.


Creates a new work item into the process. The item is created as input
to the first step in the process. 

The endpoint can operate in 2 different ways. If `bodyAsPayload` is set
to true, the request body is treated as the work item data. 
If it is set to false, `.payload` is used for the work item data.


bodyAsPayload

Optional parameters. Without posting a request body the work item is created as empty.

Create a new work item into the process input

workItemId

Marks a work item as completed. This will cause the work item to be set
to completed state and it will not be processed further. Operation can
only be performed on work items in state `FAILED`.


Overwrites the work item data (JSON) payload

Registers a new work item file and returns file upload info. The output
is a JSON object declaring the URL and form fields that can be used to
actually POST the binary file.


Request body must contain file name and size.

fileId

Requests reprocessing of a work item. Work item is then processed
again in the same process run and process step. Operation can only be
performed on work items in state `FAILED`.


Robocorp Process APIVersion 1.2