Get a canon team
Módulo Canon
GET/canon/teams/{team_id}canonTeams.get
A canon team: a tag that rolls up to a department, never a tree level. Returns one canon team with its `ETag`. A canon team 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| team_id | TeamId | Sí | Canon team identifier from `xpms.dim_team`.Restricciones: pattern ^[0-9]000-T[0-9]{2}$ |
| 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: CanonTeam
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| team_id | TeamId | Sí | Canon team identifier from `xpms.dim_team`.Restricciones: pattern ^[0-9]000-T[0-9]{2}$ |
| team | string | Sí | Team name.Restricciones: length 1 to 200 |
| dept_code | DeptCode | Sí | Department class code from `xpms.dim_department` (Section 3.2).Restricciones: pattern ^[0-9]000$ |
| workgroup_tag | string | null | Sí | Workgroup tag.Restricciones: length 1 to 300 |
| lead_role | string | null | Sí | Lead role of the team.Restricciones: length 1 to 300 |
| responsibilities | string | null | Sí | What the team is responsible for.Restricciones: length 1 to 4000 |
{
"team_id": "4000-T01",
"team": "Executive Leadership",
"dept_code": "4000",
"workgroup_tag": "FOH",
"lead_role": "Production Manager",
"responsibilities": "Front of house operations."
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/teams/4000-T01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonTeams.get("4000-T01");response = xos.canon_teams.get("4000-T01")xos canon-teams get 4000-T01