examples

# NocoBase v2 — worked examples Three end-to-end scenarios that exercise both surfaces (REST API + `nb` CLI) and demonstrate when to pick each. Each scenario is a self-contained walkthrough. ## Scenarios | # | File | Mix | What it teaches | |---|---|---|---| | 1 | `references/scenarios/create-collection-via-api.md` | API + CLI check | Define a `posts` collection with two fields, write a record, list with a filter, then verify via `nb api data-modeling collections get`. | | 2 | `references/scenarios/run-workflow-via-cli.md` | API + CLI | Run a workflow manually with `POST /api/workflows:execute` (or its `nb api workflow workflows execute` twin), then poll the execution until it leaves the queued/started states. | | 3 | `references/scenarios/enable-plugin-and-create-api-key.md` | CLI + API | Confirm the `api-keys` plugin is enabled with `nb plugin`, create a token via the API, then make an authorised call as the new bot identity. | ## How to use these - Read the matching file when the user asks for a "complete example" or one of the listed flows. - Follow the steps in order — each scenario assumes the previous step succeeded. - Replace placeholders: `${NB_URL}`, `${TOKEN}`, and any collection/workflow names with real values. - If the user requests a related but different scenario, treat the closest scenario as a template and adapt it; do not invent new patterns when an existing one fits. ## Where to look next - For the full HTTP endpoint catalogue → `api-reference`. - For the full `nb` command catalogue → `cli-recipes`. - For schema/field design patterns → `nocobase-data-modeling`. - For workflow internals (nodes, branches, executions) → `nocobase-workflow-manage`. - For ACL on the role attached to a token → `nocobase-acl-manage`.