Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 4.83 KB

start-process-cloud.service.md

File metadata and controls

58 lines (47 loc) · 4.83 KB
Raw
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

  • 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> -

  • getBasePath(appName: string): string

    • appName: string -
    • Returns string -

  • getProcessDefinitions(appName: string, queryParams?: Function): Observable<ProcessDefinitionCloud[]>
    Gets the process definitions associated with an app.

  • getStartEventFormStaticValuesMapping(appName: string, processDefinitionId: string): Observable<TaskVariableCloud[]>
    Gets the static values mapped to the start form of a process definition.

    • appName: string - Name of the app
    • processDefinitionId: string - ID of the target process definition
    • Returns Observable<TaskVariableCloud[]> - Static mappings for the start event

  • startProcess(appName: string, payload: ProcessPayloadCloud): Observable<ProcessInstanceCloud>
    Starts a process based on a process definition, name, form values or variables.

  • 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

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.

See also