Clarity APIs

TIBCO Clarity provides a set of RESTful APIs. Integrated with Swagger, you can test these APIs in Swagger.

After launching TIBCO Clarity, click yourAccount/Settings > Clarity APIs. The Clarity Swagger API page is displayed.

According to the function of each API, Clarity APIs can be classified to the following groups:
  • The Key group contains a Generate Key API. You can use this API to generate an API key. This API key is used to authorize your account and is required when using Curl to invoke Clarity APIs.
    Note: The Generate Key API is only available for the cloud edition.
  • The workspace group contains APIs used to manage datasets, such as clone, delete, or close datasets.

    A workspace is created when you launch TIBCO Clarity where stores the datasets and projects that you have created.

  • The stream group contains APIs used to manage streaming batch jobs, such as start a new streaming batch job, delete a streaming batch job, or query streaming batch jobs.
  • The dataset group contains APIs used to manage projects in a dataset, such as create, delete, or rename a project.
  • The batch group contains APIs used to manage batch jobs, such as create, delete, and pause batch jobs, set source data of a batch job, download batch job results.
  • The column group contains APIs used to manage columns, such as delete and remove columns.
Contents
Search Results