scheduling

What one edit to one task would move, before it is made

Read-only. Makes the edit on a copy of the project the way a task update writes it, then runs the same schedule calculation and reflow the update would start, and returns every task whose dates would change, the project finish before and after, and who would become overallocated. Writes nothing. apply is the one row to write to make exactly this change (the edited task's dates and constraint, through PUT /tasks/{id} or POST /tasks/bulk-update); null when the edit changes nothing. A typed start becomes Start No Earlier Than and a typed finish Finish No Earlier Than; a Must Start On or Must Finish On keeps its type and moves. Refusals: summaryDates (a summary task), finishBeforeStart, undated (a slip on a task with no dates). Needs read access to the project. Only while the server switch gantt_what_if_enabled is on; off, it answers 404.

post/scheduling/projects/{id}/what-if-preview

Request

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

Path parameters

idstring required

Project UUID

Headers

X-Organization-Idstring required

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

Request body

taskIdstring required
slipDaysinteger

Working days, from the start on screen; negative pulls the task in

newStartstring date
newFinishstring date

Response

The preview, or a refusal

okboolean
refusal'summaryDates' | 'finishBeforeStart' | 'undated'

Only when ok is false

autoScheduleOffboolean

The project's automatic scheduling is off, so only the edited task moves

overallocationsobject[]

Changes

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