Joule
  • Welcome to Joule's Docs
  • Why Joule?
    • Joule capabilities
  • What is Joule?
    • Key features
    • The tech stack
  • Use case enablement
    • Use case building framework
  • Concepts
    • Core concepts
    • Low code development
    • Unified execution engine
    • Batch and stream processing
    • Continuous metrics
    • Key Joule data types
      • StreamEvent object
      • Contextual data
      • GeoNode
  • Tutorials
    • Getting started
    • Build your first use case
    • Stream sliding window quote analytics
    • Advanced tutorials
      • Custom missing value processor
      • Stateless Bollinger band analytics
      • IoT device control
  • FAQ
  • Glossary
  • Components
    • Pipelines
      • Use case anatomy
      • Data priming
        • Types of import
      • Processing unit
      • Group by
      • Emit computed events
      • Telemetry auditing
    • Processors
      • Common attributes
      • Filters
        • By type
        • By expression
        • Send on delta
        • Remove attributes
        • Drop all events
      • Enrichment
        • Key concepts
          • Anatomy of enrichment DSL
          • Banking example
        • Metrics
        • Dynamic contextual data
          • Caching architecture
        • Static contextual data
      • Transformation
        • Field Tokeniser
        • Obfuscation
          • Encryption
          • Masking
          • Bucketing
          • Redaction
      • Triggers
        • Change Data Capture
        • Business rules
      • Stream join
        • Inner stream joins
        • Outer stream joins
        • Join attributes & policy
      • Event tap
        • Anatomy of a Tap
        • SQL Queries
    • Analytics
      • Analytic tools
        • User defined analytics
          • Streaming analytics example
          • User defined analytics
          • User defined scripts
          • User defined functions
            • Average function library
        • Window analytics
          • Tumbling window
          • Sliding window
          • Aggregate functions
        • Analytic functions
          • Stateful
            • Exponential moving average
            • Rolling Sum
          • Stateless
            • Normalisation
              • Absolute max
              • Min max
              • Standardisation
              • Mean
              • Log
              • Z-Score
            • Scaling
              • Unit scale
              • Robust Scale
            • Statistics
              • Statistic summaries
              • Weighted moving average
              • Simple moving average
              • Count
            • General
              • Euclidean
        • Advanced analytics
          • Geospatial
            • Entity geo tracker
            • Geofence occupancy trigger
            • Geo search
            • IP address resolver
            • Reverse geocoding
            • Spatial Index
          • HyperLogLog
          • Distinct counter
      • ML inferencing
        • Feature engineering
          • Scripting
          • Scaling
          • Transform
        • Online predictive analytics
        • Model audit
        • Model management
      • Metrics engine
        • Create metrics
        • Apply metrics
        • Manage metrics
        • Priming metrics
    • Contextual data
      • Architecture
      • Configuration
      • MinIO S3
      • Apache Geode
    • Connectors
      • Sources
        • Kafka
          • Ingestion
        • RabbitMQ
          • Further RabbitMQ configurations
        • MQTT
          • Topic wildcards
          • Session management
          • Last Will and Testament
        • Rest endpoints
        • MinIO S3
        • File watcher
      • Sinks
        • Kafka
        • RabbitMQ
          • Further configurations
        • MQTT
          • Persistent messaging
          • Last Will and Testament
        • SQL databases
        • InfluxDB
        • MongoDB
        • Geode
        • WebSocket endpoint
        • MinIO S3
        • File transport
        • Slack
        • Email
      • Serialisers
        • Serialisation
          • Custom transform example
          • Formatters
        • Deserialisers
          • Custom parsing example
    • Observability
      • Enabling JMX for Joule
      • Meters
      • Metrics API
  • DEVELOPER GUIDES
    • Setting up developer environment
      • Environment setup
      • Build and deploy
      • Install Joule
        • Install Docker demo environment
        • Install with Docker
        • Install from source
        • Install Joule examples
    • Joulectl CLI
    • API Endpoints
      • Mangement API
        • Use case
        • Pipelines
        • Data connectors
        • Contextual data
      • Data access API
        • Query
        • Upload
        • WebSocket
      • SQL support
    • Builder SDK
      • Connector API
        • Sources
          • StreamEventParser API
        • Sinks
          • CustomTransformer API
      • Processor API
      • Analytics API
        • Create custom metrics
        • Define analytics
        • Windows API
        • SQL queries
      • Transformation API
        • Obfuscation API
        • FieldTokenizer API
      • File processing
      • Data types
        • StreamEvent
        • ReferenceDataObject
        • GeoNode
    • System configuration
      • System properties
  • Deployment strategies
    • Deployment Overview
    • Single Node
    • Cluster
    • GuardianDB
    • Packaging
      • Containers
      • Bare metal
  • Product updates
    • Public Roadmap
    • Release Notes
      • v1.2.0 Join Streams with stateful analytics
      • v1.1.0 Streaming analytics enhancements
      • v1.0.4 Predictive stream processing
      • v1.0.3 Contextual SQL based metrics
    • Change history
Powered by GitBook
On this page

Was this helpful?

  1. DEVELOPER GUIDES
  2. API Endpoints
  3. Mangement API

Contextual data

Register, list, detail and unregister contextual data sources

PreviousData connectorsNextData access API

Last updated 5 months ago

Was this helpful?

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 .

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"
            }
          }
        }
      }
    ]
  }
}

documentation

Get contextual data specification

get
Path parameters
namestringRequired

Data store logical name.

Responses
404
Failed to find data store using provided name.
500
Missing data store name.
get
GET /joule/management/contextualdata/detail HTTP/1.1
Host: 
Accept: */*

No content

Undeploy contextual data store

delete
Path parameters
namestringRequired

Data store logical name.

Responses
201
Successful transport unregister
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
DELETE /joule/management/contextualdata/undeploy HTTP/1.1
Host: 
Accept: */*

No content

  • Overview
  • Example contextual data content
  • POSTDeploy a single contextual data store
  • POSTDeploy multiple contextual data stores
  • GETGet contextual data specification
  • DELETEUndeploy contextual data store

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
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
POST /joule/management/contextualdata/deploy HTTP/1.1
Host: 
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
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
POST /joule/management/contextualdata/deploy/multi HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 129

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

No content