REST API - replaceUser

The table summarizes the REST API - replaceUser.

Request

Format 
PUT <baseurl>/process/replace/user
Query parameters Use one of the following two query parameters:
  • user=string: All active process instances with this starter/principle name are changed to the name of the user calling this operation.
  • pid=string (0..n): One or more process instance IDs whose starter/principle name are changed to the name of the user calling this operation.

Response

JSON Returns a JSON representation of the content of the replaceUserResponse element.
XML Returns the content of the replaceUserResponse element (from the ProcessManagement schema).

Example 1 - passing user name

Request 
PUT <baseurl>/process/replace/user?user=Clint%20Hill
Response 
{
    "xml-fragment": {
        "count":4,
        "status": "COMPLETED"
    }
}

Example 2 - passing process instance IDs

Request 
PUT <baseurl>/process/replace/user?pid=pvm:0a124&pid=pvm:0a125
Response 
{
    "xml-fragment": {
        "count":2,
        "status": "COMPLETED"
    }
}