Install a sample scenario: its Wiki space (with the caller’s forwarded credentials), then its Project Tracker initiative, project and full example subtree, in one transaction under the scenario’s advisory lock

POST 
/api/sample-scenarios/:scenarioId

Install a sample scenario: its Wiki space (with the caller’s forwarded credentials), then its Project Tracker initiative, project and full example subtree, in one transaction under the scenario’s advisory lock. Idempotent — a second call answers already_installed and writes nothing. A failure after the Wiki installed removes the Wiki slice again; if that removal fails too, the next install converges on the Wiki slice left behind. Requires projects.create, initiatives.create and tasks.create.

Request

Responses

200

OK — the example was already installed (outcome: already_installed). Same body as the 201.

201

Successful response

400

The body names a different scenario than the path, or none in the catalog

401

Unauthorized — authentication credentials are missing or invalid

403

The caller lacks an install permission, in Project Tracker or the Wiki

409

The organisation already has STANDARD projects, a reserved key prefix or the example’s cycle window is taken, the Wiki holds a conflicting space, or another change to this example is in progress

503

The Wiki or file storage is unavailable