Samples

The Samples Exchange on Blueworks Live has a code example to help illustrate how you can use the web API. Before using the samples, you must edit the WebApiFactory.properties and swing-client.properties files, and replace the placeholder APPSERVER_URL with the URL of your server.

Setting the start time for an external implementation
The web API includes functions that enable an external system to programmatically set a start time for a task created for an external implementation.
Logging on to Process Server
The following sample shows how to use the web API to log on to the process server.
Retrieving user tasks
The following sample shows how to use the web API to retrieve tasks for a process participant from the process server.
Starting a task
The following sample shows how to use the web API to enable a process participant to start a task by assigning the task to herself and to then re-assign the task back to the original role assignment.
Completing a task
The following sample shows how to use the web API to enable a process participant to complete a task by checking it in.
Creating a new process instance
The following sample shows how to use the web API to create a new process instance.
Reading business data from a process instance
The following sample shows how to use the web API to read business data from a process instance.
Searching and using business data to filter results
The following sample shows how to use the web API to perform a search that uses business data to filter the results.
Terminating a process instance
The following sample shows how to use the web API to terminate a process instance.
Building a Java client
You can use the WID web service generate client to generate a Java Client that can invoke the web API.
Wrapping a complex type value in a ComplexValue object
This code sample illustrates how to pass a complexValue object to the web API.

Parent topic: Developing using the web service API