REST interface for BPEL-related process resources - Process instance list Resource - GET Method

Use this method to retrieve a list of process instances.

Sample method invocation

GET /rest/bpm/bfm/v1/processes/filter[?whereClause={string}][&orderByClause={string}][&offset={integer}][&size={integer}]

Parameters

Optional Parameters

Name	Value Type	Description
whereClause	string	Specifies the filter criteria applied when the query runs.
orderByClause	string	Orders the result of the query execution by the values of the columns you identify.
offset	integer	Return results after the specified list entry.
size	integer	Maximum number of list entries to be returned.

Request Content

None

Response Content

List of process instances.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Process List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "items": 
      [
         {  "completionTime": {"type": "string", "format": "date-time",
               "description": "Completion time of the process instance."
            },
            "creationTime": {"type": "string", "format": "date-time",
               "description": "Creation time of the process instance."
            },
            "description": {"type": "string",
               "description": "Description of the process instance."
            },
            "displayName": {"type": "string",
               "description": "Display name of the associated process template."
            },
            "executionState": {"type": "string", 
               "description": "Execution state of the process instance.",
               "enum":
               [
                  "STATE_COMPENSATED",
                  "STATE_COMPENSATION_FAILED",
                  "STATE_COMPENSATING",
                  "STATE_DELETED",
                  "STATE_FAILED",
                  "STATE_FAILING",
                  "STATE_FINISHED",
                  "STATE_INDOUBT",
                  "STATE_READY",
                  "STATE_RUNNING",
                  "STATE_SUSPENDED",
                  "STATE_TERMINATED",
                  "STATE_TERMINATING" 
               ]
            },
            "name": {"type": "string",
               "description": "Name of the process instance."
            },
            "parentProcessInstanceName": {"type": "string",
               "description": "Name of the parent process instance."
            },
            "parentProcessInstanceID": {"type": "string",
               "description": "ID of the parent process instance."
            },
            "piid": {"type": "string",
               "description": "ID of the process instance."
            },
            "processTemplateID": {"type": "string",
               "description": "ID of the process template this instance is derived from."
            },
            "processTemplateName": {"type": "string",
               "description": "Name of the process template this instance is derived from."
            },
            "resumptionTime": {"type": "string", "format": "date-time",
               "description": "Resumption time of the process instance if the process instance is suspended and is to be resumed automatically."
            },
            "startTime": {"type": "string", "format": "date-time",
               "description": "Start time of the process instance."
            },
            "starter": {"type": "string",
               "description": "Starter of the process instance."
            },
            "topLevelProcessInstanceName": {"type": "string",
               "description": "Name of the topmost process instance in a hierarchy of processes."
            },
            "topLevelProcessInstanceID": {"type": "string",
               "description": "ID of the topmost process instance in a hierarchy of processes."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. The requested data is returned. Note that the list might be empty.
400 Bad Request	The parameters are not valid or they are missing.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Process instance list Resource