skipWorkItem

This method marks the specified work item as complete, removes it from the work item list, and causes the process to advance. It has the same affect as opening the work item and submitting it.

To skip a work item, the work item cannot have any required data fields that are not filled in.

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

Syntax

skipWorkItem(id,
             version);

skipWorkItem(workItems);

Parameters

  • id - (integer) A work item ID, identifying the work item to skip.
  • version - (integer) Specifies the version number of the work item you want to skip. 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.
  • workItems - (Array<Objects>) These identify the work items to be skipped. 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