IBM Business Process Manager, Version 8.5.7

REST interface for BPD-related resources - Process Instance Resource

Resource URI

/rest/bpm/wle/v1/process/{instanceId}

Path elements

Available since

7.5.0

Subtopics

The following subtopics describe the HTTP methods defined for this resource:

• GET
  
  Retrieve the details of a process instance. The parameters that you choose determine the filters that are applied to the results.

   
  
  
• PUT (suspend, resume, terminate, or retry)
  
  Use this method to perform one of the following actions on a process instance: suspend, resume, terminate, retry.

   
  
  
• PUT (update due date)
  
  Use this method to update the due date of a process instance.

   
  
  
• DELETE (delete process instance)
  
  Use this method to delete a process instance that is currently in one of the following states: failed, suspended, terminated, or completed.

   
  
  
• POST (add document)
  
  Use this method to add a new document to a process instance.

   
  
  
• PUT (update document)
  
  Use this method to update an existing document associated with a process instance.

   
  
  
• DELETE (delete document)
  
  Use this method to delete a document associated with a process instance.

   
  
  
• PUT (run an ad hoc event within a process) - This function is deprecated. Use an activity that has no input wire instead of an ad hoc event.
  
  This function is deprecated. Use ad hoc activities and the respective activity REST resource instead. Use this method to run an ad hoc event associated with a process instance.

   
  
  
• PUT (evaluate a JavaScript expression)
  
  Use this method to execute a JavaScript expression and return the resulting process instance details.

   
  
  
• POST (comment)
  
  Use this method to add a comment to a process instance. It can also be used to post a comment to an existing comment (a threaded comment) in a given process instance

   
  
  
• POST (fire timer)
  
  Use this method to manually fire an inline or attached timer.

   
  
  
• POST (move token)
  
  Use this method to move a token to a different step within the process.

   
  
  
• POST (delete token)
  
  Use this method to delete a token.

   
  
  

Parent Topic: REST interface for BPD-related resources Resource Set