| REST Method | Description |
|---|
| GET .../v1/processTemplates/filter[?whereClause={string}][&orderByClause={string}][&size={integer}] |
Use this method to retrieve a list of process templates.
|
| GET .../v1/processTemplates/queries[?processAppName={string}][&sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries containing process template data.
|
| GET .../v1/processTemplates/query/{query}/attributes |
Use this method to retrieve a list of attributes for a specified query for process template data.
|
| GET .../v1/processTemplates/query/{query}[?selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of process template entities via a query.
|
| GET .../v1/processTemplates/query/{query}/count[?queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of process template entities in a query matching specified criteria.
|
| GET .../v1/processTemplates/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing process template data.
|
| GET .../v1/processTemplates/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing process template data.
|
| GET .../v1/processTemplates/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}] |
Use this method to retrieve a list of process template entities via a query table.
|
| GET .../v1/processTemplates/queryCount?queryTableName={string}[&queryFilter={string}][&admin={boolean}] |
Use this method to retrieve the number of process template entities in a query table matching specified criteria.
|
| GET .../v1/processTemplate/{ptid} |
Use this method to retrieve details of a specified process template.
|
| GET .../v1/processTemplate/{ptid}/queryProperties |
Use this method to retrieve query properties for a specified process template.
|
| GET .../v1/processTemplate/{ptid}/operationTemplates?type={string} |
Use this method to retrieve operations associated with a specified process template.
|
| GET .../v1/processes/filter[?whereClause={string}][&orderByClause={string}][&offset={integer}][&size={integer}] |
Use this method to retrieve a list of process instances.
|
| GET .../v1/processes/queries[?processAppName={string}][&sourceAttributes={string}][&content={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries for process instance data.
|
| GET .../v1/processes/query/{query}/attributes[?processAppName={string}] |
Use this method to retrieve a list of attributes of a query for process instance data.
|
| GET .../v1/processes/query/{query}[?selectedAttributes={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of process instance entities via a query.
|
| GET .../v1/processes/query/{query}/count[?queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of process instance entities in a query matching specified criteria.
|
| GET .../v1/processes/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing process instance data.
|
| GET .../v1/processes/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing process instance data.
|
| GET .../v1/processes/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of process instance entities via a query table.
|
| GET .../v1/processes/queryCount?queryTableName={string}[&queryFilter={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of process instance entities in a query table matching specified criteria.
|
| POST .../v1/process?action={string}&processTemplateName={string}&portType={string}&operation={string} |
Use this method to send a message to a process instance. This message may cause a new process instance to be created or be directed to an existing instance of a long-running process, identified using WS-BPEL correlation sets defined in the process definition.
|
| POST .../v1/process?action={string}&processTemplateName={string}&portType={string}&operation={string} |
Use this method to call an operation exposed by a process instance.
|
| GET .../v1/process/{piid} |
Use this method to retrieve details of a specified process instance.
|
| PUT .../v1/process/{piid}?action={string}[&deadline={string}][&duration={string}] |
Use this method to suspend a process until a specified point in time, for a specified time period, or indefinitely.
|
| PUT .../v1/process/{piid}?action={string} |
Use this method to resume a suspended process.
|
| PUT .../v1/process/{piid}?action={string} |
Use this method to restart a process.
|
| PUT .../v1/process/{piid}?action={string}[&invokeCompensation={boolean}] |
Use this method to terminate a process.
|
| PUT .../v1/process/{piid}?action={string}&activityName={string} |
Use this method to skip the specified activity.
|
| PUT .../v1/process/{piid}?action={string}&activityName={string} |
Use this method to cancel a previous skip request for the specified activity.
|
| DELETE .../v1/process/{piid} |
Use this method to delete a process instance.
|
| GET .../v1/process/{piid}/operationTemplates?type={string} |
Use this method to retrieve operations associated with a specified process instance.
|
| GET .../v1/process/{piid}/variables?activityName={string}[&disposition={string}] |
Use this method to retrieve a list of process variable names.
|
| GET .../v1/process/{piid}/variable/{name} |
Use this method to retrieve a process' variable data.
|
| PUT .../v1/process/{piid}/variable/{name} |
Use this method to set a process' variable with new data.
|
| GET .../v1/process/{piid}/input |
Use this method to retrieve the input of a process.
|
| GET .../v1/process/{piid}/output |
Use this method to retrieve the output of a process.
|
| GET .../v1/process/{piid}/fault |
Use this method to retrieve the fault of a process.
|
| GET .../v1/activities/filter[?whereClause={string}][&orderByClause={string}][&offset={integer}][&size={integer}] |
Use this method to retrieve a list of activity instances.
|
| GET .../v1/activities/queries[?processAppName={string}][&sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of queries containing activity instance data.
|
| GET .../v1/activities/query/{query}/attributes |
Use this method to retrieve a list of attributes for a specified query containing activity instance data.
|
| GET .../v1/activities/query/{query}[?selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of activity instance entities via a query.
|
| GET .../v1/activities/query/{query}/count[?queryFilter={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of activity instance entities in a query matching specified criteria.
|
| GET .../v1/activities/queryTables[?sourceAttributes={string}][&userParametersAllowed={boolean}][&authorizationType={string}][&kind={string}] |
Use this method to retrieve a list of query tables containing activity instance data.
|
| GET .../v1/activities/queryTable/{queryTable}/attributes |
Use this method to retrieve a list of attributes for a specified query table containing activity instance data.
|
| GET .../v1/activities/query?queryTableName={string}[&selectedAttributes={string}][&queryFilter={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve a list of activity instance entities via a query table.
|
| GET .../v1/activities/queryCount?queryTableName={string}[&queryFilter={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}] |
Use this method to retrieve the number of activity instance entities in a query table matching specified criteria.
|
| GET .../v1/activity/{aiid} |
Use this method to retrieve details of a specified activity.
|
| PUT .../v1/activity/{aiid}?action={string} |
Use this method to complete the human task associated with the specified activity instance and claim a subsequent human task.
|
| PUT .../v1/activity/{aiid}?action={string}&continueOnError={boolean} |
Use this method to force the retried execution of a specified activity instance.
|
| PUT .../v1/activity/{aiid}?action={string}&continueOnError={boolean}[&faultName={string}] |
Use this method to force the completion of a specified activity instance.
|
| PUT .../v1/activity/{aiid}?action={string} |
Use this method to skip the specified activity instance.
|
| PUT .../v1/activity/{aiid}?action={string} |
Use this method to cancel a previous skip request for the specified activity instance.
|
| PUT .../v1/activity/{aiid}?action={string}&targetActivityName={string} |
Use this method to skip the specified activity instance and jump to another activity.
|
| PUT .../v1/activity/{aiid}?action={string}&targetActivityName={string} |
Use this method to complete the specified activity instance and jump to another activity.
|
| GET .../v1/activity/{aiid}/variables[?disposition={string}] |
Use this method to retrieve a list of activity variable names.
|
| GET .../v1/activity/{aiid}/variable/{name} |
Use this method to retrieve a activity's variable data.
|
| PUT .../v1/activity/{aiid}/variable/{name} |
Use this method to set an activity's variable with new data.
|
| GET .../v1/activity/{aiid}/input[?new={boolean}] |
Use this method to retrieve the input data of an activity.
|
| GET .../v1/activity/{aiid}/output[?new={boolean}] |
Use this method to retrieve the output data of an activity.
|
| PUT .../v1/activity/{aiid}/output |
Use this method to set the output data of an activity.
|
| GET .../v1/activity/{aiid}/fault?faultName={string}[&new={boolean}] |
Use this method to retrieve the fault data of an activity.
|
| PUT .../v1/activity/{aiid}/fault?faultName={string} |
Use this method to set the fault data of an activity.
|
| GET .../v1/processApps |
Use this method to retrieve the process applications that are installed in the system.
|
| GET .../v1/systems |
Use this method to retrieve metadata about one or more WebSphere Process Server installations (single server or cluster).
|