prioritizeWorkItem

This method alters the priority of the specified work item(s).

There are two system actions controlling a user’s right to change work item priority:

  • BRM.changeAllocatedWorkItemPriority - Users with this system action can alter the priority on allocated and pended work items.
  • BRM.changeAnyWorkItemPriority - Users with this system action can alter the priority on allocated, pended, and offered work items.

This method has two signatures: one to set the priority for a single work item, and another for multiple work items.

Syntax

prioritizeWorkItem(id,
                   version,
                   priority);
prioritizeWorkItem(workItems,
                   priority);

Parameters

  • id - (integer) A work item ID, identifying the work item.
  • version - (integer) Specifies the version number of the work item whose priority is being set. The version number indicates how many times the work item has changed state. The version number starts at 0 when the work item is created, and is incremented by one each time it changes state.
  • priority - (integer) A number, from 0 - 100, indicating the new priority.
  • workItems - (Array<Objects>) These identify the work items whose priority is being set. Each Object in the array must have the following properties, identifying an existing work item (see above for definitions):
    • workItemId (integer)
    • workItemVersion (integer)

Returns

none