Skip to content

Get authority workspace design

POST /api/v1/workspace/design/authority/read: request fields and declared response contract.

POST/api/v1/workspace/design/authority/read

Authorization
Permissionsettings.read
Workspace scoperequired
Scope targetworkspace

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.schemaVersionnumberrequirednon-null—
data.workspaceIdstringrequirednon-null—
data.revisionintegerrequirednon-null—
data.authorityunknownrequirednon-null—
data.provenanceobjectoptionalnon-null—
data.provenance.repositorystringoptionalnon-null—
data.provenance.refstringoptionalnon-null—
data.provenance.sourceDigeststringoptionalnon-null—

Declared failures

Declared failures
WORKSPACE_DESIGN_AUTHORING_UNAVAILABLE404 — not retryable

Readback

This method returns the current state it read.

  • workspace.design.authority.read

Request example

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

POST /api/v1/workspace/design/authority/read HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>