tasks.api.scrum.epic.list

Scope: catalog Permissions to execute: for all

Description and example

tasks.api.scrum.epic.list()

Method returns list of epics.

Method is similar to other methods with filtering by list.

This method is similar to other methods with filtering by list.

Parameters

Parameter	Description
order	Array with 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. You can specify only the fields that you need. If the array has the value `"*"`, returns all available fields. Default value - empty array `array()` - indicates that method will return all fields of query's main table.
start	Print page number. Works for https queries.

Examples

const groupId = 1;
BX24.callMethod(
	'tasks.api.scrum.epic.list',
	{
		filter: {
		GROUP_ID: groupId
		}
	},
	function(res)
	{
		console.log(res);
	}
);

Available fields

Field	Description
ID	Epic ID
GROUP_ID	Scrum ID
NAME	Name
DESCRIPTION	Description
CREATED_BY	Created by
MODIFIED_BY	Modified by
COLOR	Color