projects

Create a new project

post/projects

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/projects
  • 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

namestring required
descriptionstring
startDatestring date-time

Optional. Defaults to today (localDate when sent), or to endDate when that is already past

endDatestring date-time

Optional. Defaults to startDate + 90 days

localDatestring date

The caller's own calendar day (YYYY-MM-DD), used as "today" for the date defaults only

statusDatestring date nullable

Status date (as-of) for progress reporting; null clears

status'PLANNING' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED'
budgetnumber

Response

Project created

idstring uuid required
namestring required
status'PLANNING' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED' required
progressinteger required
budgetnumber nullable
startDatestring date-time nullable
endDatestring date-time nullable
statusDatestring date nullable

The "as of" date for progress reporting; null means today

autoScheduleboolean

Automatic scheduling. False: editing a date or adding a link moves no other task; only Recalculate writes the dates the scheduler works out. Set with PUT /scheduling/projects/{id}/auto-schedule.

parentDatesFromSubtasksboolean

The default for a task with subtasks: true takes its start and due dates from them, unless the task's own isManual says otherwise. Read only while the server switch parent_date_rollup_enabled is on. Set with PUT /scheduling/projects/{id}/parent-dates.

organizationIdstring uuid required

Changes

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