Get a std vendor entitlement
Canon module
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.
- 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 |
|---|---|---|---|
| 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: StdVendorEntitlement
| 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}$ |
| vendor_class | string | null | Yes | Vendor class the entitlement is for.Constraints: length 1 to 100 |
| module | string | null | Yes | Module the class may use.Constraints: length 1 to 200 |
| permitted | boolean | null | Yes | Whether the class may use the module. |
| 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",
"vendor_class": "VCL-001",
"module": "Advance",
"permitted": true,
"status": "Active",
"notes": "Primary life safety and incident response"
}Code samples
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