Get a canon provenance
Canon module
GET/canon/provenances/{provenance}canonProvenances.get
A provenance rank. A lower rank never overwrites a populated higher-rank field. Returns one canon provenance with its `ETag`. A canon provenance the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| provenance | Provenance | Yes | Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Constraints: pattern ^[a-z]+$ |
| 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_]*)*$ |
Response 200: CanonProvenance
| Field | Type | Required | Description |
|---|---|---|---|
| provenance | Provenance | Yes | Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Constraints: pattern ^[a-z]+$ |
| rank | integer | Yes | Rank, higher wins.Constraints: range 0 to any |
| definition | string | Yes | Definition, in sentence case.Constraints: length 1 to 20000 |
| may_overwrite | string | Yes | What this provenance may overwrite.Constraints: length 1 to 300 |
| max_confidence | AssertionLabel | Yes | Assertion label from `xpms.dim_assertion_rank` (Section 3.8).Constraints: pattern ^[A-Z]+$ |
{
"provenance": "operator",
"rank": 80,
"definition": "A tenant human entering a fact.",
"may_overwrite": "Any field not canon-locked",
"max_confidence": "QUOTED"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/provenances/operator" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonProvenances.get("operator");response = xos.canon_provenances.get("operator")xos canon-provenances get operator