The Imixs-REST Service API

The representational state transfer (REST) is an architectural style, to present a service interface in a Web-based way. The API and core functionality of Imixs-Workflow is published by an open and platform independent RESTful Web service interface. The Imixs-Workflow REST services can be adopted easily by any kind of Internet client component.

Resources and URIs

An URI is a unique resource identifier which can be used to GET or PUT a unique resource through a RESTful service interface. The REST service interface of Imixs-Workflow publishes a set of resources which are representing WorkItems, Attachments, Reports and Model information. The different resources provided by Imixs-Workflow are divided in the following groups, where each group represents a different aspect of the Imixs-Workflow engine:

URI Resource Description
/workflow/ The Workflow resource provides resources and methods to get, create or modify workitems
/model/ The Model resource provides resources and methods to get, create or modify a workflow model
/report/ The Report resource provides resources and methods to create or execute a report based on a report definition
/documents/ This resource provides methods to query documents managed by the DocumentService EJB
/adminp/ This resource provides methods to create and monitor adminP jobs managed by the AdminPService EJB
/eventlog/ This resource provides methods to fetch event log entries

Note: The root context of the REST Service is defined by the web application (web.xml) containing the REST Service. The default root context is “/api/”.

The Representation of Business Objects

Each resource published by the Imixs-Workflow REST API is represented by common response and request object format. This format reflects a representation of the internal Business Object ItemCollection. Business objects can be represented different formats:

  • text/html
  • application/xml
  • application/json
  • application/x-www-form-urlencoded

XML Business Object

The following example shows a business object in XML representation used for request and response objects:

<document xmlns:xsi="" xmlns:xs="">
	<item name="$modelversion">
		<value xsi:type="xs:string">1.0.1</value>
	<item name="$taskid">
		<value xsi:type="xs:int">1000</value>
	<item name="$eventid">
		<value xsi:type="xs:int">10</value>
	<item name="_subject">
		<value xsi:type="xs:string">some data...</value>
		<value xsi:type="xs:string">more data...</value>

You will find details about the XML Schema in the section XML.

JSON Business Object

The following example shows the same business object in JSON representation which can be used for request and response objects:

{"item": [
    {"name": "$modelversion", "value": ["1.0.1"] },
    {"name": "$taskid", "value": [2000] },
    {"name": "$eventid", "value": [10] },
    {"name": "_subject", "value": ["some data...","more data..."] }

This is called ‘JSON Mapped Notation’.

Typed JSON Format

The disadvantage of the JSON Mapped Notation is that you can’t define the value type mapped to a java object. The Imixs Rest API supports an alternative notatin called JSON BADGERFISH NOTATION. This more expressive notation allows the description of complex business objects providing different xs data types. This is more precise and an equivalent for the XML format. See the following example:

         {"@type":"xs:string","$":"some data"},
         {"@type":"xs:string","$":"more data"}

The typed JSON format is supported only by the workflow resource (/workflow/) to post business data to be processed by the Imixs-Workflow engine.

Note: Depending on the Rest Service Implementation the JSON format for response object can vary.

The following sections gives an detailed description of all resource groups defined by the Imixs-Workflow REST Service API: