Function: partiallyUpdateSprint()

function partiallyUpdateSprint(client, parameters): Promise<{
[key: string]: unknown;
  completeDate?: Date;
  createdDate?: Date;
  endDate?: Date;
  goal?: string;
  id?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: Date;
  state: "active" | "closed" | string & object | "future";
}>;

Defined in: src/agile/api/sprint.ts:70

Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated.

Notes:

• For closed sprints, only the name and goal can be updated; changes to other fields will be ignored.
• A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
• A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.
• Other changes to state are not allowed.
• The completeDate field cannot be updated manually.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ completeDate?: string | Date; createdDate?: string | Date; endDate?: string | Date; goal?: string; id?: number; name?: string; originBoardId?: number; sprintId: number; startDate?: string | Date; state?: string; }	-
parameters.completeDate?	string | Date	-
parameters.createdDate?	string | Date	-
parameters.endDate?	string | Date	-
parameters.goal?	string	-
parameters.id?	number	-
parameters.name?	string	-
parameters.originBoardId?	number	-
parameters.sprintId	number	The ID of the sprint to update.
parameters.startDate?	string | Date	-
parameters.state?	string	-

Returns

Promise<{ [key: string]: unknown; completeDate?: Date; createdDate?: Date; endDate?: Date; goal?: string; id?: number; name?: string; originBoardId?: number; self?: string; startDate?: Date; state: "active" | "closed" | string & object | "future"; }>