Archive project
archive_projectFreeze a project and its tasks with a reason, filing an archived case entry. Later changes are refused until the project is restored.
Instructions
Archives a project with a reason and files an archived entry in its case.
The project and its tasks freeze as they are: statuses stay, open tasks need no
closing. From then on any change in the project or its tasks — a new task, an
entry, a transition, an edit, an attribute, a new link — is refused with
project_archived, until restore_project. The one change still accepted is
unlink of a link with its task: an open archived task keeps blocking its
blocked_by tasks and holding its parent until the link is removed. Reads work
as before.
An already archived project is refused with project_archived.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | Project key, case-insensitive. An unknown key is refused with `project_not_found` | |
| reason | Yes | Why the project is archived or restored; a blank one is refused with `project_reason_required`. Filed in the `archived` or `restored` entry of the project's case |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| no | Yes | Number of the `archived` or `restored` entry in the project's case | |
| key | Yes | ||
| archived_at | Yes | When the project was archived; `null` once it is restored |