Version: 8.1.0
Teneo Inquire API Specification
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
API Endpoints
augmenters
This resource is only available when server type is either 'importer' or 'full'.
| Method | Path | Description |
|---|---|---|
post | /augmenters/actions/{lds} | Creates an action. |
post | /augmenters/adorners/{lds} | Creates an action to add an adorner. |
post | /augmenters/aggregators/{lds} | Creates an action to add an aggregator. |
delete | /augmenters/actions/{lds}/{actionId} | Deletes the specified waiting action. |
delete | /augmenters/actions/{lds} | Deletes all waiting actions. |
delete | /augmenters/adorners/{lds}/{adornerId} | Deletes the specified adorner. |
delete | /augmenters/aggregators/{lds}/{aggregatorId} | Deletes the specified aggregator. |
post | /augmenters/adorners/disable/{lds}/{adornerId} | Creates an action to disable an adorner. |
post | /augmenters/aggregators/disable/{lds}/{aggregatorId} | Creates an action to disable an aggregator. |
post | /augmenters/adorners/enable/{lds}/{adornerId} | Creates an action to enable an adorner. |
post | /augmenters/aggregators/enable/{lds}/{aggregatorId} | Creates an action to enable an aggregator. |
get | /augmenters/export/{lds} | Exports all augmenters in a zip file. |
get | /augmenters/actions/{lds}/{actionId} | Gets an action. |
get | /augmenters/actions/{lds} | Gets all actions. |
get | /augmenters/adorners/{lds}/{adornerId} | Gets an adorner. |
get | /augmenters/adorners/{lds} | Gets all adorners. |
get | /augmenters/aggregators/buckets/{lds} | Lists existing aggregator buckets. |
get | /augmenters/aggregators/{lds}/{aggregatorId} | Gets an aggregator. |
get | /augmenters/aggregators/{lds} | Gets all aggregators. |
get | /augmenters/overview/{lds} | Gets data overview. |
get | /augmenters/revisions/{lds} | Gets all solution revisions. The solution revisions are coming from the log archive which is resolved through the log data source name. |
post | /augmenters/import/{lds} | Imports augmenters contained in a zip file. |
post | /augmenters/actions/perform/{lds}/{actionId} | Performs execution of the specified waiting action. |
post | /augmenters/actions/perform/{lds} | Performs execution of all waiting actions. |
post | /augmenters/adorners/test/groovy/{lds} | Tests a Groovy adorner. |
post | /augmenters/aggregators/test/groovy/{lds} | Tests a Groovy aggregator. |
post | /augmenters/adorners/test/tql/{lds} | Tests a TQL adorner. |
post | /augmenters/aggregators/test/tql/{lds} | Tests a TQL aggregator. |
put | /augmenters/actions/{lds}/{actionId} | Saves an action. |
put | /augmenters/adorners/{lds}/{adornerId} | Creates an action to update an existing adorner. |
put | /augmenters/aggregators/{lds}/{aggregatorId} | Creates an action to update an existing aggregator. |
auth
| Method | Path | Description |
|---|---|---|
get | /auth/login/delegated/notification | Gets the access token for the delegated login. |
get | /auth/me | Gets user information from Teneo Manager. |
post | /auth/login | Logs a user in and returns an access token. |
post | /auth/logout | Logs a user out and invalidates the access token. |
get | /auth/login/delegated | Starts the delegated login. |
data
| Method | Path | Description |
|---|---|---|
get | /data/ldss | Gets the names of Log Data Sources. |
get | /data/session/{lds} | Retrieves session data. |
get | /data/overview/{lds} | Gets the Log Data Source's weekly session counts. |
import
This resource is only available when server type is either 'importer' or 'full'.
| Method | Path | Description |
|---|---|---|
post | /import/ldss/begin/{lds} | Starts the synchronization process. |
post | /import/ldss/cancel/{lds} | Cancels the synchronization process. |
delete | /import/log-archives/errors/{logArchiveId} | Clears the errors of failed sessions in the specified Log Archive. |
delete | /import/ldss/errors/{lds} | Clears the errors of failed sessions for the specified Log Data Source. |
post | /import/ldss/clear/{lds} | Clears all data for the specified Log Data Source. |
get | /import/log-archives/errors/{logArchiveId}/{sessionId} | Downloads the content of the failed session. |
get | /import/log-archives/errors/{logArchiveId} | Gets the errors of failed sessions in the specified Log Archive. |
get | /import/log-archives/overview/{logArchiveId} | Gets the Log Archive's overview of sessions per year-week. |
get | /import/log-archives/status/{logArchiveId} | Gets status of the current Log Archive import process. |
get | /import/ldss/errors/{lds} | Gets the errors of failed sessions for the specified Log Data Source. |
get | /import/ldss/count/{lds} | Gets the number of sessions in the Log Data Source. |
get | /import/ldss/status/{lds} | Gets status of the current import process. |
get | /import/ldss/weeks/{lds} | Lists the weeks in the Log Data Source. |
post | /import/session | Imports a specific session both to a Log Archive and to its linked Log Data Source. |
post | /import/log-archives/start/{logArchiveId} | Starts the import process. |
post | /import/log-archives/stop/{logArchiveId} | log-archives/stop/{logArchiveId} |
saved-results
| Method | Path | Description |
|---|---|---|
post | /saved-results/{lds}/{savedResultId} | Creates a saved result with the provided name in the specified Log Data Source. |
delete | /saved-results/{lds}/{savedResultId} | Deletes the specified saved result in the specified Log Data Source. |
get | /saved-results/export/{lds}/{savedResultId} | Exports the specified saved result from the Log Data Source to the specified format ('json' or 'csv'). |
get | /saved-results/export-package/{lds} | Exports saved results from the specified Log Data Source in json, packaged together in a zip file. |
get | /saved-results/{lds} | Lists all saved results for the specified Log Data Source. |
put | /saved-results/{lds}/{savedResultId} | Updates the specified saved result in the specified Log Data Source. |
tql
This resource is only available when server type is either 'query' or 'full'.
| Method | Path | Description |
|---|---|---|
get | /tql/cancel | Cancels a query execution. |
delete | /tql/shared-queries/{lds} | Deletes a TQL shared query. |
get | /tql/metadata/{lds} | Gets Log Data Source metadata. |
get | /tql/shared-queries/{lds} | Lists all TQL shared queries. |
post | /tql/solution-revisions | Executes a TQL query to get all solution revisions of the Log Data Source. |
get | /tql/poll | Polls for partial results of an asynchronous query. |
post | /tql/shared-queries/{lds} | Saves a TQL query. |
post | /tql/submit | Executes a TQL query asynchronously. The Data Role permission is also needed if a save clause exists. |
post | /tql/shared-queries/submit/{lds} | Executes a Shared TQL query asynchronously. The Data Role permission is also needed if a save clause exists. |