Get a std document

Módulo Canon

GET/canon/std/document-library/{record_id}canonStdDocumentLibrary.get

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

canonStdDocumentLibrary.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: StdDocument

canonStdDocumentLibrary.get: StdDocument
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}$
document_name	string \| null	Sí	Document name.Restricciones: length 1 to 500
document_type	string \| null	Sí	Document type.Restricciones: length 1 to 200
reference_id	string \| null	Sí	Reference identifier.Restricciones: length 1 to 200
file_format	string \| null	Sí	File format.Restricciones: length 1 to 100
version	string \| null	Sí	Version.Restricciones: length 1 to 100
issue_date	string (date) \| null	Sí	Issue date.
expiration_date	string (date) \| null	Sí	Expiration date.
department	string \| null	Sí	Department as the sheet names it.Restricciones: length 1 to 200
category	string \| null	Sí	Category code or name as the sheet gives it.Restricciones: length 1 to 200
sub_category	string \| null	Sí	Sub-category as the sheet names it.Restricciones: length 1 to 200
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
organization	string \| null	Sí	Organization as the sheet names it.Restricciones: length 1 to 200
project	string \| null	Sí	Project as the sheet names it.Restricciones: length 1 to 200
file_size	string \| null	Sí	File size as the sheet gives it.Restricciones: length 1 to 100
storage_url	string \| null	Sí	Where the file is stored, as the sheet gives it.Restricciones: length 1 to 2000

{
  "record_id": "SOP-001",
  "document_name": "Venue Load-In Guide",
  "document_type": "Guide",
  "reference_id": "DOC-004",
  "file_format": "PDF",
  "version": "v2.0",
  "issue_date": "2026-10-08",
  "expiration_date": "2026-10-08",
  "department": "5000 Production",
  "category": "5000.05.02",
  "sub_category": "Overhead Rigging",
  "status": "Active",
  "notes": "Primary life safety and incident response",
  "organization": "GHXSTSHIP",
  "project": "CSMIA26",
  "file_size": "48.5 MB",
  "storage_url": "https://files.example/doc-001.pdf"
}

Ejemplos de código

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

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

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

xos canon-std-document-library get SOP-001