Expert Agile Data

Added in version 3.0.0.

Requires Redmine >= 5.0 and the redmine_expert_agile plugin >= 0.6.0. Reading requires the view_expert_agile_board permission, updating requires edit_expert_agile_board and edit_issues, changing the sprint additionally requires manage_expert_agile_backlog.

Agile data holds story points, sprint and board position of a single issue. It exists for every issue and is addressed by the issue id.

Manager

All operations on the ExpertAgileData resource are provided by its manager. To get access to it you have to call redmine.expert_agile_data where redmine is a configured redmine object. See the Configuration about how to configure redmine object.

Create methods

Not supported by the Agile plugin, use update().

Read methods

get

redminelib.managers.ResourceManager.get(resource_id)

Returns agile data of an issue. Attributes are None if nothing was set yet.

Parameters:

resource_id (int) – (required). Id of the issue.

Returns:

Resource object

>>> data = redmine.expert_agile_data.get(42)
>>> data
<redminelib.resources.ExpertAgileData #42>
>>> data.story_points, data.sprint_id, data.position
(5, 3, '1024.0')
>>> data.issue
<redminelib.resources.Issue #42 "Printer on fire">

all

Not supported by the Agile plugin

filter

Not supported by the Agile plugin

Update methods

update

redminelib.managers.ResourceManager.update(resource_id, **fields)

Updates agile data of an issue, omitted fields are left unchanged. The change is journaled on the issue.

Parameters:

• resource_id (int) – (required). Id of the issue.

• story_points (int) – (optional). Story points, None clears them.

• sprint_id (int) – (optional). Id of an open sprint available in the issue’s project, None clears it.

Returns:

True

>>> redmine.expert_agile_data.update(42, story_points=8, sprint_id=3)
True

save

redminelib.resources.ExpertAgileData.save(**attrs)

Saves current state of the agile data. position is read-only.

Returns:

Resource object

>>> data = redmine.expert_agile_data.get(42)
>>> data.save(story_points=3)
<redminelib.resources.ExpertAgileData #42>

Hint

Agile data can also be set when creating or updating an issue (creating requires plugin >= 0.6.1, older versions reject it with “Issue cannot be blank”):

>>> redmine.issue.create(
...     project_id='scrum',
...     subject='New story',
...     expert_agile_data_attributes={'story_points': 5, 'sprint_id': 3}
... )

Delete methods

Not supported by the Agile plugin

Export

Not supported by the Agile plugin