Skip to content

Read laboratory workbenches

GET /api/v1/laboratory/workbenches/{workbenchId}: request fields and declared response contract.

GET/api/v1/laboratory/workbenches/{workbenchId}

Authorization
PropertyValue
Permissionlaboratory.method.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
workbenchIdstringrequirednon-null—
Query parameters
FieldTypeRequiredNullableDefault
revisionintegeroptionalnon-null—

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.documentobjectrequirednon-null—
data.document.workbenchIdstringrequirednon-null—
data.document.titlestringrequirednon-null—
data.document.objectivestringrequirednon-null""
data.document.graphobjectrequirednon-null—
data.document.graph.schemaVersionnumberrequirednon-null—
data.document.graph.nodesarrayrequirednon-null—
data.document.graph.edgesarrayrequirednon-null—
data.acceptanceobjectrequirednon-null—
data.acceptance.policyDigeststringrequirednon-null—
data.acceptance.capabilityDigeststringrequirednon-null—
data.acceptance.readinessobjectrequirednon-null—
data.acceptance.readiness.authorablebooleanrequirednon-null—
data.acceptance.readiness.executablebooleanrequirednon-null—
data.acceptance.readiness.reasonsarrayrequirednon-null—
data.acceptance.resolvedReferencesarrayrequirednon-null—
data.revisionintegerrequirednon-null—
data.parentRevisionintegerrequirednullable—
data.digeststringrequirednon-null—
data.sealDigeststringrequirednon-null—
data.createdAtstringrequirednon-null—
data.createdBystringrequirednon-null—

Declared failures

Declared failures
PropertyValue
ACCESS_DENIED403 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
NOT_FOUND404 — not retryable
SETUP_REQUIRED503 — not retryable
VALIDATION_ERROR400 — not retryable
VALIDATION_INPUT_ERROR400 — not retryable

Readback

This method returns the current state it read.

  • laboratory.workbenches.read

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/laboratory/workbenches/{workbenchId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>