pendWorkItem

This method causes the specified work item(s) to be hidden in the work item list until a specified date/time, or period of time has expired. The work item becomes visible again when the date/time occurs, or period of time expires.

Work items can be pended only if they have a state of Allocated.

This method has two signatures: one to pend a single work item, and one to pend multiple work items.

Syntax

pendWorkItem(id,
             version,
             date,
             duration);

pendWorkItem(workItems,
             date,
             duration);

Parameters

  • id - (integer) A work item ID, identifying the work item to pend.
  • version - (integer) Specifies the version number of the work item you want to pend. 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.
  • date - (String) Date, in UTC format, when pending until a specific date.
  • duration - (Object) An Object containing the following properties — used when pending for a period of time:
    • years
    • months
    • weeks
    • days
    • hours
    • minutes
  • workItems - (Array<Objects>) These identify the work items to be pended. 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