tasks.api.scrum.sprint.list

Scope: catalog Permissions to execute: for all

Description and example

tasks.api.scrum.sprint.list()

Method returns list of sprints.

Method is similar to other methods with filtering by list.

Parameters

Parameter	Description
order	Array for result sorting. Array {"sort_field": 'sort direction' [, ...]}. Available fields are described in the table below. Sort direction can have the following values: asc - by ascension; desc - by descension;
filter	Array {"filtered_field": "filter value" [, ...]}. Available fields are described in the table below.
select	Array with entry fields to be returned by the method. Can specify only the fields that you need. Array have the value `"*"`, returns all available fields. Default value - empty array `array()` - indicates that returns all fields of the query's main table.
start	Print page number. Works for https queries.

Example

const groupId = 1;

BX24.callMethod(
   'tasks.api.scrum.sprint.list',
   {
      filter: {
      GROUP_ID: groupId,
      '>=DATE_END': new Date()
      }
   },
   function(res)
   {
      console.log(res);
   }
);

Available fields

Field	Description
ID	Sprint ID
GROUP_ID	Scrum ID
ENTITY_TYPE	Element type
NAME	Name
SORT	Sorting
CREATED_BY	Created by
MODIFIED_BY	Modified by
DATE_START	Start date
DATE_END	End date
STATUS	Status
INFO	Information