Search the wiki
»

Wiki Start Page

Barium Live!

Barium Business Navigator

Barium SharePoint Client

Barium Live! REST API
Barium Integration Agent

RSS
RSS
Modified on Monday, 02 April 2012 10:02 AM by josefineaspenstrand Categorized as Barium Live! REST API

Barium Live! REST API

Barium Live! allows custom integration via an Application Programming Interface (API) integration. This documentation describes how you can access the API to get information from and set information to process models and applications that you create in the web service.


Software and Protocol Requirements

Required Software/Protocol support for REST API clients

No specific requirements, although support for the HTTP protocol and JSON data format is required to be able to use the REST API.

Required Software/Configuration for web-based REST API clients

Note: Other browsers or newer versions of the listed browsers will probably work, but full functionality cannot be guaranteed. Support for newer web browsers will be added continuously.
  • Microsoft Internet Explorer 8, Mozilla Firefox 3.6 or Google Chrome 10.
  • JavaScript enabled in the browser.
  • No restrictions on normal web browsing.
  • Adobe Flash Player installed in the browser.
  • A PDF viewer.

API Version

1.0 Current API version


API Syntax

<<SERVER URL>>/API/v1.0/<<Resource>>/<<Id>>/<<Selector>>/<<SelectorId>>/<<SubSelector>>/<<SubSelectorId>>
<<SERVER URL>>/API/v1.0/{Resource}/{Id}/{Selector}/{SelectorId}?{QueryString1}={Value1}&{QueryString2}={Value2}


Parameter Description
Resource The type of resource you wish to access, e.g. process, instance, task, object
Id (Optional) The system-generated Id or the registered Id for the resource
Selector (Optional) Selects a specific set of data or underlying resource from the designated resource
SelectorId (Optional) Selects an item from the specific set of data or the resource designated by the Selector
SubSelector (Optional) Selects a specific set of data or underlying resource from the item specified by SelectorId
SubSelectorId (Optional) Selects an item from the specific set of data or the resource designated by the SubSelector


Global querystrings Value(s) Description
format json,xml (Optional) Sets the output format for the API call
jsonp {METHOD} (Optional) Enables Json with padding which is useful in cross-site situations
jsontext true (Optional) Returns Json with the content-type text/json instead of application/json


API Data Format

All data except binary data is returned in the JSON format by default (http://en.wikipedia.com/wiki/JSON)
All dates are returned in the ISO-8601 format (http://en.wikipedia.org/wiki/ISO_8601) in coordinated universal time (UTC)
All HTTP POST-requests except for file uploads must include the HTTP Header "Content-Type" set to "application/x-www-form-urlencoded"
All HTTP POST parameters except for file uploads must be URL-encoded as "x-www-form-urlencoded" (http://www.w3.org/TR/html401/interact/forms.html#h17.13.4.1) where non--ASCII characters must be encoded in UTF-8. More information is available at http://en.wikipedia.org/wiki/Percent-encoding
HTTP POST file uploads must conform to RFC 1867 (http://www.faqs.org/rfcs/rfc1867.html)

API Error Messages

Error messages are returned as standard HTTP error messages with an HTTP status code and a response in JSON format:
{success: false, errorCode: ERROR_CODE, errorMessage: “Error message”, errorLogId: "ERROR_LOG_ID", errorData: ERROR_DATA}

ERROR_CODE is a standard HTTP status code (eg 400 = Bad request, 404 = Not found, 500 = Internal server error). ERROR_LOG_ID refers to a logged error message that can contain more information about the error. The format of ERROR_DATA varies and depends on the error.

Barium Live! login

www.bariumlive.com

New to Barium Live!?

Get started

Barium AB | www.bariumlive.com