Get a std vendor class

Canon module

GET/canon/std/vendor-classes/{record_id}canonStdVendorClasses.get

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

canonStdVendorClasses.get: Path and query parameters
Field	Type	Required	Description
record_id	StdCode	Yes	Natural code of a Standard Library row (Section 2.1).Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Response 200: StdVendorClass

canonStdVendorClasses.get: StdVendorClass
Field	Type	Required	Description
record_id	StdCode	Yes	Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
class	string \| null	Yes	Vendor class.Constraints: length 1 to 300
description	string \| null	Yes	What the class covers.Constraints: length 1 to 20000
clearance_tier	string \| null	Yes	Clearance tier.Constraints: length 1 to 200
department	string \| null	Yes	Department as the sheet names it.Constraints: length 1 to 200
category	string \| null	Yes	Category code or name as the sheet gives it.Constraints: length 1 to 200
sub_category	string \| null	Yes	Sub-category as the sheet names it.Constraints: length 1 to 200
status	string \| null	Yes	Row status in the sheet.Constraints: length 1 to 200
notes	string \| null	Yes	Notes in the sheet.Constraints: length 1 to 20000

{
  "record_id": "SOP-001",
  "class": "Staging Vendor",
  "description": "Stages, decks and risers.",
  "clearance_tier": "Tier 2",
  "department": "5000 Production",
  "category": "5000.05.02",
  "sub_category": "Overhead Rigging",
  "status": "Active",
  "notes": "Primary life safety and incident response"
}

Code samples

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

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

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

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