Get a std vendor entitlement

Módulo Canon

GET/canon/std/vendor-entitlements/{record_id}canonStdVendorEntitlements.get

A vendor or sponsor entitlement. Standard Library row, copied into each new org as editable org data. Returns one std vendor entitlement with its `ETag`. A std vendor entitlement 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

canonStdVendorEntitlements.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
record_id	StdCode	Sí	Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
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: StdVendorEntitlement

canonStdVendorEntitlements.get: StdVendorEntitlement
Campo	Tipo	Obligatorio	Descripción
record_id	StdCode	Sí	Natural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
vendor_class	string \| null	Sí	Vendor class the entitlement is for.Restricciones: length 1 to 100
module	string \| null	Sí	Module the class may use.Restricciones: length 1 to 200
permitted	boolean \| null	Sí	Whether the class may use the module.
status	string \| null	Sí	Row status in the sheet.Restricciones: length 1 to 200
notes	string \| null	Sí	Notes in the sheet.Restricciones: length 1 to 20000

{
  "record_id": "SOP-001",
  "vendor_class": "VCL-001",
  "module": "Advance",
  "permitted": true,
  "status": "Active",
  "notes": "Primary life safety and incident response"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/std/vendor-entitlements/SOP-001" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonStdVendorEntitlements.get("SOP-001");

response = xos.canon_std_vendor_entitlements.get("SOP-001")

xos canon-std-vendor-entitlements get SOP-001