Use cases on RIA Docs

Map custom payloads

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This documentation provides a walkthrough of how to map and deliver custom payloads in API integrations. The focus is on mapping a raw JSON payload to a target API endpoint, and handling the responses.

Example Payload

The following is a sample payload:

  {
    "elementType": "person",
    "code": "4637115",
    "dateOfBirth": "1985-01-01"
  },
  {
    "elementType": "person",
    "code": "4637999",
    "dateOfBirth": "1986-01-01"
  }

Service Definition

The schema definition is required for the target definition. Create a DOH service definition as follows:

Make a GET call

Mon, 01 Jan 0001 00:00:00 +0000

Overview

DOH is commonly used to create, delete, and update data through API calls, using the POST, DELETE, and PUT HTTP methods. The GET endpoints have also been supported, but previously, the response from a GET call could only be logged and stored in the UA_RUN_SERVICE_TRACE table when tracing was enabled. The response payload could not be processed or used for further actions.

The GET responses can now be passed to a Groovy handleResponse method. For more information about using handleResponse to process custom responses, see handle response executable and Mapping custom payloads.

Invoke multipart REST API to upload file

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The service API executable supports only XML and JSON payloads and therefore cannot invoke APIs that require the multipart/form-data content type for file uploads.

To upload files to such APIs, use the FILE_UPLOAD executable together with a Groovy script. The Groovy script performs the HTTP multipart request while the FILE_UPLOAD executable manages the upload lifecycle.

Prerequisite

The groovy-wslite-1.1.3.jar library must be available on the classpath. To install,