Saltar al contenido

Get a canon ratification

Módulo Canon

GET/canon/ratifications/{subject}canonRatifications.get

A ratification record. 4.0 grammar is proposed until a named ratifier is recorded. Returns one canon ratification with its `ETag`. A canon ratification 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

canonRatifications.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
subjectstringSíWhat was ratified.Restricciones: length 1 to 300
fieldsFieldsNoSparse 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: CanonRatification

canonRatifications.get: CanonRatification
CampoTipoObligatorioDescripción
subjectstringSíWhat was ratified.Restricciones: length 1 to 300
ratifierstringSíNamed ratifier.Restricciones: length 1 to 300
ratified_atstring (date-time)SíWhen it was ratified.
notestring | nullSíRatification note.Restricciones: length 1 to 4000
{
  "subject": "4.0 phase grammar",
  "ratifier": "Canon Ratifier",
  "ratified_at": "2026-10-08T14:30:00Z",
  "note": "Ratified at the canon review."
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/ratifications/4.0%20phase%20grammar" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.canonRatifications.get("4.0 phase grammar");
response = xos.canon_ratifications.get("4.0 phase grammar")
xos canon-ratifications get 4.0 phase grammar