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

Responses

201

Successful deployed data store

No content

500

Failed to deploy data store. Check Joule service log files.

501

Failed to deploy data store due to malformed DSL. Check Joule service log files.

502

Data store has already been deployed

503

Missing data store specification

post/joule/management/contextualdata/deploy

POST /joule/management/contextualdata/deploy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "text",
  "enabled": true,
  "stores": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

No content

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

namestringOptional

enabledbooleanRequired

Responses

201

Successful deployed data stores

No content

500

Failed to deploy data store. Check Joule service log files.

501

Failed to deploy data store due to malformed DSL. Check Joule service log files.

502

Data store has already been deployed

503

Missing data store specification

post/joule/management/contextualdata/deploy/multi

POST /joule/management/contextualdata/deploy/multi HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "dataStoreSpecifications": [
    {
      "name": "text",
      "enabled": true,
      "stores": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ],
  "name": "text",
  "enabled": true
}

No content

Get contextual data specification

get

Path parameters

namestringRequired

Data store logical name.

Responses

404

Failed to find data store using provided name.

No content

500

Missing data store name.

get/joule/management/contextualdata/detail

GET /joule/management/contextualdata/detail HTTP/1.1
Accept: */*

No content

Undeploy contextual data store

delete

Path parameters

namestringRequired

Data store logical name.

Responses

201

Successful transport unregister

No content

500

Internal Joule error. Check log files.

501

Failed to unregister transport using provided name.

502

Invalid transport type. Valid type is CONTEXTUAL_DATA.

503

Unknown data store for provided name.

delete/joule/management/contextualdata/undeploy

DELETE /joule/management/contextualdata/undeploy HTTP/1.1
Accept: */*

No content