Get process state and status

Returns the current state and status of a process.

GET /processes/{pid}

Get process state and status

cURL

curl --request GET \
  --url http://localhost:7687/processes/{pid}

200

queued

{
  "pid": 1,
  "state": "queued",
  "status": null
}

Path Parameters

pid · integer · required

The process ID returned by POST /processes.

Example:

1

Response

200

application/json

Process found.

pid · integer · required

Unique identifier for the process.

Example:

1

state · enum<string> · required

Where the process is in its life-cycle.

Available options: queued, running, idle

status · enum<string> | null · required

The outcome of execution.

Available options: success, failed, canceled, null

ref · string | null

Client-provided reference identifying the source of the process.