Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Phases

Update phase by Id

put/1.0/phases/{phaseId}

Path parameters

phaseIdinteger required

The identifier of the phase is generated by the system and can be used to identify the phase globally.

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Request body

phaseNamestring

The name of the phase. The name specified will be displayed everywhere else and can be used for filtering purposes.

startDatestring

On this date the phase's execution officially begins. The format for the start date is YYYY-MM-DD.

dueDatestring

The day on which the phase's execution is planned to be completed. The dueDate must be on or after the given startDate. The format for the due date is YYYY-MM-DD.

privateboolean

Describes the privacy of the phase i.e. if it is private or shared.

Example request

{
  "phaseName": "Go live",
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "status": {
    "value": 2
  },
  "private": true
}

Response

The requested action was successfully executed.

phaseIdinteger

The phases's unique, system-generated identifier, which can be used to identify the phase globally.

phaseNamestring

The name of the phase.

startDatestring

On this date the phase's execution officially begins. . The due date is mandatory. The format for the start date is YYYY-MM-DD.

dueDatestring

The day on which the phase's execution is planned to be completed. The due date is mandatory. The dueDate must be on or after the given startDate. The format for the due date is YYYY-MM-DD.

startDateActualstring

The date on which the phase status is changed to in progress. The status can be either the default said status (in progress) or custom statuses that are categorised as in progress. It can be null for phases that have not yet begun. The format for the actual start date is YYYY-MM-DD.

dueDateActualstring

The date when phase status gets changed to completed. The status can be either the default provided status (completed) or a custom status that is labelled under the Completed category. It will be null if the phase is yet to be completed. The format for the actual due date is YYYY-MM-DD.

createdAtinteger

The time when the phase was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the phase was last updated. Any changes that's related to the phase are captured and specified here in epoch millis.

privateboolean

Describes the privacy of the phase i.e. if it is private or shared.

Example response

{
  "phaseId": 201,
  "phaseName": "Kick off",
  "project": {
    "projectId": 201,
    "projectName": "Acme onboarding"
  },
  "startDate": "2023-03-28",
  "dueDate": "2023-03-28",
  "startDateActual": "2023-03-28",
  "dueDateActual": "2023-03-28",
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000,
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "status": {
    "value": 2,
    "label": "In progress"
  },
  "private": true
}