Modify a process instance

POST

/v2/process-instances/{processInstanceKey}/modification

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/v2/process-instances/2251799813685249/modification"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"operationReference\": 1, \"activateInstructions\": [ { \"elementId\": \"example\", \"variableInstructions\": [ { \"variables\": {}, \"scopeId\": \"\" } ], \"ancestorElementInstanceKey\": \"2251799813685249\" } ], \"moveInstructions\": [ { \"sourceElementInstruction\": {}, \"targetElementId\": \"example\", \"ancestorScopeInstruction\": {}, \"variableInstructions\": [ { \"variables\": {}, \"scopeId\": \"\" } ] } ], \"terminateInstructions\": [ {} ] }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/v2/process-instances/2251799813685249/modification';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"operationReference":1,"activateInstructions":[{"elementId":"example","variableInstructions":[{"variables":{},"scopeId":""}],"ancestorElementInstanceKey":"2251799813685249"}],"moveInstructions":[{"sourceElementInstruction":{},"targetElementId":"example","ancestorScopeInstruction":{},"variableInstructions":[{"variables":{},"scopeId":""}]}],"terminateInstructions":[{}]}'
};

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

curl --request POST \
  --url http://localhost:8080/v2/process-instances/2251799813685249/modification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "operationReference": 1, "activateInstructions": [ { "elementId": "example", "variableInstructions": [ { "variables": {}, "scopeId": "" } ], "ancestorElementInstanceKey": "2251799813685249" } ], "moveInstructions": [ { "sourceElementInstruction": {}, "targetElementId": "example", "ancestorScopeInstruction": {}, "variableInstructions": [ { "variables": {}, "scopeId": "" } ] } ], "terminateInstructions": [ {} ] }'

Available inEmbeddedBundledCluster

AuthAuthenticated Bearer token or console session with X-CSRF-Token · requires instance:modify

Starts elements, ends element instances, and moves instances from one element to another, as one change that applies whole or not at all. An element to end or move from may be named by id (every active instance of it) or by element-instance key. A move’s target scope is found by the engine unless a direct ancestor is named. operationReference is refused with 400.

Authorizations

Parameters

Path Parameters

processInstanceKey

required

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

Header Parameters

x-tenant-id

string

>= 1 characters

Tenant selection. A principal bound to one tenant may omit it; if sent, it must equal that tenant (403 otherwise). A principal that may act in several tenants must send it on every request: without it the request is refused with 400, and a tenant it may not act in is refused with 403.

Idempotency-Key

string

>= 1 characters <= 200 characters

Makes a retried command safe. A repeat with the same key and the same body replays the first answer. A repeat with the same key and a different body is refused with 409.

Request Body^required

application/json

object

operationReference

Refused with 400.

integer

activateInstructions

Array<object>

object

elementId

required

string

variableInstructions

Array<object>

object

variables

required

object

key

additional properties

any

scopeId

The element id of the scope to set them in; empty is the started element’s own.

string

ancestorElementInstanceKey

Any of:

string
integer

Positive signed 64-bit entity key, written as a decimal string.

string

/^[1-9][0-9]*$/

moveInstructions

Array<object>

object

sourceElementInstruction

required

{sourceType: byId, sourceElementId} or {sourceType: byKey, sourceElementInstanceKey}.

object

targetElementId

required

string

ancestorScopeInstruction

{ancestorScopeType: direct, ancestorElementInstanceKey}, inferred or sourceParent.

object

variableInstructions

Array<object>

object

variables

required

object

key

additional properties

any

scopeId

The element id of the scope to set them in; empty is the started element’s own.

string

terminateInstructions

Array<object>

{elementInstanceKey} or {elementId} (every active instance of it).

object

Responses

204

The change was applied.

400

The request is malformed, or it uses a property or filter this release does not support.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "entity key must be a positive int64 string",
  "instance": "/v2/process-instances/0"
}

401

No valid credential was presented.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

Headers

WWW-Authenticate

string

Allowed value: Bearer

403

The caller lacks the required permission, a tenant named in the request is not the caller’s tenant, or a cookie write has no valid CSRF token.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

404

The entity does not exist in the caller’s tenant.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

409

An idempotency-key conflict, or a command the target’s current state does not allow.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

413

The body exceeds the configured request-size bound.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

500

An internal failure. The details are never exposed.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

501

The operation is not offered in the engine’s current deployment mode.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/clock is not supported in bundled mode: the deterministic virtual clock and the storage-free reset exist only for the Embedded engine; Bundled and Cluster run on the system clock over durable history, which cannot be pinned, rewound or discarded",
  "instance": "/v2/clock",
  "mode": "bundled"
}

503

Backpressure, or a dependency is not ready. Retry with the same idempotency key.

application/problem+json

An RFC 9457 problem document. type is a stable TinyConductor URN.

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": "/v2/process-instances/2251799813685262/modification"
}

Modify a process instance

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

204

400

Example

401

Example

Headers

403

Example

404

Example

409

Example

413

Example

500

Example

501

Example

503

Example

Request Body^required