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

Use this method to retrieve a list of process templates.

Sample method invocation

GET /rest/bpm/bfm/v1/processTemplates/filter[?whereClause={string}][&orderByClause={string}][&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.
size	integer	Maximum number of list entries to be returned.

Request Content

None

Response Content

List of process templates.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Process Template List", 
   "type": "object",
   "properties":
   {  "identifier": {"type": "string"},
      "items": 
      [
         {  "applicationName": {"type": "string",
               "description": "Name of the application the process template is part of."
            },
            "autoDeletionMode": {"type": "string", 
               "description": "Specifies whether an instance of the process template is automatically or conditionally deleted when it reaches an end execution state.",
               "enum":
               [
                  "AUTO_DELETE_YES",
                  "AUTO_DELETE_NO",
                  "AUTO_DELETE_ON_SUCCESSFUL_COMPLETION"
               ]
            },
            "autonomy": {"type": "string", 
               "description": "Specifies whether an instance of the process template runs dependently of a potential parent or not.",
               "enum":
               [
                  "AUTONOMY_PEER", 
                  "AUTONOMY_CHILD",
                  "AUTONOMY_NOT_APPLICABLE" 
               ]
            },
            "creationTime": {"type": "string", "format": "date-time",
               "description": "Creation time of the process template."
            },
            "customProperties": {"type": "object", "additionalProperties": {"type": "string"},
               "description": "List of custom property names and values."
            },
            "description": {"type": "string",
               "description": "Description of the process template."
            },
            "displayName": {"type": "string",
               "description": "Display name of the process template."
            },
            "executionMode": {"type": "string", 
               "description": "States whether the process template can be executed as a microflow or as a macroflow.",
               "enum":
               [
                  "EXECUTION_MODE_LONG_RUNNING",
                  "EXECUTION_MODE_MICROFLOW" 
               ]
            },
            "inputType": {"type": "string", 
               "description": "Name of the input message type. The value has the format {namespace}localname."
            },  
            "isBusinessRelevant": {"type": "boolean",
               "description": "States whether a process instance derived from this template is a business relevant or an 'auxiliary' step."
            },
            "isCompensationDefined": {"type": "boolean",
               "description": "States whether an instance of the process template can be compensated."
            },
            "isContinueOnError": {"type": "boolean",
               "description": "States whether process instances derived from this template stop in case of an unhandled error or not."
            },
            "lastModificationTime": {"type": "string", "format": "date-time",
               "description": "Last time a property of the process template changed."
            },
            "name": {"type": "string",
               "description": "Name of the process template."
            },
            "ptid": {"type": "string",
               "description": "ID of the process template."
            },
            "schemaVersion": {"type": "string",
               "description": "Version of the XML schema that describes the process template."
            },
            "state": {"type": "string", 
               "description": "States whether the process template is started or stopped.",
               "enum":
               [
                  "STATE_STARTED",
                  "STATE_STOPPED" 
               ]
            },
            "targetNamespace": {"type": "string",
               "description": "XML Schema target namespace of the process template."
            },
            "validFromTime": {"type": "string", "format": "date-time",
               "description": "Time the process template became or becomes valid."
            },
            "version": {"type": "string",
               "description": "User-specified version of the process template."
            }
         }
      ]
   }
}

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 template list Resource