Documentation

tasks.api.scrum.sprint.add

Scope: catalog Permissions to execute: for all

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

Method adds a sprint to Scrum.

Parameters

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

Field groupId required.

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

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

Example

const groupId = 1;
const name = 'Sprint 1';
const createdBy = 1;
const sort = 1;
const status = 'planned';
const dateStart = '2021-11-22T00:00:00+02:00';
const dateEnd = '2021-11-29T00:00:00+02:00';

BX24.callMethod(
   'tasks.api.scrum.sprint.add',
   {
       fields:{
         name: name,
         groupId: groupId,
         createdBy: createdBy,
         sort: sort,
         status: status,
         dateStart: dateStart,
         dateEnd: dateEnd,
       }
   },
   function(res)
   {
      console.log(res);
   }
);

© «Bitrix24», 2001-2024