Project
Included from Basic tier
A project is the top of an estate subtree ("/projects/web"): environments,
assets, workflows, triggers and git remotes all live beneath one, and its
owned properties and settings documents seed the merge for everything
under it. Every project holds environments, project-level assets and
entities (the former Standard/Enterprise project_type is retired: the
attribute is still accepted on create and update and ignored, and it no
longer appears in responses; the licence assets feature and limit are
the only gate on asset creation). Update semantics preserve unset fields and toggle
archive/restore; delete soft-deletes the subtree. Served by the v2
ProjectService (ListProjects, GetProject, CreateProject,
UpdateProject, DeleteProject).
Project
Project is the typed project read shape: the v1 node serializer's project attributes plus the owned-document ids and the per-node authorisation summary the GUI consumes.
| Field | Type | Meaning |
|---|---|---|
archived | boolean | Whether the project is archived. Toggled through UpdateProject; a no-op toggle, or archiving while changes are active, refuses. |
changes_execute | boolean | May the caller execute changes under this node (execute on |
code | string | The record's code. |
created_by | string | Username of the creating identity. |
description | string | "" when never set. |
id | string | The record's identity. |
maintenance | NodeMaintenanceBadge | The active-maintenance badge; unset while the node is open (the v1 maintenance attribute). |
name | string | Display name. |
node_path | string | The project's node path, e.g. "/projects/web". |
properties_id | string | The project's owned properties/settings document ids. |
settings_id | string | The project's owned settings document id (the pair of properties_id). |
ProjectFilter
ProjectFilter is the typed projects predicate vocabulary. All fields combine with AND; unset fields do not restrict.
| Field | Type | Meaning |
|---|---|---|
archived | boolean | Keep only archived (true) or unarchived (false) projects; unset keeps both (the v1 filter[archived_eq] contract). |
Related pages
opschain docs resources/environment— the nodes beneath a project.opschain docs resources/node— the generic hierarchy read the project row specialises.opschain docs resources/settings— the owned settings document and its merge.