ION API

Description
Features

Since: 0.6.0
Context: Any
Category: Integration
—

Description

The ION API can be used to connect to M3 data by using ION API calls. There are several API methods to use the ION API depending on the user needs.

JSON slurper parses text or reader content into a data structure of lists and maps.
Example:

content = '{ "formats": ["pdf", "xml","xlsm", "jpg"] }'
JsonSlurper slurper = new JsonSlurper();
Map parsed = (Map)slurper.parseText(content);
List<String> fileFormats = (List)parsed.get("formats");
for (String format : fileFormats) {
    println("Supporting format: ${format}");
}

Output:

Supporting format: pdf
Supporting format: xml
Supporting format: xlsm
Supporting format: jpg

Parsing with JsonSlurper for ION methods:

JsonSlurper slurper = new JsonSlurper();
Map parsed = (Map)slurper.parseText(content);
List<String> fileFormats = (List)parsed.get("SupportedFileFormats");
for (String format : fileFormats) {
  logger.debug("Supporting format: ${format}");
}

Features

ION API features.

POST method

This method performs a POST request and returns an ION Response object.

String endpoint = "/IONAttachment/supportedfile/list";
Map<String, String> headers = ["Accept": "application/json"];
Map<String, String> queryParameters = (Map)null; // define as map if there are any query parameters e.g. ["name1": "value1", "name2": "value2"]
Map<String, String> formParameters = (Map)null; // post URL encoded parameters
IonResponse response = ion.post(endpoint, headers, queryParameters, formParameters);
if (response.getStatusCode() != 200) {
  if (response.getError()) {
    logger.debug("Failed calling ION API, detailed error message: ${response.getErrorMessage()}");
    exception.throwErrorMIResponseException(response.getErrorMessage());
  }
  logger.debug("Expected status 200 but got ${response.getStatusCode()} instead");
  return;
}

String content = response.getContent();
if (content != null) {
  logger.debug("Expected content from the request but got no content");
  return;
}

GET method

This method performs a GET request and returns an ION Response object.

String endpoint = "/IONAttachment/supportedfile/list";
Map<String, String> headers = ["Accept": "application/json"];
Map<String, String> queryParameters = (Map)null; // define as map if there are any query parameters e.g. ["name1": "value1", "name2": "value2"]
IonResponse response = ion.get(endpoint, headers, queryParameters);
if (response.getStatusCode() != 200) {
  if (response.getError()) {
    logger.debug("Failed calling ION API, detailed error message: ${response.getErrorMessage()}");
    exception.throwErrorMIResponseException(response.getErrorMessage());
  }
  logger.debug("Expected status 200 but got ${response.getStatusCode()} instead");
  return;
}

String content = response.getContent();
if (content != null) {
  logger.debug("Expected content from the request but got no content");
  return;
}

PUT method

This method performs a PUT request and returns an ION Response object.

String endpoint = "/IONAttachment/supportedfile/list"
Map<String, String> headers = ["Accept": "application/json"]
Map<String, String> queryParameters = (Map)null // define as map if there are any query parameters e.g. ["name1": "value1", "name2": "value2"]
Map<String, String> formParameters = (Map)null //
IonResponse response = ion.put(endpoint, headers, queryParameters, formParameters)
if (response.getStatusCode() != 200) {
  if (response.getError()) {
    logger.debug("Failed calling ION API, detailed error message: ${response.getErrorMessage()}");
    exception.throwErrorMIResponseException(response.getErrorMessage());
  }
  logger.debug("Expected status 200 but got ${response.getStatusCode()} instead");
  return;
}

String content = response.getContent()
if (content != null) {
  logger.debug("Expected content from the request but got no content")
  return;
}

DELETE method

This method performs a DELETE request and returns an ION Response object.

String endpoint = "/IONAttachment/supportedfile/list"
Map<String, String> headers = ["Accept": "application/json"]
Map<String, String> queryParameters = (Map)null // define as map if there are any query parameters e.g. ["name1": "value1", "name2": "value2"]
IonResponse response = ion.delete(endpoint, headers, queryParameters)
if (response.getStatusCode() != 200) {
  if (response.getError()) {
    logger.debug("Failed calling ION API, detailed error message: ${response.getErrorMessage()}");
    exception.throwErrorMIResponseException(response.getErrorMessage());
  }
  logger.debug("Expected status 200 but got ${response.getStatusCode()} instead");
  return;
}

String content = response.getContent()
if (content != null) {
  logger.debug("Expected content from the request but got no content")
  return;
}