Deleting tokens by using the REST API

Use a REST API to delete tokens.

Before you begin

The Process Portal action policies govern security permissions for token management features. Before you delete tokens, ensure the ACTION_DELETE_TOKEN action policy is configured to allow you to delete tokens and that you are a member of the default security group that is assigned to the action policy.

Procedure

  1. Use the Delete token REST API to delete a process instance token. For interface details, see REST interface for BPD-related resources - Process Instance Resource - POST (delete token) Method.
    /rest/bpm/wle/v1/process/instance_ID?action=deleteToken&tokenId=
    token_ID[&resume=resume_value]
  2. Provide the information for the following parameters of the API:
    • instance_ID - the instance ID number of the process instance containing tokens to be deleted
    • action - the action to be taken (deleteToken)
    • token_ID - the token ID number of the token you want to delete
    • resume_value - the action used to resume the instance after deleting the token (set to true or false); the default value is true.
  3. Find the token ID for a particular process instance in one of the following places:
    • The Process Designer Inspector shows the tokens when you view a particular instance.
    • The Process Inspector in the Process Admin console lists the tokens for an instance if they are orphaned.
    • The GET method of the process instance REST interface returns details about a process instance including its tokens. For more information, see REST interface for BPD-related resources - Process Instance Resource - GET Method.
  4. Run the REST API to delete the token.

Results

When successful, the REST API returns a 200 status code. For possible error codes, see REST interface for BPD-related resources - Process Instance Resource - POST (delete token) Method.