Skip to content

Function: rankEpics() ​

ts
function rankEpics(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/agile/api/epic.ts:175

Moves (ranks) an epic before or after a given epic.

If rankCustomFieldId is not defined, the default rank field will be used.

Note: This operation does not work for epics in next-gen projects.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ epicIdOrKey: string; rankAfterEpic?: string; rankBeforeEpic?: string; rankCustomFieldId?: number; }-
parameters.epicIdOrKeystringThe id or key of the epic to rank.
parameters.rankAfterEpic?string-
parameters.rankBeforeEpic?string-
parameters.rankCustomFieldId?number-
options?RequestOptions-

Returns ​

Promise<void>