The REST API exposes data and operations that are specific to SkyVault Process Services.
In contrast to the Process Engine REST API, the SkyVault Process Services REST API can be called using any user. The following sections describe the supported REST API endpoints.
- Server Information To retrieve information about the Process Services version:
- Profile This operation returns account information for the current user. This is useful to get the name, email, the groups that the user is part of, the user picture, and so on.
- Runtime Apps When a user logs into Process Services, the landing page is displayed containing all the apps that the user is allowed to see and use.
- App Definitions List To retrieve all App definitions including ones that were not deployed at runtime:
- App Import And Export It is possible to export app definitions and import them again. From the REST API point of view, this is useful to bootstrap an environment (for users or continuous integration).
- App Publish and Deploy Before an app model can be used, it needs to be published. This can be done through following call:
- Process Definition Models List To retrieve a list of process definition models:
- Model Details and History Both app definition and process definition models are versioned.
- BPMN 2.0 Import and Export To export a process definition model to a BPMN 2.0 XML file:
- Process Definitions Get a list of process definitions (visible within the tenant of the user):
- Start Form When process definition has a start form (hasStartForm is true as in the call above), the start form can be retrieved as follows:
- Start Process Instance To start process instances, use:
- Process Instance List To get the list of process instances:
- Get Process Instance Details
- Delete a Process Instance
- Process Instance Audit Log As JSON If you need the audit log information as a JSON you can use the next URL:
- Process instance variables A process instance can have several variables.
- Process Instance Identity links To create an identity link of a process instance:
- Task List To return a list of tasks, use:
- Task Details
- Task Form
- Create a Standalone Task To create a task (for the user in the authentication credentials) that is not associated with a process instance:
- Task Actions To update the details of a task:
- Task Variables To create new task variables:
- Task Identity links To get all identity links for a task:
- User Task Filters Custom task queries can be saved as a user task filter. To get the list of task filters for the authenticated user:
- Comments Comments can be added to a process instance or a task.
- Checklists You can add checklists to a task for tracking purposes.
- Task Audit Info (as JSON) To obtain the audit information for a specific task in JSON format, use the following URL:
Parent topic: REST API