IBM Business Process Manager, Version 8.5.0

REST Interface for BPD-related Resources - Process Instance Resource

Resource URI

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

Path Elements

Name	Data Type	Description
instanceId	Process Instance	Process instance ID.

Available Since

7.5.0

Subtopics

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

• GET
  
  Use this method to retrieve details of a process instance.

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

   
  
  
• 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 adhoc event within a process)
  
  Use this method to run an adhoc 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