Cafienne Reference Guide

Cafienne Reference Guide

  • Overview
  • Getting Started
  • CMMN
  • Cafienne IDE
  • Cafienne Engine
  • Extensions
  • API Reference
  • Releases

›API Reference

Overview

  • Cafienne
  • A short introduction
  • Product Overview

Getting Started

  • Introducing Cafienne Demo
  • Generic UI
  • How to use task UI rendering
  • Two business applications
  • Obtaining Cafienne Demo

Some CMMN

  • What is CMMN
  • Modelling the Case Plan
  • Modelling the Case File
  • Modelling the Case Team
  • Other things to model

Cafienne IDE

  • An IDE?
  • Designing
  • Tasks and Parameters
  • Expressions
  • Deploying
  • Debugging

Cafienne Engine

  • The Cafienne Engine
  • Authentication
  • Authorization
  • Pictorial overview
  • Logging
  • Configuration
  • Repository

Extensions

  • Do we need extensions?
  • Workflow
  • Business Identifiers

API Reference

  • Introducing the API
  • Joining the platform
  • Start a Case
  • Case Team membership
  • Executing the case
  • Retrieving cases and tasks
  • Casefile requests

Releases

  • Overview
  • 1.1.24
  • 1.1.23
  • 1.1.22
  • 1.1.21
  • 1.1.20
  • 1.1.19
  • 1.1.18
  • 1.1.17
  • 1.1.16
  • 1.1.15
  • 1.1.14
  • 1.1.13
  • 1.1.12
  • 1.1.11
  • 1.1.10
  • 1.1.9
  • 1.1.8
  • 1.1.7
  • 1.1.6
  • 1.1.5
  • 1.1.4
  • 1.1.3
  • 1.1.2
  • 1.1.1
  • 1.1.0

Introducing the API

This section gives a brief overview of the Cafienne Engine APIs.

The API can be used to embed the Cafienne Engine into the setup of your solution. The user interfaces that come with Cafienne, like the Generic UI and the Cafienne IDE also use these APIs.

Categorization

The APIs broadly consist of the following categories. The majority of the APIs in use is for handling cases and tasks. Furthermore there are APIs for maintenance of the platform at various levels.

/case

For starting cases, listing cases, setting case teams, getting individual case instances, etc.

/task

For getting, claiming, assigning and completing Human Tasks.

/repository

For storing and retrieving case definitions.

/tenant

For maintaining the tenant registration, like adding users, changing roles, etc.

/platform

Platform maintenance APIs, like adding tenants, changing platform owners, checking platform health.

Try it out with Swagger UI

The Cafienne Engine ships with a Swagger UI to give you a quick start in trying the APIs.

Image

You can find the API of your version of the engine through SwaggerUI at http://localhost:2027.

Note that the Cafienne Engine APIs need an authorization token with each request, according to the JWT standard. You can find more details about that in Cafienne Authentication.

When you click on the Authorize button in the above Swagger UI, it will lead you to the configured Identity Provider where you can login and get a token that Swagger will use when you execute requests.

← Business IdentifiersJoining the platform →
  • Categorization
  • Try it out with Swagger UI