Version: 8.1.0
Teneo Studio API Specification
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
API Endpoints
admin
This resource is only available for ADMIN tokens.
| Method | Path | Description |
|---|---|---|
post | /admin/maintenance/daily/begin | Starts the daily maintenance task. |
post | /admin/maintenance/hourly/begin | Starts the hourly maintenance task. |
get | /admin/maintenance/daily/status | Returns the daily maintenance task status and last result. |
get | /admin/maintenance/hourly/status | Returns the hourly maintenance task status and last result. |
auth
| Method | Path | Description |
|---|---|---|
get | /auth/login/delegated/notification | Gets the access token once the delegated login finished. Long polling endpoint. |
get | /auth/me | Returns the current user info for the used token. |
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 workflow and returns the URL to be shown to the user. |
auto-tests
| Method | Path | Description |
|---|---|---|
post | /auto-tests/begin/{solutionId}/{documentId} | Starts autotest of the specified document. |
post | /auto-tests/begin/{solutionId} | Starts autotest of the whole solution. |
post | /auto-tests/summaries/export-xls/begin/{solutionId} | Exports the test summaries in xls format. |
get | /auto-tests/summaries/flow/{solutionId}/{flowId} | Gets all test summaries related to the flow; test results are not included. |
get | /auto-tests/summaries/{solutionId} | Gets all test summaries; test results are not included. |
get | /auto-tests/summaries/{solutionId}/{summaryId} | Gets the specified test summary. |
get | /auto-tests/summaries/export-xls/result/{taskId} | Gets the result of the xls export task. |
batch-requests
| Method | Path | Description |
|---|---|---|
post | /batch-requests/begin | Starts a generic batch request; returns the task Id. |
get | /batch-requests/result/{taskId} | Gets the result of a generic batch request task. |
bulk-import
| Method | Path | Description |
|---|---|---|
post | /bulk-import/begin/{taskId} | Starts a pending bulk import task. |
delete | /bulk-import/discard/{taskId} | Discards a pending bulk import task without running it. |
get | /bulk-import/result/{taskId} | Returns the result of a bulk import task. |
post | /bulk-import/validate/{solutionId}/{targetFolderId} | Validates a given bulk import file, prepares an import task and returns a preview of the documents to import. |
classes
| Method | Path | Description |
|---|---|---|
post | /classes/{solutionId} | Creates a class. |
delete | /classes/{solutionId}/{classId} | Deletes the specified class. |
get | /classes/{solutionId}/{classId}/{version} | Gets the specified version of the class. |
get | /classes/{solutionId}/{classId} | Gets a class. |
get | /classes/{solutionId} | Gets the list of classes. |
put | /classes/{solutionId}/{classId} | Updates the specified class. |
clu
| Method | Path | Description |
|---|---|---|
post | /clu/models/remove/begin/{solutionId}/{modelId} | Removes a CLU model. |
post | /clu/models/train/begin/{solutionId} | Starts a CLU model training for the current solution. |
get | /clu/models/{solutionId} | Returns the CLU models of a solution. |
copilot
| Method | Path | Description |
|---|---|---|
post | /copilot/generate-examples/begin | Starts generating examples. |
get | /copilot/generate-examples/result/{taskId} | Gets the result of the generate examples task. |
customers
| Method | Path | Description |
|---|---|---|
post | /customers/settings/llm/{accountId} | Create a LLM settings configuration. |
post | /customers/settings/secret/{accountId} | Create a secret settings configuration for the given account. |
delete | /customers/settings/llm/{accountId}/{settingsId} | Delete the specific LLM settings configuration. |
delete | /customers/settings/secret/{accountId}/{settingsId} | Delete the specific secret settings configuration. |
get | /customers/settings/clu/{accountId} | Returns the current CLU resource name or null if not configured. |
get | /customers/current | Returns the current selected customer for the user's session. |
get | /customers | Returns the list of customers. |
get | /customers/settings/llm/{accountId} | Returns all the LLM settings configurations. |
get | /customers/settings/secret/{accountId} | Returns all the secret settings configurations for the given account. |
post | /customers/switch/{customerId} | Switch the customer in the user's session. |
put | /customers/settings/clu/{accountId} | Set the CLU configuration. |
put | /customers/settings/llm/{accountId}/{settingsId} | Update the specific LLM settings configuration. |
put | /customers/settings/secret/{accountId}/{settingsId} | Update the specific secret settings configuration. |
deferred-annotation-scripts
| Method | Path | Description |
|---|---|---|
post | /deferred-annotation-scripts/{solutionId} | Creates a deferred annotation script. |
delete | /deferred-annotation-scripts/{solutionId}/{deferredAnnotationScriptId} | Deletes the specified deferred annotation script. |
post | /deferred-annotation-scripts/generate-script | Generates a script template with all the annotations required. |
get | /deferred-annotation-scripts/{solutionId}/{deferredAnnotationScriptId}/{version} | Gets the specified version of a deferred annotation script. |
get | /deferred-annotation-scripts/{solutionId}/{deferredAnnotationScriptId} | Gets a deferred annotation script. |
get | /deferred-annotation-scripts/{solutionId} | Gets the list of deferred annotation scripts. |
put | /deferred-annotation-scripts/{solutionId}/{deferredAnnotationScriptId} | Updates the specified deferred annotation script. |
documents
| Method | Path | Description |
|---|---|---|
post | /documents/copy/{solutionId}/{documentId}/{targetSolutionId}/{targetFolderId} | Copies a document to a target folder in the same or different solution. |
delete | /documents/delete/{solutionId}/{documentId} | Deletes the document (flow, entity or language object). |
post | /documents/disable/{solutionId}/{documentId} | Disables the document (flow, entity or language object). |
post | /documents/enable/{solutionId}/{documentId} | Enables the document (flow, entity or language object). |
post | /documents/exclude/{solutionId}/{documentId} | Excludes the document. |
post | /documents/include/{solutionId}/{documentId} | Includes the document. |
post | /documents/move/{solutionId}/{documentId}/{targetFolderId} | Moves a document to a target folder. |
post | /documents/rename/{solutionId}/{documentId} | Renames the document (flow, entity or language object). |
emotions
| Method | Path | Description |
|---|---|---|
post | /emotions/{solutionId} | Creates an emotion. |
delete | /emotions/{solutionId}/{emotionId} | Deletes the specified emotion. |
get | /emotions/{solutionId}/{emotionId}/{version} | Gets the specified version of an emotion. |
get | /emotions/{solutionId}/{emotionId} | Gets an emotion. |
get | /emotions/{solutionId} | Gets the list of emotions. |
put | /emotions/{solutionId}/{emotionId} | Updates the specified emotion. |
engines
| Method | Path | Description |
|---|---|---|
post | /engines/condition-matching-triggers/begin/{solutionId} | Starts a background task which sends a syntax condition to the current Tryout engine to find all triggers matching the syntax; returns the task Id which can be used to retrieve the results. |
post | /engines/xml-export/begin/{solutionId} | Starts a task which exports the engine XML of the solution based on the current Tryout session; returns the task Id which can be used to retrieve the XML. |
get | /engines/messages/{solutionId} | Gets the list of engine messages from the solution's current Tryout engine. |
get | /engines/tie-api/input/{tieApiToken} | Creates a TIE API interaction with the running tryout engine. |
post | /engines/tie-api/input/{tieApiToken} | Creates a TIE API interaction with the running tryout engine. It consumes content type application/json. |
post | /engines/input/{solutionId} | Sends an input to the solution's current Tryout engine and returns the response. |
get | /engines/status/{solutionId} | Gets the status of the solution's current Tryout engine. |
get | /engines | Gets a list of solution Ids where an engine is running for the current user session. |
post | /engines/matching-triggers/{solutionId} | Sends an input to the solution's current Tryout engine and returns a list of trigger Ids matching the input. |
get | /engines/tie-api/interactions | Returns the TIE API interactions that happened since the last call to this endpoint for the running tryout engine. |
get | /engines/tie-api/token | Returns the TIE API token to be used in TIE API endpoints. |
get | /engines/condition-matching-triggers/result/{taskId} | Gets the result of all triggers matching a syntax condition. |
get | /engines/xml-export/result/{taskId} | Gets the result of the engine XML export task, if finished. |
post | /engines/reload/{solutionId} | Terminates the solution's current Tryout engine and starts a new one. Returns a list of engine messages for the terminated engine. |
get | /engines/tie-api/input/{tieApiToken}/endsession | Stops the current session and starts a new one in the Tryout engine of the solution using the TIE API interface. |
post | /engines/tie-api/input/{tieApiToken}/endsession | Stops the current session and starts a new one in the Tryout engine of the solution using the TIE API interface. It consumes content type application/json. |
post | /engines/restart-session/{solutionId} | Stops the current session and starts a new one in the Tryout engine of the solution. |
post | /engines/shutdown/{solutionId} | Terminates the solution's current Tryout engine and returns the engine messages. |
post | /engines/start-session/{solutionId} | Starts a new session in the solution's Tryout engine. |
post | /engines/start/{solutionId} | Starts a new Tryout engine in the specified solution. |
post | /engines/stop-session/{solutionId} | Stops the current session in the solution's Tryout engine. |
entities
| Method | Path | Description |
|---|---|---|
post | /entities/{solutionId} | Creates an entity. |
delete | /entities/{solutionId}/{entityId} | Deletes the specified entity. |
get | /entities/headers/{solutionId} | Gets headers of all entities. |
get | /entities/{solutionId}/{entityId}/{version} | Gets the specified version of the entity. |
get | /entities/{solutionId}/{entityId} | Gets the entity. |
put | /entities/{solutionId}/{entityId} | Updates the specified entity. |
file-resources
| Method | Path | Description |
|---|---|---|
post | /file-resources/{solutionId} | Creates a file resource with content. |
delete | /file-resources/{solutionId}/{fileResourceId} | Deletes the specified file resource. |
get | /file-resources/content/{solutionId}/{fileResourceId}/{version} | Gets the file resource's content of the specified version. |
get | /file-resources/content/{solutionId}/{fileResourceId} | Gets a file resource's content. |
get | /file-resources/{solutionId}/{fileResourceId}/{version} | Gets the specified version of a file resource. |
get | /file-resources/{solutionId}/{fileResourceId} | Gets a file resource. |
get | /file-resources/{solutionId} | Gets a list of the solution's file resources. |
put | /file-resources/{solutionId}/{fileResourceId} | Updates the specified file resource and/or its content. |
flows
| Method | Path | Description |
|---|---|---|
post | /flows/{solutionId} | Creates a flow. |
delete | /flows/{solutionId}/{flowId} | Deletes a flow |
get | /flows/headers/{solutionId} | Gets headers of all flows. |
get | /flows/{solutionId}/{flowId}/{version} | Gets the specified version of a flow. |
get | /flows/{solutionId}/{flowId} | Gets a flow. |
put | /flows/{solutionId}/{flowId} | Updates the specified flow. |
folders
| Method | Path | Description |
|---|---|---|
post | /folders/copy/begin/{solutionId}/{folderId}/{targetSolutionId}/{targetFolderId} | Starts the copy of a folder to a target folder in the same or different solution. |
post | /folders/disable/begin/{solutionId}/{folderId} | Starts the disabling of the folder's content. |
post | /folders/disable/begin/{solutionId} | Starts the disabling of the solution's content. |
post | /folders/enable/begin/{solutionId}/{folderId} | Starts the enabling of the solution's content. |
post | /folders/enable/begin/{solutionId} | Starts the enabling of the folder's content. |
post | /folders/exclude/begin/{solutionId}/{folderId} | Starts the exclusion of the folder's content. |
post | /folders/exclude/begin/{solutionId} | Starts the exclusion of the solution's content. |
post | /folders/include/begin/{solutionId}/{folderId} | Starts the inclusion of the folder's content. |
post | /folders/include/begin/{solutionId} | Starts a task to include the content of the solution. |
post | /folders/{solutionId} | Creates a folder. |
delete | /folders/{solutionId}/{folderId} | Deletes the specified folder. |
get | /folders/copy/result/{taskId} | Gets the result of the copy folder task. |
get | /folders/disable/result/{taskId} | Gets the result of the disable folder content task. |
get | /folders/enable/result/{taskId} | Gets the result of the enable folder content task. |
get | /folders/exclude/result/{taskId} | Gets the result of the exclude folder content task. |
get | /folders/{solutionId}/{folderId} | Gets a folder. |
get | /folders/{solutionId}/{folderId}/{version} | Gets the specified version of the folder. |
get | /folders/{solutionId} | Gets the root folder. |
get | /folders/include/result/{taskId} | Gets the result of the include folder content task. |
post | /folders/move/{solutionId}/{folderId}/{targetFolderId} | Moves a folder to a target folder. |
post | /folders/rename/{solutionId}/{folderId} | Renames the folder's name. |
put | /folders/{solutionId}/{folderId} | Updates the specified folder. |
gen-ai
| Method | Path | Description |
|---|---|---|
post | /gen-ai/annotators/{solutionId} | Creates a GenAI annotator. |
post | /gen-ai/goals/{solutionId} | Creates a GenAI goal. |
post | /gen-ai/handlers/{solutionId} | Creates a GenAI handler. |
post | /gen-ai/personalities/{solutionId} | Creates a GenAI personality. |
delete | /gen-ai/annotators/{solutionId}/{annotatorId} | Deletes the specified GenAI annotator. |
delete | /gen-ai/goals/{solutionId}/{goalId} | Deletes the specified GenAI goal. |
delete | /gen-ai/handlers/{solutionId}/{handlerId} | Deletes the specified GenAI handler. |
delete | /gen-ai/personalities/{solutionId}/{personalityId} | Deletes the specified personality. |
get | /gen-ai/annotators/{solutionId}/{annotatorId}/{version} | Gets the specified version of a GenAI annotator. |
get | /gen-ai/annotators/{solutionId}/{annotatorId} | Gets the specified GenAI annotator. |
get | /gen-ai/annotators/{solutionId} | Gets all GenAI annotators. |
get | /gen-ai/flow-tasks/{solutionId}/{flowId} | Gets the GenAI flow tasks for a specific flow. |
get | /gen-ai/flow-tasks/{solutionId} | Gets the list of all the GenAI flow tasks for a given solution. |
get | /gen-ai/goals/{solutionId}/{goalId}/{version} | Gets the specified version of a GenAI goal. |
get | /gen-ai/goals/{solutionId}/{goalId} | Gets the specified GenAI goal. |
get | /gen-ai/goals/{solutionId} | Gets all GenAI goals. |
get | /gen-ai/handlers/template | Gets the GenAI handler template. |
get | /gen-ai/handlers/{solutionId}/{handlerId}/{version} | Gets the specified version of the GenAI handler. |
get | /gen-ai/handlers/{solutionId}/{handlerId} | Gets the specified GenAI handler. |
get | /gen-ai/handlers/{solutionId} | Gets all GenAI handlers. |
get | /gen-ai/personalities/{solutionId} | Gets all GenAI personalities. |
get | /gen-ai/personalities/{solutionId}/{personalityId}/{version} | Gets the specified version of a personality. |
get | /gen-ai/personalities/{solutionId}/{personalityId} | Gets the specified GenAI personality. |
get | /gen-ai/prompt/{solutionId}/{genAITaskId} | Gets the composed prompt related to a given genai task. |
put | /gen-ai/annotators/{solutionId}/{annotatorId} | Updates the specified GenAI annotator. |
put | /gen-ai/goals/{solutionId}/{goalId} | Updates the specified GenAI goal. |
put | /gen-ai/handlers/{solutionId}/{handlerId} | Updates the specified GenAI handler. |
put | /gen-ai/personalities/{solutionId}/{personalityId} | Updates the specified personality. |
generate
| Method | Path | Description |
|---|---|---|
post | /generate/condition/begin/{solutionId} | Starts a task to generate a TLML condition for given examples. |
post | /generate/match-requirement/transition/begin/{solutionId} | Starts a task to generate a match requirement for a transition. |
post | /generate/match-requirement/trigger/begin/{solutionId} | Starts a task to generate a class match requirement for a trigger. |
get | /generate/condition/result/{taskId} | Returns the result of a TLML condition generation task. |
get | /generate/match-requirement/transition/result/{taskId} | Returns the result of a transition match requirement generation task. |
get | /generate/match-requirement/trigger/result/{taskId} | Returns the result of a trigger match requirement generation task. |
global-listeners
| Method | Path | Description |
|---|---|---|
post | /global-listeners/{solutionId} | Creates a global listener. |
delete | /global-listeners/{solutionId}/{globalListenerId} | Deletes the specified global listener. |
get | /global-listeners/{solutionId}/{globalListenerId}/{version} | Gets the specified version of the global listener. |
get | /global-listeners/{solutionId}/{globalListenerId} | Gets a global listener. |
get | /global-listeners/{solutionId} | Gets a list of the solution's global listeners. |
get | /global-listeners/ordering/{solutionId}/{version} | Gets the specified version of the global listener ordering. |
get | /global-listeners/ordering/{solutionId} | Gets the global listener ordering. |
put | /global-listeners/{solutionId}/{globalListenerId} | Updates the specified global listener. |
put | /global-listeners/ordering/{solutionId} | Updates the global listener ordering. |
global-scripts
| Method | Path | Description |
|---|---|---|
post | /global-scripts/{solutionId} | Creates a global script. |
delete | /global-scripts/{solutionId}/{globalScriptId} | Deletes the specified global script. |
get | /global-scripts/ordering/{solutionId} | Gets the global script ordering. |
get | /global-scripts/ordering/{solutionId}/{version} | Gets the specified version of the global script ordering. |
get | /global-scripts/{solutionId}/{globalScriptId}/{version} | Gets the specified version of the global script. |
get | /global-scripts/{solutionId}/{globalScriptId} | Gets a global script. |
get | /global-scripts/{solutionId} | Gets a list of the solution's global scripts. |
put | /global-scripts/ordering/{solutionId} | Updates the global script ordering. |
put | /global-scripts/{solutionId}/{globalScriptId} | Updates the specified global script. |
global-variables
| Method | Path | Description |
|---|---|---|
post | /global-variables/{solutionId} | Creates a global variable. |
delete | /global-variables/{solutionId}/{globalVariableId} | Deletes the specified global variable. |
get | /global-variables/{solutionId}/{globalVariableId}/{version} | Gets the specified version of the global variable. |
get | /global-variables/{solutionId}/{globalVariableId} | Gets a global variable. |
get | /global-variables/{solutionId} | Gets a list of the solution's global variables. |
put | /global-variables/{solutionId}/{globalVariableId} | Updates the specified global variable. |
input-processors
| Method | Path | Description |
|---|---|---|
get | /input-processors/custom-settings-template/{solutionId} | Gets the custom input processor template from the solution. |
integrations
| Method | Path | Description |
|---|---|---|
post | /integrations/{solutionId} | Creates an integration. |
delete | /integrations/{solutionId}/{integrationId} | Deletes the specified integration. |
get | /integrations/{solutionId}/{integrationId}/{version} | Gets the specified version of the integration. |
get | /integrations/{solutionId}/{integrationId} | Gets the integration. |
get | /integrations/{solutionId} | Gets all integrations. |
put | /integrations/{solutionId}/{integrationId} | Updates the specified integration. |
intent-models
| Method | Path | Description |
|---|---|---|
post | /intent-models/evaluations/begin/{solutionId} | Starts an intent model evaluation. |
get | /intent-models/assignment/{solutionId}/{version} | Gets the specified version of the intent model assignment. |
get | /intent-models/assignment/{solutionId} | Gets the intent model assignment. |
get | /intent-models/evaluations/{solutionId}/{evaluationId} | Gets an intent model evaluation. |
get | /intent-models/evaluations/{solutionId} | Gets the intent model evaluations. |
put | /intent-models/assignment/{solutionId} | Updates the intent model assignment. |
intent-triggers
| Method | Path | Description |
|---|---|---|
post | /intent-triggers/ordering/auto-ordering/begin/{solutionId} | Starts an asynchronous auto-ordering task of intent triggers. |
get | /intent-triggers/ordering/auto-ordering/result/{taskId} | Gets the result of an auto-ordering task. |
get | /intent-triggers/ordering/{solutionId}/{version} | Gets the specified version of the intent trigger ordering data. |
get | /intent-triggers/ordering/{solutionId} | Gets the intent trigger ordering data. |
put | /intent-triggers/ordering/{solutionId} | Updates the intent trigger ordering data. |
language-objects
| Method | Path | Description |
|---|---|---|
post | /language-objects/{solutionId} | Creates a language object. |
delete | /language-objects/{solutionId}/{languageObjectId} | Deletes the specified language object. |
get | /language-objects/headers/{solutionId} | Gets headers of all language objects. |
get | /language-objects/{solutionId}/{languageObjectId}/{version} | Gets the specified version of the language object. |
get | /language-objects/{solutionId}/{languageObjectId} | Gets the language object. |
put | /language-objects/{solutionId}/{languageObjectId} | Updates the specified language object. |
libraries
| Method | Path | Description |
|---|---|---|
post | /libraries/export/begin/{solutionId} | Starts a task to export a library. |
post | /libraries/begin | Starts a task to import a library. |
delete | /libraries/{libraryId}/{libraryVersion} | Deletes a library. |
get | /libraries/assignments/{libraryId}/{libraryVersion} | Gets the list of solutions which have this library assigned. |
get | /libraries/entity/{libraryId}/{libraryVersion}/{entityId} | Gets the entity from the library. |
get | /libraries/export/result/{taskId} | Gets the file resulting from a library export task. |
get | /libraries/folder/{libraryId}/{libraryVersion} | Gets the root folder of the specified library. |
get | /libraries/folder/{libraryId}/{libraryVersion}/{folderId} | Gets the specified folder from the specified library. |
get | /libraries/language-object/{libraryId}/{libraryVersion}/{languageObjectId} | Gets the language object from the library. |
get | /libraries | Returns the list of libraries. Optionally the language can be specified. |
get | /libraries/{libraryId}/{libraryVersion} | Returns a library. |
get | /libraries/solution/{solutionId}/{version} | Returns the list of libraries assigned to a particular solution at a version. |
get | /libraries/solution/{solutionId} | Returns the list of libraries assigned to a particular solution. |
put | /libraries/solution/{solutionId} | Updates the list of libraries assigned to a particular solution. |
library-conflicts
| Method | Path | Description |
|---|---|---|
post | /library-conflicts/begin/{solutionId} | Starts resolving the library conflicts. |
get | /library-conflicts/{solutionId} | Gets a list of the library conflicts. |
get | /library-conflicts/result/{taskId} | Gets the result of the resolve the library conflicts task. |
locks
| Method | Path | Description |
|---|---|---|
post | /locks/{solutionId}/{documentId} | Locks the document defined by its documentId and returns a lockToken. |
delete | /locks/{lockToken} | Removes a lock defined by its lockToken. |
log-archives
| Method | Path | Description |
|---|---|---|
get | /log-archives | Returns all log archives linked to the current customer. |
log-data-sources
master-local
| Method | Path | Description |
|---|---|---|
post | /master-local/changes/begin/{solutionId} | Starts an asynchronous task to collect the changes made to the master solution that can be applied to the specified local solution. |
post | /master-local/update/begin/{solutionId} | Starts an asynchronous task to update the specified local solution with changes made to its master solution. |
get | /master-local/changes/result/{taskId} | Gets the list of changes made to a master solution collected by the specified task. |
get | /master-local/changes/{solutionId}/{documentId} | Gets the list of changes made to the master solution that can be applied to the specified local solution for the specified document. |
get | /master-local/update/result/{taskId} | Gets the list of Report objects for the specified master-local update task. |
post | /master-local/reset/{solutionId}/{documentId} | Resets the specified local solution document to its state in the master solution. |
metadata-definitions
| Method | Path | Description |
|---|---|---|
post | /metadata-definitions/{solutionId} | Creates a metadata definition. |
delete | /metadata-definitions/{solutionId}/{metadataDefinitionId} | Deletes the specified metadata definition. |
get | /metadata-definitions/{solutionId}/{metadataDefinitionId}/{version} | Gets the specified version of the metadata definition. |
get | /metadata-definitions/{solutionId}/{metadataDefinitionId} | Gets a metadata definition. |
get | /metadata-definitions/{solutionId} | Gets a list of the solution's metadata definitions. |
put | /metadata-definitions/{solutionId}/{metadataDefinitionId} | Updates the specified metadata definition. |
optimization
| Method | Path | Description |
|---|---|---|
post | /optimization/query/begin/{solutionId}/{logDataSourceId} | Begins an optimization query and returns the task identifier. |
get | /optimization/query/result/{taskId} | Gets the result of an optimization query. |
post | /optimization/reviewed-inputs/{solutionId}/{logDataSourceId} | Saves reviewed inputs. |
prompt-triggers
| Method | Path | Description |
|---|---|---|
get | /prompt-triggers/ordering/{solutionId}/{version} | Gets the specified version of the prompt trigger ordering data. |
get | /prompt-triggers/ordering/{solutionId} | Gets the prompt trigger ordering data. |
put | /prompt-triggers/ordering/{solutionId} | Updates the prompt trigger ordering data. |
publish-environments
| Method | Path | Description |
|---|---|---|
post | /publish-environments/publish/begin/{solutionId}/{environmentId} | Starts publishing the solution. |
post | /publish-environments/unpublish/begin/{solutionId}/{environmentId} | Starts unpublishing the solution. |
post | /publish-environments/status/update/begin/{solutionId}/{environmentId} | Starts a task to update the status of the publish environment's targets. |
post | /publish-environments/pre-configured/{solutionId}/{type} | Creates the preconfigured publish environment. |
post | /publish-environments/targets/{solutionId}/{environmentId} | Creates a publish target and adds it to the publish environment; the data model's admin password is not shown in the response. |
post | /publish-environments/{solutionId} | Creates a publish environment. |
delete | /publish-environments/targets/{solutionId}/{targetId} | Deletes the specified publish target. |
delete | /publish-environments/{solutionId}/{environmentId} | Deletes the specified publish environment. |
get | /publish-environments/publish/file/result/{taskId} | Gets the result of the file publishing task. |
get | /publish-environments/history/{solutionId}/{environmentId} | Gets the version history of a publish environment. |
get | /publish-environments/status/{solutionId} | Gets the status of all publish targets. |
get | /publish-environments/status/update/result/{taskId} | Gets the result of the publish environment status update task. |
get | /publish-environments/status/{solutionId}/{targetId} | Gets the status of the specified publish target. |
get | /publish-environments/targets/{solutionId}/{targetId} | Gets the publish target; the data model's admin password is not shown in the response. |
get | /publish-environments/{solutionId}/{environmentId} | Gets the specified publish environment. |
get | /publish-environments/{solutionId} | Gets all publish environments in the specified solution. |
get | /publish-environments/published-url/{solutionId}/{environmentId} | Gets the published solution's URL. |
get | /publish-environments/publish/webapp/result/{taskId} | Gets the result of the web app publishing task. |
get | /publish-environments/unpublish/webapp/result/{taskId} | Gets the result of the web app unpublish task. |
put | /publish-environments/targets/{solutionId}/{targetId} | Updates a publish target. In the request, if the data model's admin password is empty, it will not be changed; the data model's admin password is not shown in the response. |
put | /publish-environments/{solutionId}/{environmentId} | Updates the specified publish environment. |
recycle-bin
| Method | Path | Description |
|---|---|---|
post | /recycle-bin/batch-restore/begin/{solutionId}/{targetFolderId} | Starts restoring a list of documents under a specified target. |
post | /recycle-bin/batch-restore/begin/{solutionId} | Starts restoring a list of documents. |
get | /recycle-bin/batch-restore/result/{taskId} | Gets the result of the restoring task. |
get | /recycle-bin/headers/{solutionId} | Gets the headers of the documents in the recycle bin. |
scripted-contexts
| Method | Path | Description |
|---|---|---|
post | /scripted-contexts/{solutionId} | Creates a scripted context. |
delete | /scripted-contexts/{solutionId}/{scriptedContextId} | Deletes the specified scripted context. |
get | /scripted-contexts/{solutionId}/{scriptedContextId}/{version} | Gets the specified version of the scripted context. |
get | /scripted-contexts/{solutionId}/{scriptedContextId} | Gets the scripted context. |
get | /scripted-contexts/{solutionId} | Gets all scripted contexts. |
put | /scripted-contexts/{solutionId}/{scriptedContextId} | Updates the specified scripted context. |
search
| Method | Path | Description |
|---|---|---|
post | /search/language-components/condition/begin/{solutionId} | Starts searching a condition. |
post | /search/language-components/engine-match/begin/{solutionId} | Starts searching an engine match. |
post | /search/language-components/name-or-alias/exact/begin/{solutionId} | Starts searching a list of language components by name. |
post | /search/language-components/name-or-alias/begin/{solutionId} | Starts searching a name or alias which starts with a text. |
get | /search/language-components/condition/result/{taskId} | Gets the result of the condition search task. |
get | /search/language-components/engine-match/result/{taskId} | Gets the result of the engine match task. |
get | /search/language-components/name-or-alias/exact/result/{taskId} | Gets the result of language components by name task. |
get | /search/language-components/name-or-alias/result/{taskId} | Gets the result of the name or alias search task. |
solution-logs
| Method | Path | Description |
|---|---|---|
get | /solution-logs | Gets all solution logs from all solutions. |
get | /solution-logs/{solutionId} | Gets all solution logs from the specified solution. |
solution-suggestions
| Method | Path | Description |
|---|---|---|
post | /solution-suggestions/acknowledge/{solutionId}/{suggestionId} | Acknowledges the specified suggestion. |
get | /solution-suggestions/document/{solutionId}/{documentId} | Gets the suggestions for the specified document. |
get | /solution-suggestions/{solutionId}/{suggestionId} | Gets the suggestion with the specified identifier. |
get | /solution-suggestions/{solutionId} | Gets the suggestions for the specified solution. |
post | /solution-suggestions/unacknowledge/{solutionId}/{suggestionId} | Unacknowledges the specified suggestion. |
solutions
| Method | Path | Description |
|---|---|---|
post | /solutions/begin | Starts the creation of a solution. |
post | /solutions/export/begin/{solutionId} | Starts exporting the specified solution. |
put | /solutions/begin/{solutionId} | Starts updating the solution. |
delete | /solutions/{solutionId} | Deletes the specified solution. |
get | /solutions/export/result/{taskId} | Gets the file resulting from a solution export task. |
get | /solutions/properties/{solutionId}/{version} | Gets the specified version of the solution's properties. |
get | /solutions/properties/{solutionId} | Gets the solution's properties. |
get | /solutions/owners/{solutionId} | Gets the solution's owners. |
get | /solutions/statistics/{solutionId} | Gets the solution's statistics. |
get | /solutions/result/{taskId} | Gets the result of the create solution task. |
get | /solutions/{solutionId} | Gets the specified solution. |
get | /solutions | Gets a list of the solutions. |
put | /solutions/properties/{solutionId} | Updates the solution's properties. |
put | /solutions/owners/{solutionId} | Updates the solution's owners. |
stable-versions
| Method | Path | Description |
|---|---|---|
get | /stable-versions/{solutionId}/{documentId} | Gets all stable versions of the document; i.e., versions where the document has been set to stable. |
get | /stable-versions/{solutionId} | Gets a list of the solution's stable documents. |
post | /stable-versions/set/{solutionId}/{documentId}/{version} | Sets the specified version of the document to stable. |
post | /stable-versions/set/{solutionId}/{documentId} | Sets the latest version of the specified document to stable. |
post | /stable-versions/folder/set/{solutionId}/{folderId} | Sets the content of the specified folder to stable. |
post | /stable-versions/folder/set/{solutionId} | Sets the content of the solution folder to stable. |
post | /stable-versions/set/{solutionId}/{revision} | Sets all documents of the specified solution revision to stable. |
post | /stable-versions/unset/{solutionId}/{documentId} | Unsets a document's stable version. |
post | /stable-versions/folder/unset/{solutionId}/{folderId} | Unsets the stable version of specified folder's content. |
post | /stable-versions/folder/unset/{solutionId} | Unsets the stable version of the solution folder's content. |
post | /stable-versions/unset/{solutionId} | Unsets the stable version of a solution. |
tasks
| Method | Path | Description |
|---|---|---|
post | /tasks/cancel/{taskId} | Cancels a task. |
get | /tasks/{taskId} | Gets the specified task. |
get | /tasks | Gets the list of tasks. |
templates
| Method | Path | Description |
|---|---|---|
get | /templates/{language} | Gets templates for the specified language. |
users
| Method | Path | Description |
|---|---|---|
get | /users | Gets the list of users for the current customer/account. |
versions
| Method | Path | Description |
|---|---|---|
get | /versions/history/{solutionId}/{documentId} | Gets the history of the specified document. |
post | /versions/restore/{solutionId}/{documentId}/{version} | Restores the specified version of the document. |
web-sockets
| Method | Path | Description |
|---|---|---|
get | /web-sockets/token | Gets a temporary authentication token for a web socket connection for the same user session. |