> For the complete documentation index, see [llms.txt](https://docs.fractalworks.io/joule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api/use-case.md).

# Use case

## 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

```json
{
  "use case": {
    "name": "basic_twindow_analytics",
    "sources": [
      "nasdaq_quotes_stream"
    ],
    "stream name": "basic_tumbling_window_pipeline",
    "sinks": [
      "kafka_analytics_view"
    ]
  }
} 
```

***

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/deploy" method="post" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/detail" method="get" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/list" method="get" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/undeploy" method="delete" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}

***

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/pause" method="put" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}

{% openapi src="/files/GlCtcBKC4vfe3SdDJyJ9" path="/joule/management/usecase/resume" method="post" %}
[swagger-docs.json](https://3062398388-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUU6FZlV07ZD90OzbzGww%2Fuploads%2FwsbKvpoD11cLGV2xB6Dl%2Fswagger-docs.json?alt=media\&token=7d415513-0de4-40a2-9b02-d35b6d39c86f)
{% endopenapi %}