Use case
Deploy, pause, resume and undeploy use cases
Overview
The Use case API allows developers to deploy, test, validate and undeploy use case. Use case definitions provide the required binding of the stream and data transports.
For further information on the structure of the content payload refer to this documentation.
Example use case content
{
"use case": {
"name": "basic_twindow_analytics",
"sources": [
"nasdaq_quotes_stream"
],
"stream name": "basic_tumbling_window_pipeline",
"sinks": [
"kafka_analytics_view"
]
}
}
Deploy and start a use case processing using pre-registered components
Successful deployed and started use case
Failed to use case due to malformed or missing DSL
Failed to start use case. Check Joule service log files.
Use case has already been deployed and started.
Failed to deploy and start use case. Check Joule system logs.
POST /joule/management/usecase/deploy HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 766
{
"name": "text",
"enabled": true,
"sources": [
"text"
],
"referenceDataSources": [
"text"
],
"streamName": "text",
"sinks": [
"text"
],
"streamSpecification": {
"name": "text",
"enabled": true,
"sources": [
"text"
],
"bufferSize": 1,
"checkPointProcessing": true,
"groupbyKey": {
"keys": [
"text"
],
"partitionKey": 1
},
"groupByAttributes": [
"text"
],
"streamTimeType": "INGEST_TIME",
"propertiesPath": "text",
"consumerQueueSize": 1,
"consumingFrequency": 1,
"publishingQueueSize": 1,
"publishingFrequency": 1,
"telemetryAuditingSpecification": {
"name": "text",
"enabled": true,
"rawTelemetrySpecification": {
"cloneEvents": true,
"auditFrequency": 1
},
"processedTelemetrySpecification": {
"cloneEvents": true,
"auditFrequency": 1
}
}
},
"processingConstraints": {
"validFrom": "2025-08-22T13:04:31.299Z",
"validTo": "2025-08-22T13:04:31.299Z"
}
}
No content
Stop and undeploy a use case from the Joule process
Name of use case to unregistered
quoteStream
Successfully unregistered use case
Failed to unregister use case. Check Joule service log files.
DELETE /joule/management/usecase/undeploy?name=quoteStream HTTP/1.1
Host:
Accept: */*
No content
Nane of stream to resume processing
quoteStream
Successful restarted stream processing
Failed to restart stream. Check Joule service log files.
POST /joule/management/usecase/resume HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?