Skip to content

Validate process frameworks

POST /api/v1/process-frameworks/validate: request fields and declared response contract.

POST/api/v1/process-frameworks/validate

Authorization
Permissionproducts.install
Workspace scoperequired
Scope targetworkspace

Request body

Request body fields
FieldTypeRequiredNullableDefault
authorityunknownrequirednon-null—
releaseIdstringrequirednon-null—

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.assetstringrequirednon-null—
data.releaseIdstringrequirednon-null—
data.publicationState"imported" | "validated" | "published" | "superseded"requirednon-null—

Declared failures

Declared failures
ACCESS_DENIED403 — not retryable
CONFLICT409 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
NOT_FOUND404 — not retryable
VALIDATION_ERROR400 — not retryable

Readback

Read the result back with:

  • processFrameworks.inspect

Request example

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

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

{
  "authority": "<authority>",
  "releaseId": "<releaseId>"
}