plans

createPlanPhase

Create a phase in a plan. Position and wbs_code are auto-computed. By default a phase's dates follow its tasks (date_mode 'auto'): once any task in it has dates, the phase runs from the earliest task start to the latest task end and stays in step as tasks change, so there is no need to maintain phase dates by hand. Pass fields (for example ["id", "versionTimestamp"]) for a short answer instead of the whole phase.

post/tools/createPlanPhase

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/createPlanPhase
  • Auth: HTTP bearer

Request body

planIdstring required
namestring required
descriptionstring
statusstring

Status: not_started, in_progress, completed, on_hold, cancelled. Default: not_started.

prioritystring

Priority. Default: medium.

positionnumber

Position. Auto-computed if omitted.

wbs_codestring

WBS code. Auto-computed if omitted.

date_mode'auto' | 'manual'

auto (default): the phase's dates follow its tasks, from the earliest task start to the latest task end, updated whenever a task is added, moved, re-dated or removed; start_date/end_date only hold while no task in the phase has dates. manual: the dates you set are kept as they are.

start_datestring

YYYY-MM-DD. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates.

end_datestring

YYYY-MM-DD, on or after start_date. With date_mode 'auto' it is replaced by the tasks' range once a task in the phase has dates.

color'#3b82f6' | '#f59e0b' | '#8b5cf6' | '#ec4899' | '#06b6d4' | '#14b8a6' | '#6366f1' | '#6b7280'

Phase color. Must be one of: #3b82f6 (Blue), #f59e0b (Amber), #8b5cf6 (Purple), #ec4899 (Pink), #06b6d4 (Cyan), #14b8a6 (Teal), #6366f1 (Indigo), #6b7280 (Gray). Red and green are reserved for blocked / done item statuses.

fieldsstring[]

Optional. Answer with only these fields instead of the whole phase, for example ["id", "versionTimestamp"]. Any of the phase's own fields (snake_case or camelCase) or of the keys around it in the full answer (versionTimestamp, href and, where present, url, title, trackingId, message). The id is always returned, and so is any notice that needs your attention (a note, such as a phase's dates following its tasks or an item's id changing with its type, and a date change's cascadePreview). Unknown names are ignored.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

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