Changes - Phases API

List all phases of a change

List all phases of a change with a specific ID:

GET /changes/:id/phases

Response

Status: 200 OK
[
  {
    "completed_at": null,
    "created_at": "2016-12-23T05:09:08-06:00",
    "id": 22,
    "name": "Approval",
    "position": 1,
    "started_at": "2016-12-23T05:09:08-06:00",
    "status": "in_progress",
    "updated_at": "2016-12-23T05:09:08-06:00"
  },
  {
    "completed_at": null,
    "created_at": "2016-12-23T05:09:08-06:00",
    "id": 23,
    "name": "Grant Access",
    "position": 2,
    "started_at": null,
    "status": "registered",
    "updated_at": "2016-12-23T05:09:08-06:00"
  },
  "..."
]

The response contains these fields by default.

Add a phase to a change

Add a link between a change with a specific ID and a phase with a specific ID.

POST /change/:id/phases/:phase_id

Response

Status: 200 OK
{
}

Remove a phase from a change

Remove the link between a change with a specific ID and a phase with a specific ID.

DELETE /change/:id/phases/:phase_id

Response

Status: 204 No Content

Remove all phases from a change

Remove all links between a change with a specific ID and its phases.

DELETE /change/:id/phases

Response

Status: 204 No Content

Fields

completed_at
Readonly datetime — The date and time at which the change phase was set to the status “Completed”.
created_at
Readonly datetime — The date and time at which the change phase was created.
id
Readonly integer — The unique ID of the change phase.
name
Required string (max 50) — The Name field is used to enter the name of the change phase.
position
Optional integer — The Position field dictates the position that the change phase takes when it is presented in the change’s Gantt chart.
started_at
Readonly datetime — The Started field indicates the date and time at which the first change task of the phase was set to a status other than ‘Registered’ or ‘Canceled’.
status
Readonly enum, default: registered — The Status field indicates the current status of the change phase. Valid values are:
  • registered: Registered
  • in_progress: In Progress
  • completed: Completed
updated_at
Readonly datetime — The date and time of the last update of the change phase. If the phase has no updates it contains the created_at value.