List canon permit rule rows
Canon module
GET/canon/permit-rulescanonPermitRules.list
A permit rule of the jurisdiction permit engine. Returns a cursor page of canon permit rule rows the caller may see. The default order is `rule` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of CanonPermitRule
| Field | Type | Required | Description |
|---|---|---|---|
| rule | string | Yes | Rule name.Constraints: length 1 to 200 |
| trigger_type | string | Yes | What triggers the rule.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| condition | string | Yes | Trigger condition.Constraints: length 1 to 20000 |
| permit | string | Yes | Permit required.Constraints: length 1 to 300 |
| ahj | string | Yes | Authority having jurisdiction.Constraints: length 1 to 300 |
| lead_time | string | Yes | Typical lead time.Constraints: length 1 to 300 |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| provenance | Provenance | Yes | Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Constraints: pattern ^[a-z]+$ |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"data": [
{
"rule": "Assembly occupancy",
"trigger_type": "threshold",
"condition": "Occupant load of 50 or more.",
"permit": "Certificate of occupancy",
"ahj": "City Building and Fire",
"lead_time": "4-8 wks",
"jurisdiction_id": "US-FL",
"provenance": "operator",
"note": "Triggered by occupant load."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/canon/permit-rules" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonPermitRules.listAll()) {
console.log(row);
}for row in xos.canon_permit_rules.list_all():
print(row)xos canon-permit-rules list --all