Read one clause
get_clauseRead-only
Read one clause by its key, with where it sits and what sits beneath it.
Use it when a search result points at another clause, or when you need the whole of an article rather than the part that matched. The call is recorded, with the key that was read rather than a question.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | A canonical key, such as gdpr:art-17:para-1 | |
| lang | No | Which language to prefer, as a two letter code | en |
| as_of | No | Read the clause as it stood on this date | |
| whole_subtree | No | Also return this clause and everything beneath it in reading order, which is what you want for a whole article |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| now | No | For a policy's clause read in a version that is no longer in force, where the same rule is in the version in force. A policy's keys follow its printed numbers, so the rule may have another key now | |
| clause | Yes | ||
| subtree | No | This clause and everything beneath it in reading order, when asked for | |
| children | Yes | The clauses directly beneath this one | |
| formerly | No | Set when this key named a different rule in the policy's version before | |
| cross_references | Yes | Keys this clause's own words point at |