c3452a4f62
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
6.3 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Start Process Cloud Service | v3.0.0 | Experimental | 2019-01-09 |
Start Process Cloud Service
Gets process definitions and starts processes.
Class members
Methods
-
createProcess(appName:
string, payload:ProcessPayloadCloud):Observable<ProcessInstanceCloud>
Create a process based on a process definition, name, form values or variables.- appName:
string- name of the Application - payload:
ProcessPayloadCloud- Details of the process (definition key, name, variables, etc) - Returns
Observable<ProcessInstanceCloud>- Details of the process instance just created
- appName:
-
deleteProcess(appName:
string, processInstanceId:string):Observable<void>
Delete an existing process instance- appName:
string- name of the Application - processInstanceId:
string- process instance to update - Returns
Observable<void>-
- appName:
-
getBasePath(appName:
string):string- appName:
string- - Returns
string-
- appName:
-
getProcessDefinitions(appName:
string):Observable<ProcessDefinitionCloud[]>
Gets the process definitions associated with an app.- appName:
string- Name of the target app - Returns
Observable<ProcessDefinitionCloud[]>- Array of process definitions
- appName:
-
startCreatedProcess(appName:
string, createdProcessInstanceId:string, payload:ProcessPayloadCloud):Observable<ProcessInstanceCloud>
Starts an already created process using the process instance id.- appName:
string- - createdProcessInstanceId:
string- process instance id of the process previously created - payload:
ProcessPayloadCloud- - Returns
Observable<ProcessInstanceCloud>- Details of the process instance just started
- appName:
-
startProcess(appName:
string, payload:ProcessPayloadCloud):Observable<ProcessInstanceCloud>
Starts a process based on a process definition, name, form values or variables.- appName:
string- name of the Application - payload:
ProcessPayloadCloud- Details of the process (definition key, name, variables, etc) - Returns
Observable<ProcessInstanceCloud>- Details of the process instance just started
- appName:
-
updateProcess(appName:
string, processInstanceId:string, payload:ProcessPayloadCloud):Observable<ProcessInstanceCloud>
Update an existing process instance- appName:
string- name of the Application - processInstanceId:
string- process instance to update - payload:
ProcessPayloadCloud- Details of the process (definition key, name, variables, etc) - Returns
Observable<ProcessInstanceCloud>- Details of the process instance just started
- appName:
Details
You can use the startProcess method in much the same way as the startProcess method in the
Process service (see the Process service page
for an example). However, the cloud version
combines the process details and variables conveniently into the
ProcessPayloadCloud object.