Komsa.Camunda.Api.Client 2.6.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Standard 2.0 .NET Framework 4.6.1
There is a newer version of this package available.
See the version list below for details.
dotnet add package Komsa.Camunda.Api.Client --version 2.6.1
NuGet\Install-Package Komsa.Camunda.Api.Client -Version 2.6.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Komsa.Camunda.Api.Client" Version="2.6.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Komsa.Camunda.Api.Client --version 2.6.1
#r "nuget: Komsa.Camunda.Api.Client, 2.6.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Komsa.Camunda.Api.Client as a Cake Addin
#addin nuget:?package=Komsa.Camunda.Api.Client&version=2.6.1

// Install Komsa.Camunda.Api.Client as a Cake Tool
#tool nuget:?package=Komsa.Camunda.Api.Client&version=2.6.1

Maintained Fork of Camunda.Api.Client

After Jan Lucansky stopped maintaining the orginal version we started maintaining our own fork. It is a drop-in-replacement for the original version. Just use Komsa.Camunda.Api.Client nuget package instead of Camunda.Api.Client.

Camunda REST API Client NuGet

Camunda REST API Client for .NET platform

  • .NET Framework 4.6.1
  • .NET Standard 2.0

Covered API

Each part listed below is fully covered according to https://docs.camunda.org/manual/latest/reference/rest specification.


The Camunda REST API Client is available on nuget.org

To install Camunda REST API Client, run the following command in the Package Manager Console

PM> Install-Package Komsa.Camunda.Api.Client


Initialize client
CamundaClient camunda = CamundaClient.Create("http://localhost:8080/engine-rest");
Basic Authentication
HttpClient httpClient = new HttpClient();
httpClient.BaseAddress = new Uri("http://localhost:8080/engine-rest");
httpClient.DefaultRequestHeaders.Add("Authorization", "Basic ZGVtbzpkZW1v");
CamundaClient camunda = CamundaClient.Create(httpClient);
Filter external tasks
// build query
var externalTaskQuery = new ExternalTaskQuery() { Active = true, TopicName = "MyTask" };

// add some sorting
    .Sort(ExternalTaskSorting.TaskPriority, SortOrder.Descending)

// request external tasks according to query
List<ExternalTaskInfo> tasks = await camunda.ExternalTasks.Query(externalTaskQuery).List();
Get all external tasks
// get all external tasks without specifying query
List<ExternalTaskInfo> allTasks = await camunda.ExternalTasks.Query().List();
Set process variable
VariableResource vars = camunda.ProcessInstances["0ea218e8-9cfa-11e6-90a6-ac87a31e24fd"].Variables;

// set integer variable
await vars.Set("Var1", VariableValue.FromObject(123));

// set content of binary variable from file
await vars.SetBinary("DocVar", new BinaryDataContent(File.OpenRead("document.doc")), BinaryVariableType.Bytes);
Load typed variables
var executionId = "290a7fa2-8bc9-11e6-ab5b-ac87a31e24fd";
// load all variables of specified execution
Dictionary<string, VariableValue> allVariables = await camunda.Executions[executionId]

// obtain strongly typed variable with name Var1
int myVar1 = allVariables["Var1"].GetValue<int>();
Save content of variable to file
HttpContent fileContent = await camunda.Executions[executionId]

using (fileContent)
    using (var outStream = File.OpenWrite("file1.doc"))
        (await fileContent.ReadAsStreamAsync()).CopyTo(outStream);
Message correlation
var msg = new CorrelationMessage() { All = true, MessageName = "TestMsg" };

    .Set("Date", DateTime.Today)
    .Set("ComplexVar", new { abc = "xyz", num = 123});

// correlate message with process variables
await camunda.Messages.DeliverMessage(msg);
Deploy resources
// deploy new bpmn diagram with some attachment
await camunda.Deployments.Create("My Deployment 1",
    new ResourceDataContent(File.OpenRead("C:\\diagram.bpmn"), "diagram.bpmn"), 
    new ResourceDataContent(File.OpenRead("C:\\document.doc"), "document.doc"));
Conditional query
// get all jobs owned by Process_1 with DueDate in the future
var jobQuery = new JobQuery() { ProcessDefinitionKey = "Process_1" };
jobQuery.DueDates.Add(new ConditionQueryParameter() 
    Operator = ConditionOperator.GreaterThan, Value = DateTime.Now

var jobs = await camunda.Jobs.Query(jobQuery).List();


This project is made available under the MIT license. See LICENSE for details.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.7.0 5,309 2/23/2022
2.6.1 1,680 11/19/2021
2.6.0 238 11/18/2021