Archive a project
The project Owner or Manager, or org.compliance.manage (403 otherwise). Only a COMPLETED or CANCELLED project (409 PROJECT_NOT_CLOSED); 409 ALREADY_ARCHIVED when it already is. Archive is a flag, not a status: the project keeps its status, is hidden from project lists by default, and refuses any status change (409 PROJECT_ARCHIVED) until unarchived. Runs the readiness gate with transition ARCHIVE under the organization's enforcement mode: in BLOCK a required gap answers 409 READINESS_GAPS { error, code, requiredGaps, checkId, transition }; in WARN the archive goes through and readiness carries the verdict. Audited as PROJECT_ARCHIVED. Returns { projectId, status, archivedAt, archivedBy { id, name } | null, readiness { mode, passed, requiredGaps, checkId, transition } | null }.
Request
- Base URL: https://api.onplana.com/api
- URL: https://api.onplana.com/api/readiness/projects/{id}/archive
- Auth: one of:
- HTTP bearer
- API key in header Authorization
Path parameters
Project id
Headers
UUID of the active organization. Sets org context for all scoped operations.
Response
The archive state
Changes
No recorded changes to this operation across all 1 revision of this API.