Search cluster variables
HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:8080/v2/cluster-variables/search?truncateValues=true")) .header("Authorization", "Bearer <token>") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{ \"filter\": { \"scope\": \"TENANT\" }, \"sort\": [ { \"field\": \"name\" } ], \"page\": { \"limit\": 50 } }")) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());const url = 'http://localhost:8080/v2/cluster-variables/search?truncateValues=true';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"filter":{"scope":"TENANT"},"sort":[{"field":"name"}],"page":{"limit":50}}'};
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/cluster-variables/search?truncateValues=true' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "filter": { "scope": "TENANT" }, "sort": [ { "field": "name" } ], "page": { "limit": 50 } }'Lists the global variables and the caller’s own tenant’s variables
that match the filter. The search filters rather than refuses: it
answers only the variables the caller may read, and a caller with no
read permission at all gets an empty page. Values of 8,192 characters
or more are cut to their first 8,191 characters and marked
isTruncated, unless truncateValues=false. The default order is by
name, global before tenant. The answer is read from the engine’s
current state, never behind a completed write.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”true (default) cuts long values; false returns them whole.
Header Parameters
Section titled “Header Parameters”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.
Request Body
Section titled “Request Body”object
object
Whether the value is 8
object
Use at most one of from, after and before.
object
An offset into the sorted matches.
The endCursor of the previous page.
The startCursor of the following page.
Example
{ "filter": { "scope": "TENANT" }, "sort": [ { "field": "name" } ], "page": { "limit": 50 }}Responses
Section titled “ Responses ”The matching variables.
object
object
Unique within its scope. A leading digit is allowed.
The owning tenant; null for global scope.
The whole value as compact JSON text (a string value x is "x" with its quotes).
The value as JSON text; cut to 8
totalItems counts every readable match; hasMoreTotalItems is always false. startCursor and endCursor locate the first and last item of this page (null for an empty page).
object
Opaque, base64. Set on every page with items; null only on an empty page.
Opaque, base64. Set on every page with items; pass it as page.after for the next page, which is empty once every item was seen. null only on an empty page.
Example
{ "items": [ { "scope": "GLOBAL" } ]}The request is malformed, or it uses a property or filter this release does not support.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
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"}No valid credential was presented.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
Example
{ "type": "urn:bpm:error:unauthorized", "title": "Unauthorized", "status": 401, "detail": "A valid bearer credential is required", "instance": "/v2/cluster-variables/search"}Headers
Section titled “Headers”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.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
Example
{ "type": "urn:bpm:error:forbidden", "title": "Forbidden", "status": 403, "detail": "The principal lacks the action this route requires", "instance": "/v2/cluster-variables/search"}The body exceeds the configured request-size bound.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
Example
{ "type": "urn:bpm:error:payload-too-large", "title": "Payload Too Large", "status": 413, "detail": "The request exceeds the configured size limit", "instance": "/v2/cluster-variables/search"}An internal failure. The details are never exposed.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
Example
{ "type": "urn:bpm:error:internal", "title": "Internal Server Error", "status": 500, "detail": "The request could not be completed", "instance": "/v2/cluster-variables/search"}Backpressure, or a dependency is not ready. Retry with the same idempotency key.
An RFC 9457 problem document. type is a stable TinyConductor URN.
object
The request path.
Present only on mode-not-supported. It names the engine’s mode.
Example
{ "type": "urn:bpm:error:unavailable", "title": "Service Unavailable", "status": 503, "detail": "The required engine service is not ready", "instance": "/v2/cluster-variables/search"}