readiness

Create an org readiness criterion

Requires org.compliance.manage. An ai criterion cannot be required (400 AI_CRITERION_CANNOT_BE_REQUIRED); an auto criterion needs an autoRule.

post/readiness/criteria

Request

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

Headers

X-Organization-Idstring required

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

Request body

categorystring required
titlestring required
descriptionstring nullable
requiredboolean
transition'COMPLETE' | 'ARCHIVE'
appliesToProjectType'STRATEGIC' | 'OPERATIONAL' nullable

Null = every project

applicabilityHintstring nullable
defaultOwnerRolestring nullable
orderinteger
activeboolean
checkKind'auto' | 'manual' | 'ai'
autoRule'all_tasks_done' | 'no_open_blocked_tasks' | 'all_milestones_complete' | 'no_unresolved_issues' | 'custom_field_set' | 'budget_set' | 'baseline_captured' | 'closeout_signed_off' nullable
autoRuleParamsobject nullable

Response

Criterion created

Changes

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