REST API - saveTerminatedProcessInstances - Passing appname

The table summarizes the REST API - saveTerminatedProcessInstances.

Request

Format 
PUT <baseurl>/process/save/terminated/instances/{appname}/{willsave}
Path parameters appname: The name of the application as specified in TIBCO Administrator when the application was created.

willSave: Indicates whether terminated process instances should be saved.

Query parameters
  • duration=string (0..n)(optional): The duration for which the terminated process will be saved.
  • module=string (0..n): Name of the module to which the process published as a REST service belongs.
  • process=string (0..n): Name of the process template.
  • version=string (0..n): Version of the process template.

Parameters can be obtained from queryProcessTemplates and queryProcessTemplatesAlt.

Response

JSON If successful, returns 200 OK in the response header, and status message in the response body.
XML If successful, returns 200 OK in the response header, and status message in the response body.

Example

Request 
PUT <baseurl>/process/save/terminated/instances/com.example.sanityprocesses/true
Response 
{
    "xml-fragment": {
        "statusMessage": "saveTerminatedProcessInstances operation has completed. Save state was updated for 2 process templates",
        "details": ""
    }
}