Skip to content

Create laboratory workbenches

POST /api/v1/laboratory/workbenches: request fields and declared response contract.

POST/api/v1/laboratory/workbenches

Authorization
PropertyValue
Permissionlaboratory.method.publish
Workspace scoperequired
Scope targetworkspace

Request body

Request body fields
FieldTypeRequiredNullableDefault
workbenchIdstringrequirednon-null—
titlestringrequirednon-null—
objectivestringoptionalnon-null""
graphobjectrequirednon-null—
graph.schemaVersionnumberrequirednon-null—
graph.nodesarrayrequirednon-null—
graph.edgesarrayrequirednon-null—

Response

201

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
APPROVAL_REQUIRED403 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
NOT_FOUND404 — not retryable
QUOTA_DENIED429 — retryable
REBASE_CONFLICT409 — not retryable
REVISION_CONFLICT409 — retryable
SETUP_REQUIRED503 — not retryable
VALIDATION_ERROR400 — not retryable
VALIDATION_INPUT_ERROR400 — not retryable

Readback

Read the result back with:

  • laboratory.workbenches.read

Request example

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

POST /api/v1/laboratory/workbenches HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json

{
  "workbenchId": "<workbenchId>",
  "title": "<title>",
  "graph": {}
}