Starting a process by calling an Business Automation Workflow REST API
You can start a process and create a new process instance
by calling a REST API.
Before you begin
- You know the model name and container acronym of the process that you want to start.
- Users of the application must be authenticated users and authorized to start an instance of the process.
Attention: REST API calls that return a list of objects,
for example, GET /processes or GET /user-tasks can
include query parameters, such as the model name, container name,
or process ID. If the parameter value points to an object that doesn't
exist, for example, because the process ID contains a typo, an error
is not thrown. Instead the JSON object returned by the call contains
an empty list. For information about the API calls, see Workflow REST APIs.
Procedure
Results
- A new instance of the process is started. Depending on the parameters
that you include in the REST call, a version of the instance is started:
- If you include the version and branch_name parameters or only the version parameter, an instance of the specified version is started.
- If you include neither the version nor branch_name parameters or only a branch_name parameter, an instance of the tip snapshot of the specified or default branch is started on the playback server, or an instance of the default snapshot is started on a workflow server.
- A new process instance object is returned. If you include the optional_parts parameter in the query, this information is also included in the returned process instance object.