Inspect process frameworks
POST /api/v1/process-frameworks/inspect: request fields and declared response contract.
POST/api/v1/process-frameworks/inspect
| Permission | settings.read |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Request body
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| authority | unknown | required | non-null | — |
| frameworkKey | string | required | non-null | — |
| releaseKey | string | required | non-null | — |
Response
201
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.asset | string | required | non-null | — |
| data.authority | unknown | required | non-null | — |
| data.family | object | required | non-null | — |
| data.family.id | string | required | non-null | — |
| data.family.frameworkKey | string | required | non-null | — |
| data.family.label | string | required | non-null | — |
| data.release | object | required | non-null | — |
| data.release.id | string | required | non-null | — |
| data.release.releaseKey | string | required | non-null | — |
| data.release.sourceVersion | string | required | non-null | — |
| data.release.contentDigest | string | required | non-null | — |
| data.release.publicationState | "imported" | "validated" | "published" | "superseded" | required | non-null | — |
| data.release.supersedesReleaseId | string | optional | non-null | — |
| data.release.sourcePolicy | object | required | non-null | — |
| data.release.sourcePolicy.storedFields | array | required | non-null | — |
| data.release.sourcePolicy.disclosedFields | array | required | non-null | — |
| data.levelDefinitions | array | required | non-null | — |
| data.elements | array | required | non-null | — |
Declared failures
| ACCESS_DENIED | 403 — not retryable |
|---|---|
| CORE_ERROR | 500 — not retryable |
| NOT_FOUND | 404 — not retryable |
| VALIDATION_ERROR | 400 — not retryable |
Readback
This method returns the current state it read.
- processFrameworks.inspect
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
POST /api/v1/process-frameworks/inspect HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json
{
"authority": "<authority>",
"frameworkKey": "<frameworkKey>",
"releaseKey": "<releaseKey>"
}