Resources
Resources describe the platform objects you manage with the CLI.
75 resources
| Name | Description |
|---|---|
ai_adapter | A configured AI adapter — an LLM provider or ML backend the tenant can run inference against. The API key is withheld; everything else is readable. |
ai_agent | A reusable AI agent persona definition for LLM-driven workflow tasks |
archive_job | A scheduled, Lua-driven archive job: it runs a script on a cron schedule and writes the resulting rows to a storage backend under a rendered key. |
business_unit | An organizational unit that can contain cost centers. Supports hierarchical structure via parentId. |
capability | A capability that a work center can perform |
carrier | A shipping carrier |
concept | A node in the tenant's knowledge ontology — a reusable idea (a capability, material, technique…) that knowledge notes can attach to and that the graph links to the entities exhibiting it. |
conditional_iam_policy | Revision-checked conditional policy contract for IaC; uses the same IAM policy storage and attachment IDs. |
conditional_iam_policy_attachment | Attachment with a typed reference to a conditional IaC policy; uses existing attachment ownership semantics. |
controller | An IoT controller that manages devices |
controller_policy | Per-controller IO/exec allowlists pushed alongside edgeApps on config.update (hybrid-bridge §35). Default-deny on first boot — a controller with no policy row receives empty lists, which the bridge treats as 'reject everything'. |
cost_category | A global cost category that spans all business units for consolidated reporting (e.g., Labor, Material, Overhead, Service) |
cost_center | A cost center within a business unit for tracking costs and profitability |
cost_rate | A versioned cost rate with date-range based validity. Supports audit trail via version linking. |
custom_app | A custom app with embedded Vue components |
custom_app_version | An immutable snapshot of a custom app at a specific version |
custom_workflow_action | A tenant-defined action backed by a Script, invocable from workflows and the UI. |
dashboard | A simple monitoring board: cards showing metrics, charts, tables or text. Built by a technical team for its own use. A dashboard only displays — it has no actions and runs no mutations. For a surface an end user works in, with one-tap actions, use a Workspace instead. |
dashboard_card | A card within a dashboard — one metric, chart, table, block of markdown, or embedded custom app. Cards display; they take no actions. |
data_clip | A saved MicroSQL reporting query that can be re-run in-app or exported publicly as JSON/CSV/NDJSON via its share token. Scoped to a single tenant. |
data_schema | A data schema defining the structure of a custom data table |
device | An IoT device |
edge_app | Write-authorized EdgeApp source view; kept separate from the redacted read model |
edge_app_installation | A edgeApp template installed on a single controller (with per-install variables and secrets) |
existing_capability | Read-only reference to an existing visible capability, for portable IaC assignments. |
external_schema | An uploaded external API schema (OpenAPI, Swagger, JSON Schema) |
folder | A tenant-scoped, named storage location: a name bound to exactly one transport plus a root path/prefix within it, so files, workflow nodes and scripts can choose *where* bytes live without knowing *how* they get there. The binding is flattened here to a kind discriminator plus the at-most-one matching reference ID. |
iam_policy | An IAM policy that can be attached to users |
iam_policy_attachment | Policy attachment owned independently of its user and policy |
inbox_folder | A mailbox intake configuration. Runtime activation is separate from editing. |
incoming_webhook | An incoming webhook endpoint configuration |
integration | An integration: the parent of its immutable definition versions and the pointer to the current one |
integration_definition | An integration definition (immutable, versioned) |
integration_instance | An integration instance (live installation of a definition) |
journey | An instance-served journey: a guided, multi-step workflow the runner executes. The container record joined with the version it currently serves (published when one exists, else the open draft). Who may see and author it is decided by `scope`. |
journey_version | One immutable-once-published snapshot of a journey definition. The authoring history returned by `listJourneyVersions`. |
knowledge_note | A single piece of situational knowledge — a fact, caveat, or tip — attached to a concept or a specific entity, and reachable through the knowledge graph from related entities. |
mcp_tool | Tenant-defined Lua tool with assignment-scoped MCP invocation. |
ml_model_config | ML model configuration for training pipelines |
network | A network grouping IoT controllers, devices, and databases |
notification_group | A notification group containing one or more recipients |
notification_recipient | A notification recipient with delivery configuration |
operation_cost_mapping | Maps an operation kind to a cost category with cost type for automated costing |
portal | A customer-facing web Portal: its address, IAM ceiling and audience-to-site routing. |
portal_site | One site of a Portal. It serves whichever immutable source version is published. |
portal_site_version | An immutable source snapshot of a site. Publishing one makes it the served version; publishing an older one rolls back. |
price_bracket | A quantity-band pricing rule for a specific scope |
product | A priced catalogue entry — what a customer is sold and charged for. Referenced by estimate and order lines, which take their price, quantity and kinds from it. Distinct from `product_template`, which is the manufacturing blueprint describing how a job is built: a product says what to charge, a template says what to make. |
product_template | A reusable product template that can be instantiated into jobs |
production_cell | A production cell grouping work centers |
protobuf_schema | A tenant-scoped protobuf schema used by scripts to decode binary payloads |
report | A reusable report with an editable draft and immutable published versions. |
script | A Lua script for the sandboxed scripting environment |
service_account | A user account in the system |
shift_definition | A reusable shift template — a start/end clock time and the weekdays it recurs on. Tenant-scoped; work centers reference it via their shift profiles rather than restating times. |
storage_backend | A configured storage destination for a tenant (archives, transfers, folder bindings). Credentials are never returned; each backend kind's block exposes a hasCredentials flag instead. |
substrate | A substrate/media definition for printing |
substrate_template_line | A BOM rule: how much of a substrate a product template requires per 100 finished copies |
supplier | A supplier entity representing a vendor or service provider |
task_definition | A reusable task definition template with custom outcome options |
tax_code | A tax rate configuration (e.g. Standard VAT, Zero-Rated, Exempt) |
team | A team grouping users for task assignment and collaboration |
team_membership | An individually managed team membership |
template | A template for rendering data into text or PDF output |
user | Read-only existing non-BOT user identity; IaC never owns this account |
warehouse_location | A warehouse location (warehouse, zone, aisle, rack, shelf, bin, etc.) |
work_center | A work center (machine, person, tool, or location) |
work_center_capability | A capability assigned to a work center with optional constraints |
work_center_device | Binds a work center to a controller device it can be communicated through |
work_center_shift_profile | A shift profile assigning a shift definition to a work center for a validity period |
workflow | A workflow definition that can have multiple versions |
workflow_trigger | A trigger configuration for automated workflow execution |
workflow_version | Source-only workflow version authoring contract |
workspace | An instance-served workspace: the container record joined with the relevant version's definition (the published version when published, else the open draft). A workspace is the standing surface a role works in — panels of live data plus one-tap actions that run mutations as the signed-in user. For a technical team's own monitoring board, with no actions, use a Dashboard instead. |
workspace_version | One immutable version of a workspace's definition. Versions form the authoring history; `listWorkspaceVersions` returns them newest first. |