Get a canon provenance

Módulo Canon

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.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonProvenances.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
provenance	Provenance	Sí	Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Restricciones: pattern ^[a-z]+$
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: CanonProvenance

canonProvenances.get: CanonProvenance
Campo	Tipo	Obligatorio	Descripción
provenance	Provenance	Sí	Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Restricciones: pattern ^[a-z]+$
rank	integer	Sí	Rank, higher wins.Restricciones: range 0 to any
definition	string	Sí	Definition, in sentence case.Restricciones: length 1 to 20000
may_overwrite	string	Sí	What this provenance may overwrite.Restricciones: length 1 to 300
max_confidence	AssertionLabel	Sí	Assertion label from `xpms.dim_assertion_rank` (Section 3.8).Restricciones: pattern ^[A-Z]+$

{
  "provenance": "operator",
  "rank": 80,
  "definition": "A tenant human entering a fact.",
  "may_overwrite": "Any field not canon-locked",
  "max_confidence": "QUOTED"
}

Ejemplos de código

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