Saltar al contenido

Create a gate evidence

Módulo Projects

POST/gate-evidencegateEvidence.create

Evidence for a gate criterion. One evidence spine serves every criterion. Creates a gate evidence. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad projects.gate.evidence.write.
  • Alcances de OAuth: projects.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: GateEvidenceCreate

gateEvidence.create: GateEvidenceCreate
CampoTipoObligatorioDescripción
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) | nullNoIdentifier of the record that evidences the criterion.
assertion_rankintegerSíAssertion rank of the evidence, 0 to 4.Restricciones: range 0 to any
evidence_uristringSíWhere the evidence lives: a document or record URI.Restricciones: length 1 to 2000
notestring | nullNoNote on the evidence.Restricciones: length 1 to 2000
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "criterion_id": "G1.BUDGET_ENVELOPE",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "assertion_rank": 4,
  "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Signed by the venue manager."
}

Respuesta 201: GateEvidence

gateEvidence.create: 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
{
  "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."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/gate-evidence" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","criterion_id":"G1.BUDGET_ENVELOPE","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_rank":4,"evidence_uri":"urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Signed by the venue manager."}'
const { data } = await xos.gateEvidence.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "criterion_id": "G1.BUDGET_ENVELOPE",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "assertion_rank": 4,
    "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "note": "Signed by the venue manager."
  });
response = xos.gate_evidence.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "criterion_id": "G1.BUDGET_ENVELOPE", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "assertion_rank": 4, "evidence_uri": "urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "note": "Signed by the venue manager."})
xos gate-evidence create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","criterion_id":"G1.BUDGET_ENVELOPE","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","assertion_rank":4,"evidence_uri":"urn:xpms:documents:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Signed by the venue manager."}'