In this article, you will learn how to manage Workflows and Tasks over the API.
There are two different URLs where you can find our API:
- Base URL: https://<FireStartServer>:<Port>/api
- Swagger: https://<FireStartServer>:<Port>/api/swagger
What follows are several methods you can use to perform operations on tasks or workflows.
Resolve User Permissions
This method needs to be called a single time to resolve permissions for the current user. If you do not call it the FireStart server will have no permissions resolved for the user and will return an unauthorized error.
Workflows
To get an overview of all workflows one of these two methods can be used. The difference between the two methods is that the second method is faster, but it returns less information about each workflow and only returns workflows where the model is published.
There are three ways to delete/stop a workflow through the API. Each method needs the ExecutionId as an input parameter. The ExecutionId can be found in the Id property of the return value from one of the two methods above.
Stop a workflow and move it into the archive:
Stop a workflow if it is still running and move it to the recycle bin:
Stop a workflow if it is still running and permanently delete it from the system:
Read Tasks
To get an overview of all tasks one of these two methods can be used.
With this method and the property Id, further information for a single task can be retrieved.
The return value contains all important information about the task.
User in charge:
Role:
ExecutionId:
