plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Sprint

Sprint

A sprint: a time-boxed slice of a project's backlog.

View as Markdown
Summary view
SprintList, 15 fields. What a list returns by default.
Detail view
Sprint, 15 fields. The default for a single read and for every write.
Read with
api:read:project_managementandproject_management::view_active_sprint
Write with
api:write:project_managementandproject_management::manage_sprints

A sprint has three states and they are derived, not stored (completed_at set means completed, otherwise is_active true means active, otherwise upcoming), so there is no state field to read and no filter[state] to send. Starting and completing a sprint are not field writes: they live at POST sprints/{sprint}/actions/start and .../actions/complete, because either can fail for a state reason rather than an invalid-value reason.

Used by

GETList sprints/sprintsSprintList
POSTCreate a sprint/sprintsSprint
GETRead a sprint/sprints/{sprint}Sprint
PATCHUpdate a sprint/sprints/{sprint}Sprint
POSTComplete a sprint/sprints/{sprint}/actions/completeSprint
POSTStart a sprint/sprints/{sprint}/actions/startSprint

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

project_idinteger

The project this sprint belongs to. A sprint cannot be moved between projects, so this is accepted on create only.

namestring≤ 255

Sprint name as shown in plnnrly, e.g. Sprint 14.

descriptionstring or nullMultiline

Free-text sprint goal. Plain text, not markup.

start_datedate (YYYY-MM-DD) or null

Planned first day of the sprint. Independent of started_at: planning a date does not start the sprint.

end_datedate (YYYY-MM-DD) or null

Planned last day of the sprint. Independent of completed_at.

started_attimestamp (YYYY-MM-DDThh:mm:ssZ) or nullServer-assigned

When the sprint was actually started. Written only by POST sprints/{sprint}/actions/start; null on an upcoming sprint.

completed_attimestamp (YYYY-MM-DDThh:mm:ssZ) or nullServer-assigned

When the sprint was actually completed. Written only by POST sprints/{sprint}/actions/complete; null until then. Non-null is what makes the derived state completed.

is_activebooleanServer-assigned

Whether this is the project's running sprint. Set by actions/start and cleared by actions/complete, never by PATCH. At most one sprint per project is active at a time.

orderintegerServer-assigned

Display position within the project. Assigned on create as the last position in that project's sprint order, changed only by reordering in plnnrly, and not writable.

Variants

SprintList 15 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

SprintSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: project_id, description, start_date, end_date, started_at, completed_at, order, work_items_count, created_at, updated_at, project, links

SprintLinks 2 fields

The links object on this resource.

Keys: self, work_items