Reference data

Register, list, detail and unregister reference data sources

---

Overview

Reference data is often used within stream processing to drive complex logic paths. Joule Management API provides the ability to register, list, detail and undeploy reference data. For further information on the structure of the content payload refer to this documentation.

Example reference data content

{
  "reference data": {
    "name": "banking market data",
    "data sources": [
      {
        "geode stores": {
          "name": "us markets",
          "connection": {
            "locator address": "192.168.86.39",
            "locator port": 41111
          },
          "stores": {
            "nasdaqIndexCompanies": {
              "region": "nasdaq-companies",
              "keyClass": "java.lang.String",
              "gii": true
            },
            "holidays": {
              "region": "us-holidays",
              "keyClass": "java.lang.Integer"
            }
          }
        }
      }
    ]
  }
}

---

Deploy a single reference data store

Deploy a single reference data store. A json specification is provided within the body as a raw data type.If the registration process has succeed a response code of 201 is returned otherwise 500.

POST/joule/management/referencedata/deploy

Body

application/json

namestring

enabled*boolean

storesobject

Response

201500501502503

Successful deployed data store

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/referencedata/deploy', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enabled": false
    }),
});
const data = await response.json();

Deploy multiple reference data stores

Deploy multiple reference data stores. A json specification is provided within the body as a raw data type.If the registration process has succeed a response code of 201 is returned otherwise 500.

POST/joule/management/referencedata/deploy/multi

Body

application/json

dataStoreSpecificationsarray of DataStoreSpecification (object)

namestring

enabled*boolean

Response

201500501502503

Successful deployed data stores

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/referencedata/deploy/multi', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enabled": false
    }),
});
const data = await response.json();

Get reference data specification

GET/joule/management/referencedata/detail

Path parameters

name*string

Data store logical name.

Response

404500

Failed to find data store using provided name.

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/referencedata/detail', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Undeploy reference data store

DELETE/joule/management/referencedata/undeploy

Path parameters

name*string

Data store logical name.

Response

201500501502503

Successful transport unregister

Request

JavaScriptCurlPython

const response = await fetch('/joule/management/referencedata/undeploy', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();