Mayam Tasks API and SDK Documentation

Mayam Tasks provides access to tasks, MAM assets and BPM process instances through a unified SDK, supported by an underlying REST API.

The following information is available:

Prerequisite Information

If you are not familiar with Mayam Tasks from a system architecture and SDK/API point of view, recommended reading is available here:

Java SDK Resources

The Java SDK client is the recommended third party access method. Compared to the REST API, the SDK offers higher level access to task, asset and process instance data. Other benefits with the SDK are:

SDK Documentation

Javadoc for the SDK is available for browsing, with an introduction provided with the TasksClient class.

SDK Download

The Java SDK is available for download here.

All dependencies are included with the SDK jar. As an alternative, a Maven style repository of dependecies can be made available for download on request, allowing for more control of dependencies and their versions. Partial access to our online repository can also be discussed.

SDK Examples Download

Example code for the SDK is available for download here.

REST API

A REST API is also provided that provides extensive access to the Tasks system. The SDK above uses this API. Note that while the documentation describes the required JSON structures to manage complex type data, all complex types have a Java counterpart, which can be accessed in the SDK.

An API tutorial is available in the Programming Guide.

API Documentation

API documentation can be found here. Switch back to this overview by following the link in the top navigation bar.

Additionally, OpenAPI files in JSON and YAML formats are available for download. These can be used to generate clients for all major languages and platforms.

Contact Information

Information about Mayam products and services can be found on www.mayam.com. For general inquiries, send us an email to info@mayam.com.

Authentication is based on API tokens passed as X-ApiToken headers. These tokens must match tokens configured in the api.accounts section of the site-config.properties file. By specifying a working token above, you will be able to test run calls directly from this page.