Get a canon facet
Canon module
GET/canon/facets/{facet}canonFacets.get
A facet carried from canon. Returns one canon facet with its `ETag`. A canon facet 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 |
|---|---|---|---|
| facet | string | Yes | Facet name.Constraints: length 1 to 200 |
| 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: CanonFacet
| Field | Type | Required | Description |
|---|---|---|---|
| facet | string | Yes | Facet name.Constraints: length 1 to 200 |
| form | string | null | Yes | Form of the facet.Constraints: length 1 to 300 |
| rolls_up_to | string | null | Yes | What the facet rolls up to.Constraints: length 1 to 200 |
| since | string | null | Yes | Version that introduced it, as written in canon.Constraints: length 1 to 64 |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"facet": "Phase",
"form": "Nine gated phases",
"rolls_up_to": "Act",
"since": "3.0",
"note": "Carried from canon."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/facets/Phase" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonFacets.get("Phase");response = xos.canon_facets.get("Phase")xos canon-facets get Phase