Topolo Docs Topolo Platform
Open workspace

List series generation patterns

Returns base and template-specific naming and URL patterns for an existing series within its verified tenant.

Outcome

Returns base and template-specific naming and URL patterns for an existing series within its verified tenant.

Before you start

  • Verify identity, environment and the intended organization before discovery.
  • Discover the published series:read permission and the target policy.
  • Select an accessible canonical Auth workspace and set WORKSPACE_ID to its returned id. Workspace binding is separate from input.

Discover the target

topolo whoami --json
topolo workspaces list topolo-quro --json
topolo actions get app_topolo_quro.series.generation_templates.list --detail --json
  • id: Exact returned series or export id converted to a string. Discover series through series.list; retain export ids from exports.create.

Request

GET /series/{id}/generation-templates

Inspect parameters and test this action.

Input fields

FieldRequiredMeaning
idYesExact returned series or export id converted to a string. Discover series through series.list; retain export ids from exports.create.

Worked examples

Actual exported Quro Worker with local Miniflare D1/KV and every committed app/analytics migration. Auth, service tokens, Nexus, destination probes and platform archival are synthetic responses; outbound fetch is sealed. Notifications remain in the local outbox. No live redirect propagation, QR scan, destination health, provider delivery, archival or production erasure is established.

Save reviewed input as payload.json, replacing fixture identifiers through discovery.

topolo actions validate app_topolo_quro.series.generation_templates.list --data @payload.json --json
topolo actions plan app_topolo_quro.series.generation_templates.list --resource-type workspace --resource-id "$WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_quro.series.generation_templates.list --resource-type workspace --resource-id "$WORKSPACE_ID" --data @payload.json --detail --json

MCP uses the same reviewed input and separately discovered resource binding:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_quro.series.generation_templates.list",
    "input": {
      "id": "1"
    },
    "resourceType": "workspace",
    "resourceId": "ws_quro_fixture"
  }
}
{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_quro.series.generation_templates.list",
    "input": {
      "id": "1"
    },
    "resourceType": "workspace",
    "resourceId": "ws_quro_fixture",
    "detail": true
  }
}

Worked response 1 · HTTP 200

Input · payload.json:

{
  "id": "1"
}

Captured SDK response:

{
  "success": true,
  "data": [
    {
      "id": "numbered",
      "name": "Numbered Sequence",
      "description": "Generate sequentially numbered codes",
      "namePattern": "{series} #{padded}",
      "urlPattern": "https://example.com/{series}/{padded}",
      "suggestedCount": 50,
      "tier": "basic"
    },
    {
      "id": "simple",
      "name": "Simple Names",
      "description": "Basic naming with series prefix",
      "namePattern": "{series} Code {number}",
      "urlPattern": "https://example.com/code/{number}",
      "suggestedCount": 25,
      "tier": "basic"
    }
  ]
}

HTTP 200. Discover the series id first and inspect namePattern/urlPattern placeholders, suggestedCount and tier before generation.

Worked response 2 · HTTP 404 · Series not found

Input · payload.json:

{
  "id": "2"
}

Captured SDK response:

{
  "success": false,
  "error": "Series not found"
}

HTTP 404. Discover the exact record id or slug in the same workspace before retrying.

Worked response 3 · HTTP 200

Input · payload.json:

{
  "id": "3"
}

Captured SDK response:

{
  "success": true,
  "data": [
    {
      "id": "numbered",
      "name": "Numbered Sequence",
      "description": "Generate sequentially numbered codes",
      "namePattern": "{series} #{padded}",
      "urlPattern": "https://example.com/{series}/{padded}",
      "suggestedCount": 50,
      "tier": "basic"
    },
    {
      "id": "simple",
      "name": "Simple Names",
      "description": "Basic naming with series prefix",
      "namePattern": "{series} Code {number}",
      "urlPattern": "https://example.com/code/{number}",
      "suggestedCount": 25,
      "tier": "basic"
    },
    {
      "id": "runner-bibs",
      "name": "Runner Bib Numbers",
      "description": "Generate QR codes for marathon runner bibs",
      "namePattern": "Runner #{padded}",
      "urlPattern": "https://results.marathon.com/runner/{padded}",
      "suggestedCount": 500,
      "tier": "standard"
    },
    {
      "id": "checkpoint-tracking",
      "name": "Checkpoint Tracking",
      "description": "QR codes for checkpoint scanning",
      "namePattern": "Checkpoint {number} - {series}",
      "urlPattern": "https://track.marathon.com/checkpoint/{number}",
      "suggestedCount": 10,
      "tier": "premium"
    }
  ]
}

HTTP 200. Discover the series id first and inspect namePattern/urlPattern placeholders, suggestedCount and tier before generation.

Worked response 4 · HTTP 400 · Invalid series ID

Input · payload.json:

{
  "id": "not-numeric"
}

Captured SDK response:

{
  "success": false,
  "error": "Invalid series ID"
}

HTTP 400. Correct the reviewed payload using inputSchema and the returned handler message.

Verify the result

  • Discover the series id first and inspect namePattern/urlPattern placeholders, suggestedCount and tier before generation.

Errors and recovery

  • HTTP 404 · http_error: Discover the exact record id or slug in the same workspace before retrying.
  • HTTP 400 · http_error: Correct the reviewed payload using inputSchema and the returned handler message.
  • HTTP 401 · auth_error: Authenticate again in the intended environment and organization.
  • HTTP 403 · action_permission_required: Inspect the actual refusal. The action permission and the verified workspace access are both required; a caller cannot name an ungranted workspace.

Inspect the original handler body as well as the SDK error code. These are observed local refusals, not an exhaustive provider-failure list.

Recovery boundary

A missing series requires discovery in the same organization and workspace. Pattern suggestions do not create codes or validate destination reachability.

  • Generate series QR codes: Generates 1–1000 codes using a naming/URL pattern. HTTP 200 can contain partial failures; codes is a preview of at most ten, and error_messages is at most five.

Evidence

Actual exported Quro Worker with local Miniflare D1/KV and every committed app/analytics migration. Auth, service tokens, Nexus, destination probes and platform archival are synthetic responses; outbound fetch is sealed. Notifications remain in the local outbox. No live redirect propagation, QR scan, destination health, provider delivery, archival or production erasure is established.