Workflow Runtime APIs and Services
This section describes the available APIs and Services that can be used to interact with workflows at runtime.
Technology | Available interfaces | Typical use and additional notes |
---|---|---|
Workflow REST API | https://[DOMAIN:PORT]/api/workflow/v1/Workflows | Use the Workflow REST API to remotely manage workflows and tasks using REST. |
https://[DOMAIN:PORT]/api/workflow/v1/Tasks | ||
.NET Assemblies | K2 provides a rich set of .NET Class Libraries to allow developers to interact with workflows at runtime. K2 client API .DLLs that you reference (such as HostClientApi.dll, SmartObject.Client.dll and the Workflow client API), are thread safe. If you open a connection with the API, you should close and dispose of the connection object. |
|
Workflow Client API (SourceCode.Workflow.Client.dll) | The workflow Client API enables developers to interact with workflow instances, worklists and workflow items at runtime. Typical uses include starting workflows, retrieving worklist items, completing workflow tasks | |
Workflow Management API |
The workflow management API allows developers to manage and administer workflows on a K2 environment. Typical uses include administration of running workflows, setting workflow permissions, managing workflow versions and redirecting worklist items. |
|
SmartObject Runtime APIs and Services | If a workflow has been exposed as a K2 SmartObject, the workflow methods will be exposed as SmartObject methods and can be accessed with the SmartObject Runtime APIs. |