readiness

Resolve a project's completion readiness

Returns { projectId, projectType, transition, source, items, requiredGaps, hiddenItemCount, waivers, ready, mode, lastCheck }. mode is the effective enforcement mode, waivers the active waivers (a waived item carries waiverId and is never a gap), lastCheck the latest recorded check or null. Applicability is decided live: active criteria for every project type plus those for this project's type. auto items carry outcome (pass | fail | unknown) and detail, recomputed on every call; manual and ai items carry their stored status (NOT_STARTED | IN_PROGRESS | DONE | NA), created on first read. Only a required, non-ai item that fails (auto) or is not DONE or NA (manual) is a gap; unknown never is. Any caller who can read the project.

get/readiness/projects/{id}

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/readiness/projects/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Project id

Query parameters

transitionstring

COMPLETE (default) | ARCHIVE

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Response

Project readiness

Changes

No recorded changes to this operation across all 1 revision of this API.