Saltar al contenido

List reconciliation line rows

Módulo Places

GET/reconciliation-linesreconciliationLines.list

One requirement's reconciliation result. Returns a cursor page of reconciliation line rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad advancing.packet.read.
  • Alcances de OAuth: advancing.
  • 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

reconciliationLines.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 ReconciliationLine

reconciliationLines.list: ReconciliationLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the reconciliation line.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
reconciliation_idstring (uuid)SíIdentifier of the reconciliation.
requirement_idstring (uuid)SíIdentifier of the requirement.
capability_idstring (uuid) | nullSíIdentifier of the matching capability.
resultReconciliationResultSíRequirement against capability result. Unknown against a critical requirement is a gap at gate 3.Restricciones: one of "Met", "Gap", "Unknown"
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "reconciliation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "capability_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "result": "Met"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/reconciliation-lines" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.reconciliationLines.listAll()) {
  console.log(row);
}
for row in xos.reconciliation_lines.list_all():
    print(row)
xos reconciliation-lines list --all