Skip to end of metadata
Go to start of metadata

Syntax

createSprint(rapidViewId, sprintName)

or

createSprint(rapidViewId, sprintName, startDate, endDate)

Description

Creates a new sprint for the provided rapid view.

Parameters

Parameter name

Type

Required

Description

rapidViewId

number

Yes

The rapid view id.

sprintNamestringYesThe name of the sprint.
startDatedateYesThe start date of the sprint.
endDatedateYesThe end date of the sprint.

Return type

number

Returns the id of the created sprint.

Example 1

number newSprintId = createSprint(1, "Sprint");
runnerLog("The sprint was created with the id: "+newSprintId);

Result: A new sprint with the name "Sprint" is created on the rapid vie with the id 1.

When created with this syntax, the new sprint will be in the "feature" state which means that the sprint is not started yet.


Example 2

number newSprintId = createSprint(1, "Sprint", "06/Apr/19 10:00 AM", "20/Apr/19 08:00 AM");
runnerLog("The sprint was created with the id: "+newSprintId);

Result: A new sprint with the name "Sprint" is created on the rapid view with id 1 and the starting date 06/Apr/19 10:00 AM and the ending date 20/Apr/19 08:00 AM.

By entering the starting date and the ending date the script will be automatically planned and its state will be "active".

See also

  • No labels