Topolo Docs Topolo Platform
Open workspace

Create dimension value

Add one selectable code and name to a tracking dimension.

Outcome

Add one selectable code and name to a tracking dimension.

Before you start

  • Verify the intended environment, authenticated identity and specifically approved organization context.
  • The published application permission is settings:write. Discover the exact granted canonical Books workspace and bind it separately from action input.
  • Approve the actual mutation, accounting inputs and any provider/recipient effects before CLI --confirm or MCP confirm:true. Fixture identifiers and simulated provider responses authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_books.dimensions.values.create --detail --json
topolo resources topolo-books --json
topolo workspaces list topolo-books --json
  • Set BOOKS_WORKSPACE_ID to the exact granted workspace returned by discovery.
  • dimensionId: Resolve this exact identifier through the related published reads for the same organization and workspace; never infer it from a name.

Request

POST /api/dimensions/{dimensionId}/values

Inspect and test this action. Save the reviewed input as payload.json; supply credential/resource context separately.

Input fields

FieldRequiredMeaningSchema and constraints
dimensionIdRequireddimension Id{"type":"string","minLength":1}
codeRequiredcode{"type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9._-]{0,59}$"}
nameRequiredname{"type":"string","minLength":1,"maxLength":120}

Inspect nested fields and the complete input schema.

Effects

  • Adds one active selectable code and name to a tracking dimension.

Interpret the response

Read $.value.id for the returned dimension_value identifier. Empty collections and nullable fields do not discover a target.

Call app_topolo_books.dimensions.list and confirm the value under its dimension.

Inspect the success schema. CLI/MCP add their own transport envelope; CLI --detail requests the full result.

Worked examples

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.

Run a reviewed request

Save the input from the selected worked example as payload.json. Validate and inspect the plan before calling the action; refused examples demonstrate errors and are not instructions to execute.

CLI:

topolo actions validate app_topolo_books.dimensions.values.create --data @payload.json --json
topolo actions plan app_topolo_books.dimensions.values.create --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_books.dimensions.values.create --resource-type workspace --resource-id "$BOOKS_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments for the first successful example:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_books.dimensions.values.create",
    "input": {
      "dimensionId": "dim_456ddc9670304180a235d531a75f9e69",
      "code": "LON",
      "name": "London"
    },
    "resourceType": "workspace",
    "resourceId": "<exact granted workspace id>",
    "confirm": true,
    "detail": true
  }
}

Successful response · HTTP 201

Input · payload.json:

{
  "dimensionId": "dim_456ddc9670304180a235d531a75f9e69",
  "code": "LON",
  "name": "London"
}

Captured response · HTTP 201

{
  "value": {
    "id": "dimv_a2eaf135d804488197305559cda19f89",
    "dimension_id": "dim_456ddc9670304180a235d531a75f9e69",
    "code": "LON",
    "name": "London",
    "status": "active",
    "created_at": "2026-10-05T19:42:58.239Z",
    "updated_at": "2026-10-05T19:42:58.239Z"
  }
}

HTTP 201. Call app_topolo_books.dimensions.list and confirm the value under its dimension.

Refused response · auth_error

Input · payload.json:

{
  "dimensionId": "dim_7f3c1b",
  "code": "SALES",
  "name": "Sales"
}

Captured response · HTTP 401

{
  "error": "API key validation failed"
}

HTTP 401. SDK error code auth_error. Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

Verify the result

  • Call app_topolo_books.dimensions.list and confirm the value under its dimension.

Errors and recovery

  • auth_error (HTTP 401): Authenticate in the intended organization again. Verify whoami and the exact Books application/workspace binding before retrying; do not switch identity to work around a refusal.

These are observed local refusals. Shared authentication, schema validation and resource authorization can also refuse before the route. Preserve the actual error, details and request id.

Recovery boundary

Archive the returned valueId under its dimensionId.

  • List tracking dimensions: List active tracking dimensions and their selectable values, or include archived records for settings and historic journal display.
  • Archive dimension value: Archive a value so new journal lines cannot select it; existing lines retain the stored tag.

Evidence

Actual Books route handlers and the exported Worker were exercised against five local SQLite D1 concern databases with all committed migrations, the real posting Durable Object and local R2. Route captures use synthetic verified Auth; Worker captures use synthetic Auth transports. Nexus, Brand, Notify, Pay, Mercury and Xero responses are explicitly simulated at the provider transport boundary. Captures prove local request/response behavior and canonical SDK projection, not live bank access, payment movement, email delivery, provider eligibility, tax compliance, encrypted custody, scheduled execution, deployment or production completion. Fixture identities, credentials, addresses and records authorize no live operation.