Saltar al contenido

Get gate readiness

Módulo Projects

GET/projects/{id}/gate-readinessprojects.gateReadiness

Lists each criterion of the next gate with whether evidence satisfies it. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad projects.gate.read.
  • Alcances de OAuth: projects.
  • Estados de error: 400, 401, 404, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

projects.gateReadiness: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the project.

Respuesta 200: GateReadinessPage

projects.gateReadiness: GateReadinessPage
CampoTipoObligatorioDescripción
dataarray of GateReadinessSíItems on this page, in the documented default order.
next_cursorstring | nullSíOpaque cursor for the next page; null on the last page.
{
  "data": [
    {
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "gate": 3,
      "criterion_id": "G1.BUDGET_ENVELOPE",
      "blocking": true,
      "satisfied": false
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/projects/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/gate-readiness" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.projects.gateReadiness("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.projects.gate_readiness("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos projects gate-readiness 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f