- closeProject
- convertGFAResultToScenario
- convertNOResultToScenario
- convertSSEResultToScenario
- convertVariationResultToScenario
- copyScenario
- copyScenarioSynchronously
- createNewVariableParameter
- createVariableParameter
- deleteVariableParameter
- doesVariableParameterHasSelectedData
- dropLicense
- exportDashboardPage
- findAndOpenProjectByName
- getComparisonResultData
- getCurrentUser
- getExistingVariableParameterTableData
- getExperiment
- getExperimentDashboardPage
- getExperimentDashboardPages
- getExperimentOptions
- getExperimentRunConfiguration
- getExperimentRunResult
- getExperimentRunResultChartGraphData
- getExperimentRunResultChartTableData
- getExperimentRunResultOptions
- getExperimentRunResultPageCharts
- getExperimentRunResultPages
- getExperimentRunsForScenario
- getExperimentStatus
- getExperiments
- getImportStatus
- getNewVariableParameterTableData
- getProjects
- getScenarioValidationStatus
- getScenarios
- getScenariosFromImportedDatabase
- getStatisticsConfigurations
- getTablesMeta
- getValidationErrors
- getValidationWarnings
- getVariableParameterObjectType
- getVariableParameterObjectTypes
- getVariableParameterObjects
- getVariableParameterParameters
- getVariableParameterVariationTypes
- getVariationResultData
- importCancel
- importDatabase
- importDatabaseExisting
- importExcel
- importExcelExisting
- importScenario
- importScenarioExisting
- openProject
- removeScenarioById
- requestLicense
- runExperiment
- runExperimentSynchronously
- stopExperiment
- translate
- updateExistingVariableParameterTableDataByIndex
- updateExperimentRunConfiguration
- updateVariableParameter
All URIs are relative to https://server_address:port/api/v1
Method | HTTP request | Description |
---|---|---|
closeProject | GET /open/project/close | Closes the currently open project. |
convertGFAResultToScenario | POST /open/convert/gfa | Converts the GFA result with identifier runId to a new scenario with type scenarioType. |
convertNOResultToScenario | POST /open/convert/no | Converts resultOptionId iteration of the NO result with identifier runId to a new scenario with type scenarioType. |
convertSSEResultToScenario | POST /open/convert/sse | Converts the Safety stock estimation result with identifier runId to a new scenario. |
convertVariationResultToScenario | GET /open/convert/variation | Converts resultOptionId iteration of the Variation result with identifier runId to a new scenario. |
copyScenario | POST /open/scenario/copy | Asynchronously copies or clones the scenario with identifier scenarioId. |
copyScenarioSynchronously | POST /open/scenario/copySynchronously | Synchronously copies or clones the scenario with identifier scenarioId. |
createNewVariableParameter | POST /open/variations/create-variable-parameter | Creates a new variable parameter. |
createVariableParameter | POST /open/variations | Creates a new variable parameter. |
deleteVariableParameter | DELETE /open/variations/delete-variable-parameter | Deletes a variation parameter with identifier variationId. |
doesVariableParameterHasSelectedData | POST /open/variations/has-selected-data | Returns whether the variable parameter with identifier variationId has the selected data in the table. |
dropLicense | POST /open/user/license/drop | Drops user's license. |
exportDashboardPage | GET /open/experiments/export-page | Returns an Excel representation of the dashboard page with id pageId. |
findAndOpenProjectByName | GET /open/project/open-by-name | Opens project with name projectName. |
getComparisonResultData | POST /open/experiments/comparison-result | Returns comparison result data. |
getCurrentUser | GET /open/user | Gets current user data. |
getExistingVariableParameterTableData | GET /open/variations/existing-table-data | Returns a table data of a variation with the given variationId. |
getExperiment | GET /open/experiments/experiment | Returns an experiment of a given type available for a given scenario. |
getExperimentDashboardPage | GET /open/experiments/dashboard-page | Returns statistic page with the given pageName for the result of experiment run. |
getExperimentDashboardPages | GET /open/experiments/dashboard-pages | Returns statistics pages for the result of experiment run. |
getExperimentOptions | POST /open/experiments/options | Returns a list of possible values for various experiment options. |
getExperimentRunConfiguration | GET /open/experiments/get-run-configuration | Returns experiment settings. |
getExperimentRunResult | GET /open/experiments/result | Returns all the results of the specific experiment run. |
getExperimentRunResultChartGraphData | GET /open/experiments/chart-graph-data | Returns graph data for the chart with identifier chartId. |
getExperimentRunResultChartTableData | GET /open/experiments/chart-table-data | Returns table data for the chart with identifier chartId. |
getExperimentRunResultOptions | GET /open/experiments/result-options | Returns options for the result of experiment run. |
getExperimentRunResultPageCharts | GET /open/experiments/charts | Returns charts on the statistics page with the identifier pageId. |
getExperimentRunResultPages | GET /open/experiments/pages | Returns statistics pages for the result of experiment run. |
getExperimentRunsForScenario | GET /open/experiments/results | Returns the results of experiment runs for scenario. |
getExperimentStatus | GET /open/experiments/status | Returns the experiment status. |
getExperiments | GET /open/experiments/list | Returns a list of experiments available for a given scenario. |
getImportStatus | GET /open/import/import-status | Returns scenario import status. |
getNewVariableParameterTableData | GET /open/variations/new-table-data | Returns a table data of a variation with the given variationId. |
getProjects | GET /open/project/list | Returns a list of projects that the user has access to. |
getScenarioValidationStatus | GET /open/experiments/validation-status | Returns the validation status of the scenario. |
getScenarios | GET /open/scenario/list | Returns a list of scenarios for the project with identifier projectId. |
getScenariosFromImportedDatabase | POST /open/import/scenarios-available-for-import | Returns a list of scenarios available for import in the imported database. |
getStatisticsConfigurations | GET /open/experiments/statistics-list | Returns a list of available statistics. |
getTablesMeta | GET /open/import/table-metas | Returns a list of meta information for tables. |
getValidationErrors | GET /open/experiments/validation-errors | Returns validation errors. |
getValidationWarnings | GET /open/experiments/validation-warnings | Returns validation warnings. |
getVariableParameterObjectType | GET /open/variations/object-type | Return a list of object types that have variable parameters. |
getVariableParameterObjectTypes | GET /open/variations/object-types | Returns a list of object types that have variable parameters. |
getVariableParameterObjects | GET /open/variations/objects | Returns a list of variable parameter objects of the given object type with identifier objectTypeId. |
getVariableParameterParameters | GET /open/variations/parameters | Returns a list of parameters of an object with id objectId with type with id objectTypeId. |
getVariableParameterVariationTypes | GET /open/variations/variation-types | Returns a list of parameter variation types for a parameter with id parameterId belonging to an object with id objectId with a type with id objectTypeId. |
getVariationResultData | POST /open/experiments/variation-result | Returns variation result data. |
importCancel | POST /open/import/import-cancel | Cancels scenario import job. |
importDatabase | POST /open/import/import-database | Imports scenarios from the list sourceScenarioNameList from an external database. |
importDatabaseExisting | POST /open/import/import-database-existing | Imports scenario sourceScenarioName from an external database into existing scenario. |
importExcel | POST /open/import/import-excel | Asynchronously imports scenario from excel file. |
importExcelExisting | POST /open/import/import-excel-existing | Asynchronously imports scenario from excel file into existing scenario. |
importScenario | POST /open/import/import-scenario | Synchronously imports scenario from excel file. |
importScenarioExisting | POST /open/import/import-scenario-existing | Synchronously imports scenario from excel file into existing scenario. |
openProject | GET /open/project/open | Opens project with identifier projectId. |
removeScenarioById | DELETE /open/scenario | Deletes a scenario. |
requestLicense | POST /open/user/license/pick | Requests a license for the user. |
runExperiment | GET /open/experiments/run | Starts the experiment asynchronously. |
runExperimentSynchronously | GET /open/experiments/run-synchronously | Starts the experiment synchronously. |
stopExperiment | GET /open/experiments/stop | Stops the experiment. |
translate | GET /open/translate | Returns translation for string stringToBeTranslated. |
updateExistingVariableParameterTableDataByIndex | POST /open/variations/update-table-data-by-index | Updates a variation table data by index. |
updateExperimentRunConfiguration | POST /open/experiments/update-run-configuration | Updates experiment settings. |
updateVariableParameter | PUT /open/variations/update-variable-parameter | Updates the variation parameter represented by the variation object. |
ApiProjectResponse closeProject()
Closes the currently open project.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
ApiProjectResponse result = apiInstance.closeProject();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#closeProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData convertGFAResultToScenario(runId, scenarioType, body)
Converts the GFA result with identifier runId to a new scenario with type scenarioType.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long runId = 56L; // Long | Id of the run.
String scenarioType = "GFA"; // String | Type of the new scenario.
ApiConvertAndCopyParameters body = new ApiConvertAndCopyParameters(); // ApiConvertAndCopyParameters |
try {
ApiScenarioData result = apiInstance.convertGFAResultToScenario(runId, scenarioType, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#convertGFAResultToScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
runId | Long | Id of the run. | |
scenarioType | String | Type of the new scenario. | [enum: GFA, NO, SIM] |
body | ApiConvertAndCopyParameters | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData convertNOResultToScenario(resultOptionId, runId, scenarioType, body)
Converts resultOptionId iteration of the NO result with identifier runId to a new scenario with type scenarioType.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Integer resultOptionId = 56; // Integer | Identifier of the result option.
Long runId = 56L; // Long | Id of the run.
String scenarioType = "GFA"; // String | Type of the new scenario.
ApiConvertAndCopyParameters body = new ApiConvertAndCopyParameters(); // ApiConvertAndCopyParameters |
try {
ApiScenarioData result = apiInstance.convertNOResultToScenario(resultOptionId, runId, scenarioType, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#convertNOResultToScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
resultOptionId | Integer | Identifier of the result option. | |
runId | Long | Id of the run. | |
scenarioType | String | Type of the new scenario. | [enum: GFA, NO, SIM] |
body | ApiConvertAndCopyParameters | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData convertSSEResultToScenario(runId, updateParentScenario, body)
Converts the Safety stock estimation result with identifier runId to a new scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long runId = 56L; // Long | Id of the run.
Boolean updateParentScenario = true; // Boolean |
ApiConvertAndCopyParameters body = new ApiConvertAndCopyParameters(); // ApiConvertAndCopyParameters |
try {
ApiScenarioData result = apiInstance.convertSSEResultToScenario(runId, updateParentScenario, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#convertSSEResultToScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
runId | Long | Id of the run. | |
updateParentScenario | Boolean | ||
body | ApiConvertAndCopyParameters | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData convertVariationResultToScenario(resultOptionId, runId)
Converts resultOptionId iteration of the Variation result with identifier runId to a new scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Integer resultOptionId = 56; // Integer | Identifier of the result option.
Long runId = 56L; // Long | Id of the run.
try {
ApiScenarioData result = apiInstance.convertVariationResultToScenario(resultOptionId, runId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#convertVariationResultToScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
resultOptionId | Integer | Identifier of the result option. | |
runId | Long | Id of the run. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiImportResponse copyScenario(newType, scenarioId, body)
Asynchronously copies or clones the scenario with identifier scenarioId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String newType = "GFA"; // String | Type of the new scenario.
Long scenarioId = 56L; // Long | Id of the scenario.
ApiConvertAndCopyParameters body = new ApiConvertAndCopyParameters(); // ApiConvertAndCopyParameters |
try {
ApiImportResponse result = apiInstance.copyScenario(newType, scenarioId, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#copyScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
newType | String | Type of the new scenario. | [enum: GFA, NO, SIM] |
scenarioId | Long | Id of the scenario. | |
body | ApiConvertAndCopyParameters | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData copyScenarioSynchronously(newType, scenarioId, body)
Synchronously copies or clones the scenario with identifier scenarioId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String newType = "GFA"; // String | Type of the new scenario.
Long scenarioId = 56L; // Long | Id of the scenario.
ApiConvertAndCopyParameters body = new ApiConvertAndCopyParameters(); // ApiConvertAndCopyParameters |
try {
ApiScenarioData result = apiInstance.copyScenarioSynchronously(newType, scenarioId, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#copyScenarioSynchronously");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
newType | String | Type of the new scenario. | [enum: GFA, NO, SIM] |
scenarioId | Long | Id of the scenario. | |
body | ApiConvertAndCopyParameters | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiVariation createNewVariableParameter(body)
Creates a new variable parameter.
Make sure that if this variation parameter contains a table, then it has the selected values (that is, you passed the indexes for the selected cells inside the variationCreateRequest.tableSelection object), since otherwise you will not be able to create the parameter.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
ApiVariationCreateRequest body = new ApiVariationCreateRequest(); // ApiVariationCreateRequest | Variation parameter crate request.
try {
ApiVariation result = apiInstance.createNewVariableParameter(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#createNewVariableParameter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | ApiVariationCreateRequest | Variation parameter crate request. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiVariation createVariableParameter(rcId, body)
Creates a new variable parameter.
Make sure that if this variation parameter contains a table, then it has the selected values (that is, you previously called updateVariableParameterTableDataByIndex), since otherwise you will not be able to create the parameter.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
ApiVariation body = new ApiVariation(); // ApiVariation | Variation parameter data.
try {
ApiVariation result = apiInstance.createVariableParameter(rcId, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#createVariableParameter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
body | ApiVariation | Variation parameter data. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
deleteVariableParameter(rcId, variationId)
Deletes a variation parameter with identifier variationId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
Long variationId = 56L; // Long | Id of the variation parameter.
try {
apiInstance.deleteVariableParameter(rcId, variationId);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#deleteVariableParameter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
variationId | Long | Id of the variation parameter. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
0 | successful operation | - |
Boolean doesVariableParameterHasSelectedData(objectId, rcId, variationId)
Returns whether the variable parameter with identifier variationId has the selected data in the table.
This method must be called before creating the variation parameter. If this method returns false, then the parameter cannot be created. In this case, check that the table of the variation parameter being created contains any selected values.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long objectId = 56L; // Long | Id of the object.
Long rcId = 56L; // Long | Id of the running configuration.
String variationId = "variationId_example"; // String | Id of the variation parameter (pass 'new' for a new variation parameter).
try {
Boolean result = apiInstance.doesVariableParameterHasSelectedData(objectId, rcId, variationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#doesVariableParameterHasSelectedData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | Long | Id of the object. | |
rcId | Long | Id of the running configuration. | |
variationId | String | Id of the variation parameter (pass 'new' for a new variation parameter). |
Boolean
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiLicenseDropData dropLicense()
Drops user's license.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
ApiLicenseDropData result = apiInstance.dropLicense();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#dropLicense");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
byte[] exportDashboardPage(experimentResultId, pageId)
Returns an Excel representation of the dashboard page with id pageId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long experimentResultId = 56L; // Long | Id of the experiment result.
Long pageId = 56L; // Long | Id of the page with experiment run statistics.
try {
byte[] result = apiInstance.exportDashboardPage(experimentResultId, pageId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#exportDashboardPage");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
experimentResultId | Long | Id of the experiment result. | |
pageId | Long | Id of the page with experiment run statistics. |
byte[]
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiProjectResponse findAndOpenProjectByName(fullMatch, projectName)
Opens project with name projectName.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Boolean fullMatch = true; // Boolean | Whether to match project name by complete match.
String projectName = "projectName_example"; // String | Name of the project.
try {
ApiProjectResponse result = apiInstance.findAndOpenProjectByName(fullMatch, projectName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#findAndOpenProjectByName");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
fullMatch | Boolean | Whether to match project name by complete match. | [default to true] |
projectName | String | Name of the project. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiStrictTableChartData getComparisonResultData(rcId)
Returns comparison result data.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
ApiStrictTableChartData result = apiInstance.getComparisonResultData(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getComparisonResultData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiUserData getCurrentUser()
Gets current user data.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
ApiUserData result = apiInstance.getCurrentUser();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getCurrentUser");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiStrictTableData getExistingVariableParameterTableData(objectId, objectTypeId, parameterId, rcId, skip, take, variationId, variationType)
Returns a table data of a variation with the given variationId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectId = "objectId_example"; // String | Id of the object.
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
String parameterId = "parameterId_example"; // String | Id of the parameter.
Long rcId = 56L; // Long | Id of the running configuration.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
Long variationId = 56L; // Long | Id of the variation parameter.
String variationType = "NUMBER_RANGE"; // String | Id of the variation type.
try {
ApiStrictTableData result = apiInstance.getExistingVariableParameterTableData(objectId, objectTypeId, parameterId, rcId, skip, take, variationId, variationType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExistingVariableParameterTableData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | String | Id of the object. | |
objectTypeId | String | Id of the object type. | |
parameterId | String | Id of the parameter. | |
rcId | Long | Id of the running configuration. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
variationId | Long | Id of the variation parameter. | |
variationType | String | Id of the variation type. | [enum: NUMBER_RANGE, LINK_LIST, MULTIPLE_LINK_LIST, SOURCING_SPLIT, SCENARIO] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiARunConfigurationWrapper getExperiment(experimentType, scenarioId)
Returns an experiment of a given type available for a given scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String experimentType = "GFA"; // String | Type of the experiment.
Long scenarioId = 56L; // Long | Id of the scenario.
try {
ApiARunConfigurationWrapper result = apiInstance.getExperiment(experimentType, scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperiment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
experimentType | String | Type of the experiment. | [enum: GFA, GFA_WITH_ROADS, SIMULATION, NETWORK_OPTIMIZATION, VARIATION, COMPARISON, SAFETY_STOCK, RISK_ANALYSIS] |
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiDashboardPage getExperimentDashboardPage(experimentResultId, fullMatch, pageName)
Returns statistic page with the given pageName for the result of experiment run.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long experimentResultId = 56L; // Long | Id of the experiment result.
Boolean fullMatch = true; // Boolean | Whether to match page name by complete match.
String pageName = "pageName_example"; // String | Page name
try {
ApiDashboardPage result = apiInstance.getExperimentDashboardPage(experimentResultId, fullMatch, pageName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentDashboardPage");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
experimentResultId | Long | Id of the experiment result. | |
fullMatch | Boolean | Whether to match page name by complete match. | [default to true] |
pageName | String | Page name |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiDashboardPage> getExperimentDashboardPages(experimentResultId)
Returns statistics pages for the result of experiment run.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long experimentResultId = 56L; // Long | Id of the experiment result.
try {
List<ApiDashboardPage> result = apiInstance.getExperimentDashboardPages(experimentResultId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentDashboardPages");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
experimentResultId | Long | Id of the experiment result. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getExperimentOptions(skip, take, body)
Returns a list of possible values for various experiment options.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
ApiOptionRequest body = new ApiOptionRequest(); // ApiOptionRequest | An object containing a request to obtain a set of possible values.
try {
ApiOptionList result = apiInstance.getExperimentOptions(skip, take, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentOptions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
body | ApiOptionRequest | An object containing a request to obtain a set of possible values. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiARunConfigurationWrapper getExperimentRunConfiguration(rcId)
Returns experiment settings.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
ApiARunConfigurationWrapper result = apiInstance.getExperimentRunConfiguration(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiExperimentResultData getExperimentRunResult(rcId, skip, take)
Returns all the results of the specific experiment run.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
try {
ApiExperimentResultData result = apiInstance.getExperimentRunResult(rcId, skip, take);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResult");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiGraphChartData getExperimentRunResultChartGraphData(chartId, rcId)
Returns graph data for the chart with identifier chartId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long chartId = 56L; // Long | Id of the chart with experiment run statistics.
Long rcId = 56L; // Long | Id of the running configuration.
try {
ApiGraphChartData result = apiInstance.getExperimentRunResultChartGraphData(chartId, rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResultChartGraphData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
chartId | Long | Id of the chart with experiment run statistics. | |
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiStrictTableChartData getExperimentRunResultChartTableData(chartId, rcId, skip, take)
Returns table data for the chart with identifier chartId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long chartId = 56L; // Long | Id of the chart with experiment run statistics.
Long rcId = 56L; // Long | Id of the running configuration.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
try {
ApiStrictTableChartData result = apiInstance.getExperimentRunResultChartTableData(chartId, rcId, skip, take);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResultChartTableData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
chartId | Long | Id of the chart with experiment run statistics. | |
rcId | Long | Id of the running configuration. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiExperimentResultOption> getExperimentRunResultOptions(rcId, skip, take)
Returns options for the result of experiment run.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
try {
List<ApiExperimentResultOption> result = apiInstance.getExperimentRunResultOptions(rcId, skip, take);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResultOptions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
List<ApiExperimentResultOption>
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiChartMetadataShort> getExperimentRunResultPageCharts(pageId, rcId)
Returns charts on the statistics page with the identifier pageId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long pageId = 56L; // Long | Id of the page with experiment run statistics.
Long rcId = 56L; // Long | Id of the running configuration.
try {
List<ApiChartMetadataShort> result = apiInstance.getExperimentRunResultPageCharts(pageId, rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResultPageCharts");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
pageId | Long | Id of the page with experiment run statistics. | |
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiPage> getExperimentRunResultPages(rcId)
Returns statistics pages for the result of experiment run.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
List<ApiPage> result = apiInstance.getExperimentRunResultPages(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunResultPages");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiBasicRun> getExperimentRunsForScenario(scenarioId)
Returns the results of experiment runs for scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
List<ApiBasicRun> result = apiInstance.getExperimentRunsForScenario(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentRunsForScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ExecutionState getExperimentStatus(rcId)
Returns the experiment status.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
ExecutionState result = apiInstance.getExperimentStatus(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperimentStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiBasicRunConfiguration> getExperiments(projectId, scenarioId)
Returns a list of experiments available for a given scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
Long scenarioId = 56L; // Long | Id of the scenario.
try {
List<ApiBasicRunConfiguration> result = apiInstance.getExperiments(projectId, scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getExperiments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. | |
scenarioId | Long | Id of the scenario. |
List<ApiBasicRunConfiguration>
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiImportScenarioStatus getImportStatus(jobId)
Returns scenario import status.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long jobId = 56L; // Long | Id of the import job.
try {
ApiImportScenarioStatus result = apiInstance.getImportStatus(jobId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getImportStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
jobId | Long | Id of the import job. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiStrictTableData getNewVariableParameterTableData(objectId, objectTypeId, parameterId, rcId, skip, take, variationType)
Returns a table data of a variation with the given variationId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectId = "objectId_example"; // String | Id of the object.
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
String parameterId = "parameterId_example"; // String | Id of the parameter.
Long rcId = 56L; // Long | Id of the running configuration.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
String variationType = "NUMBER_RANGE"; // String | Id of the variation type.
try {
ApiStrictTableData result = apiInstance.getNewVariableParameterTableData(objectId, objectTypeId, parameterId, rcId, skip, take, variationType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getNewVariableParameterTableData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | String | Id of the object. | |
objectTypeId | String | Id of the object type. | |
parameterId | String | Id of the parameter. | |
rcId | Long | Id of the running configuration. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
variationType | String | Id of the variation type. | [enum: NUMBER_RANGE, LINK_LIST, MULTIPLE_LINK_LIST, SOURCING_SPLIT, SCENARIO] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiProjectResponse> getProjects()
Returns a list of projects that the user has access to.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
List<ApiProjectResponse> result = apiInstance.getProjects();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getProjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
String getScenarioValidationStatus(scenarioId)
Returns the validation status of the scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
String result = apiInstance.getScenarioValidationStatus(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getScenarioValidationStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
String
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiScenarioData> getScenarios(projectId)
Returns a list of scenarios for the project with identifier projectId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
try {
List<ApiScenarioData> result = apiInstance.getScenarios(projectId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getScenarios");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getScenariosFromImportedDatabase(body)
Returns a list of scenarios available for import in the imported database.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
DBConnectionProperties body = new DBConnectionProperties(); // DBConnectionProperties | Database connection properties.
try {
ApiOptionList result = apiInstance.getScenariosFromImportedDatabase(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getScenariosFromImportedDatabase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | DBConnectionProperties | Database connection properties. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiStatisticsConfiguration> getStatisticsConfigurations(rcId)
Returns a list of available statistics.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
List<ApiStatisticsConfiguration> result = apiInstance.getStatisticsConfigurations(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getStatisticsConfigurations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
List<ApiStatisticsConfiguration>
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiTableMeta> getTablesMeta()
Returns a list of meta information for tables.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
List<ApiTableMeta> result = apiInstance.getTablesMeta();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getTablesMeta");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiValidationError> getValidationErrors(scenarioId)
Returns validation errors.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
List<ApiValidationError> result = apiInstance.getValidationErrors(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getValidationErrors");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiValidationWarning> getValidationWarnings(scenarioId)
Returns validation warnings.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
List<ApiValidationWarning> result = apiInstance.getValidationWarnings(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getValidationWarnings");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiIdNameObject getVariableParameterObjectType(fullMatch, parameterName, scenarioId)
Return a list of object types that have variable parameters.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Boolean fullMatch = true; // Boolean | Whether to match parameter name by complete match.
String parameterName = "parameterName_example"; // String | Parameter name
Long scenarioId = 56L; // Long | Id of the scenario.
try {
ApiIdNameObject result = apiInstance.getVariableParameterObjectType(fullMatch, parameterName, scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariableParameterObjectType");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
fullMatch | Boolean | Whether to match parameter name by complete match. | [default to true] |
parameterName | String | Parameter name | |
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getVariableParameterObjectTypes(scenarioId)
Returns a list of object types that have variable parameters.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
ApiOptionList result = apiInstance.getVariableParameterObjectTypes(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariableParameterObjectTypes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getVariableParameterObjects(objectTypeId, scenarioId, skip, take)
Returns a list of variable parameter objects of the given object type with identifier objectTypeId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
Long scenarioId = 56L; // Long | Id of the scenario.
Integer skip = 0; // Integer | Number of records to skip.
Integer take = 1000; // Integer | Number of records to be retrieved.
try {
ApiOptionList result = apiInstance.getVariableParameterObjects(objectTypeId, scenarioId, skip, take);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariableParameterObjects");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectTypeId | String | Id of the object type. | |
scenarioId | Long | Id of the scenario. | |
skip | Integer | Number of records to skip. | [default to 0] |
take | Integer | Number of records to be retrieved. | [default to 1000] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getVariableParameterParameters(objectId, objectTypeId, scenarioId)
Returns a list of parameters of an object with id objectId with type with id objectTypeId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectId = "objectId_example"; // String | Id of the object.
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
Long scenarioId = 56L; // Long | Id of the scenario.
try {
ApiOptionList result = apiInstance.getVariableParameterParameters(objectId, objectTypeId, scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariableParameterParameters");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | String | Id of the object. | |
objectTypeId | String | Id of the object type. | |
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiOptionList getVariableParameterVariationTypes(objectId, objectTypeId, parameterId, scenarioId)
Returns a list of parameter variation types for a parameter with id parameterId belonging to an object with id objectId with a type with id objectTypeId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectId = "objectId_example"; // String | Id of the object.
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
String parameterId = "parameterId_example"; // String | Id of the parameter.
Long scenarioId = 56L; // Long | Id of the scenario.
try {
ApiOptionList result = apiInstance.getVariableParameterVariationTypes(objectId, objectTypeId, parameterId, scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariableParameterVariationTypes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | String | Id of the object. | |
objectTypeId | String | Id of the object type. | |
parameterId | String | Id of the parameter. | |
scenarioId | Long | Id of the scenario. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiStrictTableChartData getVariationResultData(rcId)
Returns variation result data.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
ApiStrictTableChartData result = apiInstance.getVariationResultData(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#getVariationResultData");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
importCancel(body)
Cancels scenario import job.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
ApiImportScenarioCancelRequest body = new ApiImportScenarioCancelRequest(); // ApiImportScenarioCancelRequest | Cancel import request object.
try {
apiInstance.importCancel(body);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importCancel");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | ApiImportScenarioCancelRequest | Cancel import request object. | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
0 | successful operation | - |
List<ApiImportResponse> importDatabase(newScenarioName, projectId, sourceScenarioNameList, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport, body)
Imports scenarios from the list sourceScenarioNameList from an external database.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String newScenarioName = "newScenarioName_example"; // String | Desired scenario name.
Long projectId = 56L; // Long | Id of the project.
List<String> sourceScenarioNameList = Arrays.asList(); // List<String> | List of scenarios to import.
Boolean needToImportExperiments = true; // Boolean | Whether to import experiments.
Boolean overrideExistingProjectConversionRules = true; // Boolean | Whether to override existing project conversion rules.
List<String> tableIDsToImport = Arrays.asList(); // List<String> | List of table IDs to import.
DBConnectionProperties body = new DBConnectionProperties(); // DBConnectionProperties | Database connection properties.
try {
List<ApiImportResponse> result = apiInstance.importDatabase(newScenarioName, projectId, sourceScenarioNameList, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importDatabase");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
newScenarioName | String | Desired scenario name. | |
projectId | Long | Id of the project. | |
sourceScenarioNameList | List<String> | List of scenarios to import. | |
needToImportExperiments | Boolean | Whether to import experiments. | [optional] |
overrideExistingProjectConversionRules | Boolean | Whether to override existing project conversion rules. | [optional] |
tableIDsToImport | List<String> | List of table IDs to import. | [optional] |
body | DBConnectionProperties | Database connection properties. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiImportResponse> importDatabaseExisting(projectId, scenarioId, sourceScenarioName, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport, body)
Imports scenario sourceScenarioName from an external database into existing scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
Long scenarioId = 56L; // Long | Id of the scenario.
String sourceScenarioName = "sourceScenarioName_example"; // String | Scenario to import.
Boolean needToImportExperiments = true; // Boolean | Whether to import experiments.
Boolean overrideExistingProjectConversionRules = true; // Boolean | Whether to override existing project conversion rules.
List<String> tableIDsToImport = Arrays.asList(); // List<String> | List of table IDs to import.
DBConnectionProperties body = new DBConnectionProperties(); // DBConnectionProperties | Database connection properties.
try {
List<ApiImportResponse> result = apiInstance.importDatabaseExisting(projectId, scenarioId, sourceScenarioName, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importDatabaseExisting");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. | |
scenarioId | Long | Id of the scenario. | |
sourceScenarioName | String | Scenario to import. | |
needToImportExperiments | Boolean | Whether to import experiments. | [optional] |
overrideExistingProjectConversionRules | Boolean | Whether to override existing project conversion rules. | [optional] |
tableIDsToImport | List<String> | List of table IDs to import. | [optional] |
body | DBConnectionProperties | Database connection properties. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiImportResponse importExcel(newScenarioName, projectId, _file, containsFormulas, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport)
Asynchronously imports scenario from excel file.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String newScenarioName = "newScenarioName_example"; // String | Desired scenario name.
Long projectId = 56L; // Long | Id of the project.
File _file = new File("/path/to/file"); // File | Excel file data to be imported.
Boolean containsFormulas = true; // Boolean | Whether importing excel file contains formulas.
Boolean needToImportExperiments = true; // Boolean | Whether to import experiments.
Boolean overrideExistingProjectConversionRules = true; // Boolean | Whether to override existing project conversion rules.
List<String> tableIDsToImport = Arrays.asList(); // List<String> | List of table IDs to import.
try {
ApiImportResponse result = apiInstance.importExcel(newScenarioName, projectId, _file, containsFormulas, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importExcel");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
newScenarioName | String | Desired scenario name. | |
projectId | Long | Id of the project. | |
_file | File | Excel file data to be imported. | |
containsFormulas | Boolean | Whether importing excel file contains formulas. | [optional] |
needToImportExperiments | Boolean | Whether to import experiments. | [optional] |
overrideExistingProjectConversionRules | Boolean | Whether to override existing project conversion rules. | [optional] |
tableIDsToImport | List<String> | List of table IDs to import. | [optional] |
- Content-Type: multipart/form-data
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
List<ApiImportResponse> importExcelExisting(newScenarioName, projectId, scenarioId, _file, containsFormulas, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport)
Asynchronously imports scenario from excel file into existing scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String newScenarioName = "newScenarioName_example"; // String | Desired scenario name.
Long projectId = 56L; // Long | Id of the project.
Long scenarioId = 56L; // Long | Id of the scenario.
File _file = new File("/path/to/file"); // File | Excel file data to be imported.
Boolean containsFormulas = true; // Boolean | Whether importing excel file contains formulas.
Boolean needToImportExperiments = true; // Boolean | Whether to import experiments.
Boolean overrideExistingProjectConversionRules = true; // Boolean | Whether to override existing project conversion rules.
List<String> tableIDsToImport = Arrays.asList(); // List<String> | List of table IDs to import.
try {
List<ApiImportResponse> result = apiInstance.importExcelExisting(newScenarioName, projectId, scenarioId, _file, containsFormulas, needToImportExperiments, overrideExistingProjectConversionRules, tableIDsToImport);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importExcelExisting");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
newScenarioName | String | Desired scenario name. | |
projectId | Long | Id of the project. | |
scenarioId | Long | Id of the scenario. | |
_file | File | Excel file data to be imported. | |
containsFormulas | Boolean | Whether importing excel file contains formulas. | [optional] |
needToImportExperiments | Boolean | Whether to import experiments. | [optional] |
overrideExistingProjectConversionRules | Boolean | Whether to override existing project conversion rules. | [optional] |
tableIDsToImport | List<String> | List of table IDs to import. | [optional] |
- Content-Type: multipart/form-data
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData importScenario(projectId, _file)
Synchronously imports scenario from excel file.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
File _file = new File("/path/to/file"); // File | Excel file data to be imported.
try {
ApiScenarioData result = apiInstance.importScenario(projectId, _file);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importScenario");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. | |
_file | File | Excel file data to be imported. |
- Content-Type: multipart/form-data
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiScenarioData importScenarioExisting(projectId, scenarioId, _file, cleanTables, tableIDsToImport)
Synchronously imports scenario from excel file into existing scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
Long scenarioId = 56L; // Long | Id of the scenario.
File _file = new File("/path/to/file"); // File | Excel file data to be imported.
Boolean cleanTables = true; // Boolean | Whether to clear the corresponding tables before importing.
List<String> tableIDsToImport = Arrays.asList(); // List<String> | List of table IDs to import.
try {
ApiScenarioData result = apiInstance.importScenarioExisting(projectId, scenarioId, _file, cleanTables, tableIDsToImport);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#importScenarioExisting");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. | |
scenarioId | Long | Id of the scenario. | |
_file | File | Excel file data to be imported. | |
cleanTables | Boolean | Whether to clear the corresponding tables before importing. | [optional] |
tableIDsToImport | List<String> | List of table IDs to import. | [optional] |
- Content-Type: multipart/form-data
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiProjectResponse openProject(projectId)
Opens project with identifier projectId.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long projectId = 56L; // Long | Id of the project.
try {
ApiProjectResponse result = apiInstance.openProject(projectId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#openProject");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
projectId | Long | Id of the project. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
Boolean removeScenarioById(scenarioId)
Deletes a scenario.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long scenarioId = 56L; // Long | Id of the scenario.
try {
Boolean result = apiInstance.removeScenarioById(scenarioId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#removeScenarioById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
scenarioId | Long | Id of the scenario. |
Boolean
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiLicenseData requestLicense()
Requests a license for the user.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
try {
ApiLicenseData result = apiInstance.requestLicense();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#requestLicense");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiRunExperiment runExperiment(rcId, skipScenarioWarnings)
Starts the experiment asynchronously.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
Boolean skipScenarioWarnings = true; // Boolean | Whether to skip scenario warnings.
try {
ApiRunExperiment result = apiInstance.runExperiment(rcId, skipScenarioWarnings);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#runExperiment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
skipScenarioWarnings | Boolean | Whether to skip scenario warnings. | [optional] |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiExperimentResult runExperimentSynchronously(rcId)
Starts the experiment synchronously.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
ApiExperimentResult result = apiInstance.runExperimentSynchronously(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#runExperimentSynchronously");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
String stopExperiment(rcId)
Stops the experiment.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
try {
String result = apiInstance.stopExperiment(rcId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#stopExperiment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. |
String
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
String translate(stringToBeTranslated)
Returns translation for string stringToBeTranslated.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String stringToBeTranslated = "stringToBeTranslated_example"; // String | String to be translated.
try {
String result = apiInstance.translate(stringToBeTranslated);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#translate");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
stringToBeTranslated | String | String to be translated. |
String
- Content-Type: Not defined
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
updateExistingVariableParameterTableDataByIndex(objectId, objectTypeId, parameterId, rcId, variationId, variationType, body)
Updates a variation table data by index.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
String objectId = "objectId_example"; // String | Id of the object.
String objectTypeId = "objectTypeId_example"; // String | Id of the object type.
String parameterId = "parameterId_example"; // String | Id of the parameter.
Long rcId = 56L; // Long | Id of the running configuration.
Long variationId = 56L; // Long | Id of the variation parameter.
String variationType = "NUMBER_RANGE"; // String | Id of the variation type.
List<ApiBaseIndexSelectionValueRequest> body = Arrays.asList(); // List<ApiBaseIndexSelectionValueRequest> | Data containing information about the rows in the table whose value needs to be set.
try {
apiInstance.updateExistingVariableParameterTableDataByIndex(objectId, objectTypeId, parameterId, rcId, variationId, variationType, body);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#updateExistingVariableParameterTableDataByIndex");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
objectId | String | Id of the object. | |
objectTypeId | String | Id of the object type. | |
parameterId | String | Id of the parameter. | |
rcId | Long | Id of the running configuration. | |
variationId | Long | Id of the variation parameter. | |
variationType | String | Id of the variation type. | [enum: NUMBER_RANGE, LINK_LIST, MULTIPLE_LINK_LIST, SOURCING_SPLIT, SCENARIO] |
body | List<ApiBaseIndexSelectionValueRequest> | Data containing information about the rows in the table whose value needs to be set. | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
0 | successful operation | - |
ApiARunConfigurationWrapper updateExperimentRunConfiguration(body)
Updates experiment settings.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
ApiARunConfigurationWrapper body = new ApiARunConfigurationWrapper(); // ApiARunConfigurationWrapper | Updated experiment run configuration data.
try {
ApiARunConfigurationWrapper result = apiInstance.updateExperimentRunConfiguration(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#updateExperimentRunConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
body | ApiARunConfigurationWrapper | Updated experiment run configuration data. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
ApiVariation updateVariableParameter(rcId, body)
Updates the variation parameter represented by the variation object.
// Import classes:
import org.alx.openapi.v1.ApiClient;
import org.alx.openapi.v1.ApiException;
import org.alx.openapi.v1.Configuration;
import org.alx.openapi.v1.auth.*;
import org.alx.openapi.v1.model.*;
import org.alx.openapi.v1.api.OpenApiApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://server_address:port/api/v1");
// Configure API key authorization: ApiKey
ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
ApiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.setApiKeyPrefix("Token");
OpenApiApi apiInstance = new OpenApiApi(defaultClient);
Long rcId = 56L; // Long | Id of the running configuration.
ApiVariation body = new ApiVariation(); // ApiVariation | Variation parameter data.
try {
ApiVariation result = apiInstance.updateVariableParameter(rcId, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OpenApiApi#updateVariableParameter");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
rcId | Long | Id of the running configuration. | |
body | ApiVariation | Variation parameter data. | [optional] |
- Content-Type: application/json
- Accept: /
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
-
How can we improve this article?
-