Get a canon identifier class

Canon module

GET/canon/identifier-classes/{class}canonIdentifierClasses.get

Identifier grammar: identifier, code or token (Section 3.6). Returns one canon identifier class with its `ETag`. A canon identifier 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

canonIdentifierClasses.get: Path and query parameters
Field	Type	Required	Description
class	string	Yes	Identifier class.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: CanonIdentifierClass

canonIdentifierClasses.get: CanonIdentifierClass
Field	Type	Required	Description
class	string	Yes	Identifier class.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
issued_by	string	Yes	Who issues it.Constraints: length 1 to 300
scope	string	Yes	Where it is unique.Constraints: length 1 to 300
is_mutable	boolean	Yes	Whether it may change.
rule	string	Yes	Rule.Constraints: length 1 to 20000
examples	string	Yes	Examples.Constraints: length 1 to 300

{
  "class": "identifier",
  "issued_by": "An external authority",
  "scope": "Global",
  "is_mutable": false,
  "rule": "Recorded and validated, never minted.",
  "examples": "GTIN, MPN, UNSPSC"
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/identifier-classes/identifier" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonIdentifierClasses.get("identifier");

response = xos.canon_identifier_classes.get("identifier")

xos canon-identifier-classes get identifier