Skip to main content
Developer Compliance Workspace1.0.0-beta.1

Save a Compliance workspace revision

Replaces all 16 collections at the supplied revision. Start with the current workspace and preserve unchanged records. The same history, relationship and entitlement checks apply as in the Portal. JSON is limited to 20 MB and saved metadata to 8 MB. Upload up to 20 files, each at most 1 MB, up to 15 MB total. A successful write returns only the new revision.

PUT/api/v1/compliance/workspace

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is compliance:workspace:write. Scopes are independent.

Conditional token scope compliance:evidence:write. Required to change, add, or remove an attachment.

Conditional token scope compliance:trust-access-requests:approve. Required to approve a Trust Center disclosure.

This operation uses 12 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The compliance bulk group shares 15 requests per token and 40 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Set DASHIO_REQUEST_JSON to the path of a prepared JSON request. The examples send that file as written.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Download the complete schema as OpenAPI JSON or OpenAPI YAML.

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

The current revision and all 16 collections, including unchanged records.

revisionintegerRequired

Minimum: 0. Maximum: 9007199254740990.

collectionsobjectRequired

Workspace records keyed by stable collection IDs shared with schema v1 backups.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

The committed revision.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

revisionintegerRequired

Minimum: 1. Maximum: 9007199254740991.

400

Invalid body, collection, workflow transition or relationship.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid developer token is required.

Response headers

WWW-AuthenticatestringOptional

Bearer authentication challenge. A rejected token can include the invalid_token error.

application/json

Uses the same response body schema as HTTP 400.

402

An active Compliance entitlement is required.

application/json

Uses the same response body schema as HTTP 400.

403

Space administration, scope or entitlement limits prevent the write.

application/json

Uses the same response body schema as HTTP 400.

404

Compliance is unavailable.

application/json

Uses the same response body schema as HTTP 400.

408

The request body timed out.

application/json

Uses the same response body schema as HTTP 400.

409

The revision, upload reservation or a record ID conflicts with current state.

application/json

Uses the same response body schema as HTTP 400.

413

The body, saved workspace or uploads exceed the permitted size.

application/json

Uses the same response body schema as HTTP 400.

415

Use application/json.

application/json

Uses the same response body schema as HTTP 400.

429

The Space or token request or upload budget is exhausted. Edge traffic limits can also return 429.

Response headers

RateLimit-LimitintegerOptional

Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.

RateLimit-RemainingintegerOptional

Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.

RateLimit-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.

application/json

Uses the same response body schema as HTTP 400.

503

The write could not be confirmed. Read the current revision before retrying.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?