Documentation

tasks.api.scrum.sprint.update

Scope: catalog Permissions to execute: for all

tasks.api.scrum.sprint.update(fields)

Method updates a sprint.

All sprint fields are available for update. Unmodifiable fields may be skipped.

Parameters

Parameter Description
fields Fields, corresponding to the available list of fields tasks.api.scrum.sprint.getFields.

Available values for the date fields dateStart and dateEnd: ('ISO 8601', timestamp).

Available values for the field status: ('active', 'planned', 'completed').

Example

const sprintId = 2;
const groupId = 1;
const name = 'Sprint 2';
const dateStart = '2021-11-22T00:00:00+02:00';
const dateEnd = '2021-11-29T00:00:00+02:00';

BX24.callMethod(
   'tasks.api.scrum.sprint.update',
   {
       id: sprintId,
       fields:{
         name: name,
         groupId: groupId,
         dateStart: dateStart,
         dateEnd: dateEnd,
       }
   },
   function(res)
   {
      console.log(res);
   }
);

© «Bitrix24», 2001-2024