Saltar al contenido

List gate evidence rows

Módulo Projects

GET/gate-evidencegateEvidence.list

Evidence for a gate criterion. One evidence spine serves every criterion. Returns a cursor page of gate evidence rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

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

gateEvidence.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 GateEvidence

gateEvidence.list: GateEvidence
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the gate evidence.
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.
project_idstring (uuid)SíIdentifier of the project.
criterion_idCriterionIdSíGate criterion identifier from `xpms.dim_gate_criterion`.Restricciones: pattern ^G[1-9]\.[A-Z0-9_]+$
record_idstring (uuid) | nullSíIdentifier of the record that evidences the criterion.
attested_bystring (uuid) | nullSíIdentifier of the person who attested the evidence.
attested_atstring (date-time)SíWhen the evidence was attested.
assertion_rankintegerSíAssertion rank of the evidence, 0 to 4.Restricciones: range 0 to any
evidence_uristring | nullSíWhere the evidence lives: a document or record URI.Restricciones: length 1 to 2000
notestring | nullSíNote on the evidence.Restricciones: length 1 to 2000
{
  "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",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "criterion_id": "G1.BUDGET_ENVELOPE",
      "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "attested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "attested_at": "2026-10-08T14:30:00Z",
      "assertion_rank": 4,
      "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "note": "Signed by the venue manager."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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