List the processes the caller may start

GET

/api/v1/console/startable-processes

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/api/v1/console/startable-processes"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/api/v1/console/startable-processes';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/console/startable-processes \
  --header 'Authorization: Bearer <token>'

Available inEmbeddedBundledCluster

AuthAuthenticated Bearer token

The latest deployed version of every process the caller may start, narrowed by the caller’s grants, by process id. text keeps the processes whose id holds it (any case) and limit (1 to 200) the first ones; totalItems counts every match. Start one with POST /v2/process-instances. Requires instance:create.

Authorizations

bearerAuth

Parameters

Query Parameters

text

string

limit

integer

>= 1 <= 200

Header Parameters

x-tenant-id

string

>= 1 characters

Tenant selection. A principal of one tenant may omit it, and if sent it must name that tenant. A principal that may act in several tenants sends it on every request.

Responses

200

The startable processes

application/json

object

Example^generated

{}

400

Invalid request

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request is malformed",
  "instance": "/api/v1/console/startable-processes"
}

401

Authentication required

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/api/v1/console/startable-processes"
}

Headers

WWW-Authenticate

string

403

The caller lacks the required permission.

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/api/v1/console/startable-processes"
}

404

Tenant-scoped resource not found

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource does not exist",
  "instance": "/api/v1/console/startable-processes"
}

409

Idempotency conflict

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key is already associated with another request",
  "instance": "/api/v1/console/startable-processes"
}

413

Authenticated request exceeds its configured bound

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:payload-too-large",
  "title": "Payload Too Large",
  "status": 413,
  "detail": "The request exceeds the configured size limit",
  "instance": "/api/v1/console/startable-processes"
}

429

Tenant quota exhausted

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:quota-exhausted",
  "title": "Quota Exhausted",
  "status": 429,
  "detail": "The tenant active-instance quota is exhausted",
  "instance": "/api/v1/console/startable-processes"
}

500

Non-leaking internal failure

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/api/v1/console/startable-processes"
}

501

The operation is on the reviewed allow-list of what this deployment mode cannot serve.

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:mode-not-supported",
  "title": "Mode Not Supported",
  "status": 501,
  "detail": "GET /api/v1/console/startable-processes is not supported in embedded mode",
  "instance": "/api/v1/console/startable-processes",
  "mode": "embedded"
}

503

Backpressure or dependency unavailable

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/api/v1/console/startable-processes"
}

List the processes the caller may start

Authorizations

Parameters

Query Parameters

Header Parameters

Responses

200

Examplegenerated

400

Example

401

Example

Headers

403

Example

404

Example

409

Example

413

Example

429

Example

500

Example

501

Example

503

Example

Example^generated