Skip to content

neilmaartens/K2Documentation.Samples.WorkflowRuntime.WorkflowClientAPI

Repository files navigation

K2Documentation.Samples.WorkflowRuntime.WorkflowClientAPI

This project contains sample code that demonstrates common uses of the SourceCode.Workflow.Client.dll API to interact with K2 workflows at runtime, such as:

  • connecting to the K2 workflow server
  • starting a workflow
  • retrieving workflow tasks/worklist items
  • completing a workflwo task/worklist item
  • working with comments and attachments

Prerequisites

The sample code has the following dependencies:

  • .NET Assemblies (both assemblies are included with K2 client-side tools install and are also included in the project's References folder)
    • SourceCode.Workflow.Client.dll
    • SourceCode.HostClientAPI.dll

Getting started

  • Use these code snippets to learn how to perform common tasks with k2 workflows through the workflow client API.
  • Note that these projects may compile, but will not actually run as-is, since they are intended as sample code only. You will need to edit the code snippets to work in your environment and with your artifacts.
  • Fetch or Pull the appropriate branch of this project for your version of K2.

License

This project is licensed under the MIT license, which can be found in LICENSE.

Notes

  • The sample code is provided as-is without warranty.
  • These sample code projects are not supported by K2 product support.
  • The sample code is not necessarily comprehensive for all operations, features or functionality.
  • We only accept code contributions that are compatible with the MIT license (essentially, MIT and Public Domain).

About

Testing the repo creation process. Sample project that demonstrates how to work with the workflow client API.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages