Contextual data

Register, list, detail and unregister contextual data sources

Overview

Contextual data is often used within stream processing to drive complex logic paths. Joule Management API provides the ability to register, list, detail and undeploy contextual data.

For further information on the structure of the content payload refer to this documentation.

Example contextual data content

{
  "contextual 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 contextual data store

post

Deploy a single contextual 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.

Body

namestringoptional

enabledbooleanrequired

storesobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/joule/management/contextualdata/deploy' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "stores": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }'

201

500

501

502

503

201

No body

Successful deployed data store

Deploy multiple contextual data stores

post

Deploy multiple contextual 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.

Body

dataStoreSpecificationsobject[]optional

namestringoptional

enabledbooleanrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/joule/management/contextualdata/deploy/multi' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataStoreSpecifications": [
      {
        "name": "text",
        "enabled": true,
        "stores": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      }
    ],
    "name": "text",
    "enabled": true
  }'

201

500

501

502

503

201

No body

Successful deployed data stores

Get contextual data specification

get

Path parameters

namestringrequired

Data store logical name.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/management/contextualdata/detail'

404

500

404

No body

Failed to find data store using provided name.

Undeploy contextual data store

delete

Path parameters

namestringrequired

Data store logical name.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/joule/management/contextualdata/undeploy'

201

500

501

502

503

201

No body

Successful transport unregister