Saltar al contenido

List canon touchpoint discipline rows

Módulo Canon

GET/canon/touchpoint-disciplinescanonTouchpointDisciplines.list

A discipline that delivers a touchpoint. Returns a cursor page of canon touchpoint discipline rows the caller may see. The default order is `touchpoint_id` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad canon.taxonomy.read.
  • Alcances de OAuth: canon.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonTouchpointDisciplines.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de CanonTouchpointDiscipline

canonTouchpointDisciplines.list: CanonTouchpointDiscipline
CampoTipoObligatorioDescripción
touchpoint_idTouchpointIdSíFive-sense touchpoint identifier from `xpms.dim_touchpoint`.Restricciones: pattern ^[A-Z]{3}-[0-9]{2}$
disc_codeDiscCodeSíDiscipline code `DDDD.DD` from `xpms.dim_discipline`. Canon holds .01 to .49; tenant extensions hold .50 to .99.Restricciones: pattern ^[0-9]000\.[0-9]{2}$
{
  "data": [
    {
      "touchpoint_id": "SGT-01",
      "disc_code": "4000.01"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/touchpoint-disciplines" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.canonTouchpointDisciplines.listAll()) {
  console.log(row);
}
for row in xos.canon_touchpoint_disciplines.list_all():
    print(row)
xos canon-touchpoint-disciplines list --all