Get a column's written rule
well_get_column_ruleRead the written rule of one column: the context note stored for (target_object, target_column), resolved for the agent audience — the system note, with the workspace's own override sections applied on top.
rule.text is the resolved note, the same text the web app and the mapping prompt read. rule.source says whose text answers: system when only the standard note exists, workspace when the workspace wrote its own section over it. rule.context_hash identifies exactly the text returned. There is no rule when no context note exists at all: then the column has no written rule and you must say so rather than compose one.
The rule of one category value — what goes in "Bank fees" and what never does — is the per-value line inside the note of transactions.category_key, not a note of its own: call with target_object "transactions" and target_column "category_key", then quote only the lines that name the asked value.
Writes nothing.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| target_column | Yes | The column whose written rule is read, as its MikroORM property name such as `category_key`. | |
| target_object | Yes | The object the column belongs to, an entity table name such as `transactions`. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rule | No | ||
| error | No | ||
| success | Yes | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |