CosmotechApi - JavaScript client for @cosmotech/api Cosmo Tech Platform API This SDK is automatically generated by the OpenAPI Generator project:
- API version: 3.2.0
- Package version: 3.2.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install @cosmotech/api --save
Finally, you need to build the module:
npm run build
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your @cosmotech/api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var CosmotechApi = require('@cosmotech/api');
var defaultClient = CosmotechApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: oAuth2AuthCode
var oAuth2AuthCode = defaultClient.authentications['oAuth2AuthCode'];
oAuth2AuthCode.accessToken = "YOUR ACCESS TOKEN"
var api = new CosmotechApi.ConnectorApi()
var opts = {
'page': 56, // {Number} page number to query
'size': 56 // {Number} amount of result by page
};
api.findAllConnectors(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
All URIs are relative to https://dev.api.cosmotech.com
Class | Method | HTTP request | Description |
---|---|---|---|
CosmotechApi.ConnectorApi | findAllConnectors | GET /connectors | List all Connectors |
CosmotechApi.ConnectorApi | findConnectorById | GET /connectors/{connector_id} | Get the details of a connector |
CosmotechApi.ConnectorApi | findConnectorByName | GET /connectors/name/{connector_name} | Get the details of a connector |
CosmotechApi.ConnectorApi | registerConnector | POST /connectors | Register a new connector |
CosmotechApi.ConnectorApi | unregisterConnector | DELETE /connectors/{connector_id} | Unregister a connector |
CosmotechApi.DatasetApi | addDatasetAccessControl | POST /organizations/{organization_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset |
CosmotechApi.DatasetApi | addOrReplaceDatasetCompatibilityElements | POST /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Add Dataset Compatibility elements. |
CosmotechApi.DatasetApi | copyDataset | POST /organizations/{organization_id}/datasets/copy | Copy a Dataset to another Dataset. |
CosmotechApi.DatasetApi | createDataset | POST /organizations/{organization_id}/datasets | Create a new Dataset |
CosmotechApi.DatasetApi | createSubDataset | POST /organizations/{organization_id}/datasets/{dataset_id}/subdataset | Create a sub-dataset from the dataset in parameter |
CosmotechApi.DatasetApi | createTwingraphEntities | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Create new entities in a graph instance |
CosmotechApi.DatasetApi | deleteDataset | DELETE /organizations/{organization_id}/datasets/{dataset_id} | Delete a dataset |
CosmotechApi.DatasetApi | deleteTwingraphEntities | DELETE /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Delete entities in a graph instance |
CosmotechApi.DatasetApi | downloadTwingraph | GET /organizations/{organization_id}/datasets/twingraph/download/{hash} | Download a graph as a zip file |
CosmotechApi.DatasetApi | findAllDatasets | GET /organizations/{organization_id}/datasets | List all Datasets |
CosmotechApi.DatasetApi | findDatasetById | GET /organizations/{organization_id}/datasets/{dataset_id} | Get the details of a Dataset |
CosmotechApi.DatasetApi | getDatasetAccessControl | GET /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset |
CosmotechApi.DatasetApi | getDatasetSecurity | GET /organizations/{organization_id}/datasets/{dataset_id}/security | Get the Dataset security information |
CosmotechApi.DatasetApi | getDatasetSecurityUsers | GET /organizations/{organization_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list |
CosmotechApi.DatasetApi | getDatasetTwingraphStatus | GET /organizations/{organization_id}/datasets/{dataset_id}/status | Get the dataset's refresh job status |
CosmotechApi.DatasetApi | getTwingraphEntities | GET /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Get entities in a graph instance |
CosmotechApi.DatasetApi | linkWorkspace | POST /organizations/{organization_id}/datasets/{dataset_id}/link | |
CosmotechApi.DatasetApi | refreshDataset | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh | Refresh data on dataset from dataset's source |
CosmotechApi.DatasetApi | removeAllDatasetCompatibilityElements | DELETE /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Remove all Dataset Compatibility elements from the Dataset specified |
CosmotechApi.DatasetApi | removeDatasetAccessControl | DELETE /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset |
CosmotechApi.DatasetApi | rollbackRefresh | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh/rollback | Rollback the dataset after a failed refresh |
CosmotechApi.DatasetApi | searchDatasets | POST /organizations/{organization_id}/datasets/search | Search Datasets by tags |
CosmotechApi.DatasetApi | setDatasetDefaultSecurity | POST /organizations/{organization_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
CosmotechApi.DatasetApi | twingraphBatchQuery | POST /organizations/{organization_id}/datasets/{dataset_id}/batch-query | Run a query on a graph instance and return the result as a zip file in async mode |
CosmotechApi.DatasetApi | twingraphBatchUpdate | POST /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance |
CosmotechApi.DatasetApi | twingraphQuery | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph | Return the result of a query made on the graph instance as a json |
CosmotechApi.DatasetApi | unlinkWorkspace | POST /organizations/{organization_id}/datasets/{dataset_id}/unlink | |
CosmotechApi.DatasetApi | updateDataset | PATCH /organizations/{organization_id}/datasets/{dataset_id} | Update a dataset |
CosmotechApi.DatasetApi | updateDatasetAccessControl | PATCH /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset |
CosmotechApi.DatasetApi | updateTwingraphEntities | PATCH /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Update entities in a graph instance |
CosmotechApi.DatasetApi | uploadTwingraph | POST /organizations/{organization_id}/datasets/{dataset_id} | Upload data from zip file to dataset's twingraph |
CosmotechApi.OrganizationApi | addOrganizationAccessControl | POST /organizations/{organization_id}/security/access | Add a control access to the Organization |
CosmotechApi.OrganizationApi | findAllOrganizations | GET /organizations | List all Organizations |
CosmotechApi.OrganizationApi | findOrganizationById | GET /organizations/{organization_id} | Get the details of an Organization |
CosmotechApi.OrganizationApi | getAllPermissions | GET /organizations/permissions | Get all permissions per components |
CosmotechApi.OrganizationApi | getOrganizationAccessControl | GET /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
CosmotechApi.OrganizationApi | getOrganizationPermissions | GET /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role |
CosmotechApi.OrganizationApi | getOrganizationSecurity | GET /organizations/{organization_id}/security | Get the Organization security information |
CosmotechApi.OrganizationApi | getOrganizationSecurityUsers | GET /organizations/{organization_id}/security/users | Get the Organization security users list |
CosmotechApi.OrganizationApi | registerOrganization | POST /organizations | Register a new organization |
CosmotechApi.OrganizationApi | removeOrganizationAccessControl | DELETE /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
CosmotechApi.OrganizationApi | setOrganizationDefaultSecurity | POST /organizations/{organization_id}/security/default | Set the Organization default security |
CosmotechApi.OrganizationApi | unregisterOrganization | DELETE /organizations/{organization_id} | Unregister an organization |
CosmotechApi.OrganizationApi | updateOrganization | PATCH /organizations/{organization_id} | Update an Organization |
CosmotechApi.OrganizationApi | updateOrganizationAccessControl | PATCH /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization |
CosmotechApi.OrganizationApi | updateSolutionsContainerRegistryByOrganizationId | PATCH /organizations/{organization_id}/services/solutionsContainerRegistry | Update the solutions container registry configuration for the Organization specified |
CosmotechApi.OrganizationApi | updateStorageByOrganizationId | PATCH /organizations/{organization_id}/services/storage | Update storage configuration for the Organization specified |
CosmotechApi.OrganizationApi | updateTenantCredentialsByOrganizationId | PATCH /organizations/{organization_id}/services/tenantCredentials | Update tenant credentials for the Organization specified |
CosmotechApi.RunApi | deleteRun | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run |
CosmotechApi.RunApi | getRun | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run |
CosmotechApi.RunApi | getRunLogs | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run |
CosmotechApi.RunApi | getRunStatus | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run |
CosmotechApi.RunApi | listRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner |
CosmotechApi.RunApi | queryRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data |
CosmotechApi.RunApi | sendRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run |
CosmotechApi.RunnerApi | addRunnerAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner |
CosmotechApi.RunnerApi | createRunner | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner |
CosmotechApi.RunnerApi | deleteRunner | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner |
CosmotechApi.RunnerApi | getRunner | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of an runner |
CosmotechApi.RunnerApi | getRunnerAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner |
CosmotechApi.RunnerApi | getRunnerPermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role |
CosmotechApi.RunnerApi | getRunnerSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information |
CosmotechApi.RunnerApi | getRunnerSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list |
CosmotechApi.RunnerApi | listRunners | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners |
CosmotechApi.RunnerApi | removeRunnerAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Organization Runner |
CosmotechApi.RunnerApi | setRunnerDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security |
CosmotechApi.RunnerApi | startRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters |
CosmotechApi.RunnerApi | stopRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run |
CosmotechApi.RunnerApi | updateRunner | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner |
CosmotechApi.RunnerApi | updateRunnerAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner |
CosmotechApi.ScenarioApi | addOrReplaceScenarioParameterValues | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/parameterValues | Add (or replace) Parameter Values for the Scenario specified |
CosmotechApi.ScenarioApi | addScenarioAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access | Add a control access to the Scenario |
CosmotechApi.ScenarioApi | compareScenarios | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/compare/{compared_scenario_id} | Compare the Scenario with another one and returns the difference for parameters values |
CosmotechApi.ScenarioApi | createScenario | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | Create a new Scenario |
CosmotechApi.ScenarioApi | deleteAllScenarios | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | Delete all Scenarios of the Workspace |
CosmotechApi.ScenarioApi | deleteScenario | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Delete a scenario |
CosmotechApi.ScenarioApi | downloadScenarioData | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/downloads | Download Scenario data |
CosmotechApi.ScenarioApi | findAllScenarios | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | List all Scenarios |
CosmotechApi.ScenarioApi | findAllScenariosByValidationStatus | GET /organizations/{organization_id}/workspaces/{workspace_id}/{validationStatus} | List all Scenarios by validation status |
CosmotechApi.ScenarioApi | findScenarioById | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Get the details of an scenario |
CosmotechApi.ScenarioApi | getScenarioAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access/{identity_id} | Get a control access for the Scenario |
CosmotechApi.ScenarioApi | getScenarioDataDownloadJobInfo | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/downloads/{download_id} | Get Scenario data download URL |
CosmotechApi.ScenarioApi | getScenarioPermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/permissions/{role} | Get the Scenario permission by given role |
CosmotechApi.ScenarioApi | getScenarioSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security | Get the Scenario security information |
CosmotechApi.ScenarioApi | getScenarioSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/users | Get the Scenario security users list |
CosmotechApi.ScenarioApi | getScenarioValidationStatusById | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/ValidationStatus | Get the validation status of an scenario |
CosmotechApi.ScenarioApi | getScenariosTree | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/tree | Get the Scenarios Tree |
CosmotechApi.ScenarioApi | removeAllScenarioParameterValues | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/parameterValues | Remove all Parameter Values from the Scenario specified |
CosmotechApi.ScenarioApi | removeScenarioAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access/{identity_id} | Remove the specified access from the given Organization Scenario |
CosmotechApi.ScenarioApi | setScenarioDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/default | Set the Scenario default security |
CosmotechApi.ScenarioApi | updateScenario | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Update a scenario |
CosmotechApi.ScenarioApi | updateScenarioAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access/{identity_id} | Update the specified access to User for a Scenario |
CosmotechApi.ScenariorunApi | deleteHistoricalDataOrganization | DELETE /organizations/{organization_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Organization |
CosmotechApi.ScenariorunApi | deleteHistoricalDataScenario | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Scenario |
CosmotechApi.ScenariorunApi | deleteHistoricalDataWorkspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Workspace |
CosmotechApi.ScenariorunApi | deleteScenarioRun | DELETE /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Delete a scenariorun |
CosmotechApi.ScenariorunApi | findScenarioRunById | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Get the details of a scenariorun |
CosmotechApi.ScenariorunApi | getScenarioRunCumulatedLogs | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/cumulatedlogs | Get the cumulated logs of a scenariorun |
CosmotechApi.ScenariorunApi | getScenarioRunLogs | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/logs | get the logs for the ScenarioRun |
CosmotechApi.ScenariorunApi | getScenarioRunStatus | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/status | get the status for the ScenarioRun |
CosmotechApi.ScenariorunApi | getScenarioRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns | get the list of ScenarioRuns for the Scenario |
CosmotechApi.ScenariorunApi | getWorkspaceScenarioRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns | get the list of ScenarioRuns for the Workspace |
CosmotechApi.ScenariorunApi | runScenario | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/run | run a ScenarioRun for the Scenario |
CosmotechApi.ScenariorunApi | searchScenarioRuns | POST /organizations/{organization_id}/scenarioruns/search | Search ScenarioRuns |
CosmotechApi.ScenariorunApi | startScenarioRunContainers | POST /organizations/{organization_id}/scenarioruns/startcontainers | Start a new scenariorun with raw containers definition |
CosmotechApi.ScenariorunApi | stopScenarioRun | POST /organizations/{organization_id}/scenarioruns/{scenariorun_id}/stop | stop a ScenarioRun for the Scenario |
CosmotechApi.SolutionApi | addOrReplaceParameterGroups | POST /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Add Parameter Groups. Any item with the same ID will be overwritten |
CosmotechApi.SolutionApi | addOrReplaceParameters | POST /organizations/{organization_id}/solutions/{solution_id}/parameters | Add Parameters. Any item with the same ID will be overwritten |
CosmotechApi.SolutionApi | addOrReplaceRunTemplates | POST /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Add Run Templates. Any item with the same ID will be overwritten |
CosmotechApi.SolutionApi | addSolutionAccessControl | POST /organizations/{organization_id}/solutions/{solution_id}/security/access | Add a control access to the Solution |
CosmotechApi.SolutionApi | createSolution | POST /organizations/{organization_id}/solutions | Register a new solution |
CosmotechApi.SolutionApi | deleteSolution | DELETE /organizations/{organization_id}/solutions/{solution_id} | Delete a solution |
CosmotechApi.SolutionApi | deleteSolutionRunTemplate | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Remove the specified Solution Run Template |
CosmotechApi.SolutionApi | downloadRunTemplateHandler | GET /organizations/{organization_id}/solutions/{solution_id}/runtemplates/{run_template_id}/handlers/{handler_id}/download | Download a Run Template step handler zip file |
CosmotechApi.SolutionApi | findAllSolutions | GET /organizations/{organization_id}/solutions | List all Solutions |
CosmotechApi.SolutionApi | findSolutionById | GET /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution |
CosmotechApi.SolutionApi | getSolutionAccessControl | GET /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get a control access for the Solution |
CosmotechApi.SolutionApi | getSolutionSecurity | GET /organizations/{organization_id}/solutions/{solution_id}/security | Get the Solution security information |
CosmotechApi.SolutionApi | getSolutionSecurityUsers | GET /organizations/{organization_id}/solutions/{solution_id}/security/users | Get the Solution security users list |
CosmotechApi.SolutionApi | removeAllRunTemplates | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Remove all Run Templates from the Solution specified |
CosmotechApi.SolutionApi | removeAllSolutionParameterGroups | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Remove all Parameter Groups from the Solution specified |
CosmotechApi.SolutionApi | removeAllSolutionParameters | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameters | Remove all Parameters from the Solution specified |
CosmotechApi.SolutionApi | removeSolutionAccessControl | DELETE /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Remove the specified access from the given Organization Solution |
CosmotechApi.SolutionApi | setSolutionDefaultSecurity | POST /organizations/{organization_id}/solutions/{solution_id}/security/default | Set the Solution default security |
CosmotechApi.SolutionApi | updateSolution | PATCH /organizations/{organization_id}/solutions/{solution_id} | Update a solution |
CosmotechApi.SolutionApi | updateSolutionAccessControl | PATCH /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update the specified access to User for a Solution |
CosmotechApi.SolutionApi | updateSolutionRunTemplate | PATCH /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update the specified Solution Run Template |
CosmotechApi.SolutionApi | uploadRunTemplateHandler | POST /organizations/{organization_id}/solutions/{solution_id}/runtemplates/{run_template_id}/handlers/{handler_id}/upload | Upload a Run Template step handler zip file |
CosmotechApi.TwingraphApi | batchQuery | POST /organizations/{organization_id}/twingraph/{graph_id}/batch-query | Run a query on a graph instance and return the result as a zip file in async mode |
CosmotechApi.TwingraphApi | batchUploadUpdate | POST /organizations/{organization_id}/twingraph/{graph_id}/batch | Async batch update by loading a CSV file on a graph instance |
CosmotechApi.TwingraphApi | callDelete | DELETE /organizations/{organization_id}/twingraph/{graph_id} | Delete all versions of a graph and his metadatas |
CosmotechApi.TwingraphApi | createEntities | POST /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Create new entities in a graph instance |
CosmotechApi.TwingraphApi | createGraph | POST /organizations/{organization_id}/twingraph/{graph_id} | Create a new graph |
CosmotechApi.TwingraphApi | deleteEntities | DELETE /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Delete entities in a graph instance |
CosmotechApi.TwingraphApi | downloadGraph | GET /organizations/{organization_id}/twingraph/download/{hash} | Download a graph compressed in a zip file |
CosmotechApi.TwingraphApi | findAllTwingraphs | GET /organizations/{organization_id}/twingraphs | Return the list of all graphs stored in the organization |
CosmotechApi.TwingraphApi | getEntities | GET /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Get entities in a graph instance |
CosmotechApi.TwingraphApi | getGraphMetaData | GET /organizations/{organization_id}/twingraph/{graph_id}/metadata | Return the metaData of the specified graph |
CosmotechApi.TwingraphApi | jobStatus | GET /organizations/{organization_id}/job/{job_id}/status | Get the status of a job |
CosmotechApi.TwingraphApi | query | POST /organizations/{organization_id}/twingraph/{graph_id}/query | Run a query on a graph instance |
CosmotechApi.TwingraphApi | updateEntities | PATCH /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Update entities in a graph instance |
CosmotechApi.TwingraphApi | updateGraphMetaData | PATCH /organizations/{organization_id}/twingraph/{graph_id}/metadata | Update the metaData of the specified graph |
CosmotechApi.WorkspaceApi | addWorkspaceAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace |
CosmotechApi.WorkspaceApi | createSecret | POST /organizations/{organization_id}/workspaces/{workspace_id}/secret | Create a secret for the Workspace |
CosmotechApi.WorkspaceApi | createWorkspace | POST /organizations/{organization_id}/workspaces | Create a new workspace |
CosmotechApi.WorkspaceApi | deleteAllWorkspaceFiles | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files |
CosmotechApi.WorkspaceApi | deleteWorkspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace |
CosmotechApi.WorkspaceApi | deleteWorkspaceFile | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file |
CosmotechApi.WorkspaceApi | downloadWorkspaceFile | GET /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified |
CosmotechApi.WorkspaceApi | findAllWorkspaceFiles | GET /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files |
CosmotechApi.WorkspaceApi | findAllWorkspaces | GET /organizations/{organization_id}/workspaces | List all Workspaces |
CosmotechApi.WorkspaceApi | findWorkspaceById | GET /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of an workspace |
CosmotechApi.WorkspaceApi | getWorkspaceAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace |
CosmotechApi.WorkspaceApi | getWorkspacePermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role |
CosmotechApi.WorkspaceApi | getWorkspaceSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information |
CosmotechApi.WorkspaceApi | getWorkspaceSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list |
CosmotechApi.WorkspaceApi | linkDataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/link | |
CosmotechApi.WorkspaceApi | removeWorkspaceAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Organization Workspace |
CosmotechApi.WorkspaceApi | setWorkspaceDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Set the Workspace default security |
CosmotechApi.WorkspaceApi | unlinkDataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/unlink | |
CosmotechApi.WorkspaceApi | updateWorkspace | PATCH /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace |
CosmotechApi.WorkspaceApi | updateWorkspaceAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace |
CosmotechApi.WorkspaceApi | uploadWorkspaceFile | POST /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace |
- CosmotechApi.ComponentRolePermissions
- CosmotechApi.Connector
- CosmotechApi.ConnectorParameter
- CosmotechApi.ConnectorParameterGroup
- CosmotechApi.ContainerResourceSizeInfo
- CosmotechApi.ContainerResourceSizing
- CosmotechApi.Dataset
- CosmotechApi.DatasetAccessControl
- CosmotechApi.DatasetCompatibility
- CosmotechApi.DatasetConnector
- CosmotechApi.DatasetCopyParameters
- CosmotechApi.DatasetRole
- CosmotechApi.DatasetSearch
- CosmotechApi.DatasetSecurity
- CosmotechApi.DatasetSourceType
- CosmotechApi.DatasetTwinGraphHash
- CosmotechApi.DatasetTwinGraphInfo
- CosmotechApi.DatasetTwinGraphQuery
- CosmotechApi.DeleteHistoricalData
- CosmotechApi.FileUploadMetadata
- CosmotechApi.FileUploadValidation
- CosmotechApi.GraphProperties
- CosmotechApi.Organization
- CosmotechApi.OrganizationAccessControl
- CosmotechApi.OrganizationRole
- CosmotechApi.OrganizationSecurity
- CosmotechApi.OrganizationService
- CosmotechApi.OrganizationServices
- CosmotechApi.QueryResult
- CosmotechApi.ResourceSizeInfo
- CosmotechApi.Run
- CosmotechApi.RunContainer
- CosmotechApi.RunContainerArtifact
- CosmotechApi.RunContainerLogs
- CosmotechApi.RunData
- CosmotechApi.RunDataQuery
- CosmotechApi.RunLogs
- CosmotechApi.RunResourceRequested
- CosmotechApi.RunSearch
- CosmotechApi.RunStartContainers
- CosmotechApi.RunState
- CosmotechApi.RunStatus
- CosmotechApi.RunStatusNode
- CosmotechApi.RunTemplate
- CosmotechApi.RunTemplateHandlerId
- CosmotechApi.RunTemplateOrchestrator
- CosmotechApi.RunTemplateParameter
- CosmotechApi.RunTemplateParameterGroup
- CosmotechApi.RunTemplateParameterValue
- CosmotechApi.RunTemplateResourceSizing
- CosmotechApi.RunTemplateStepSource
- CosmotechApi.Runner
- CosmotechApi.RunnerAccessControl
- CosmotechApi.RunnerChangedParameterValue
- CosmotechApi.RunnerComparisonResult
- CosmotechApi.RunnerDataDownloadInfo
- CosmotechApi.RunnerDataDownloadJob
- CosmotechApi.RunnerJobState
- CosmotechApi.RunnerLastRun
- CosmotechApi.RunnerParentLastRun
- CosmotechApi.RunnerResourceSizing
- CosmotechApi.RunnerRole
- CosmotechApi.RunnerRootLastRun
- CosmotechApi.RunnerRunTemplateParameterValue
- CosmotechApi.RunnerSecurity
- CosmotechApi.RunnerValidationStatus
- CosmotechApi.Scenario
- CosmotechApi.ScenarioAccessControl
- CosmotechApi.ScenarioChangedParameterValue
- CosmotechApi.ScenarioComparisonResult
- CosmotechApi.ScenarioDataDownloadInfo
- CosmotechApi.ScenarioDataDownloadJob
- CosmotechApi.ScenarioJobState
- CosmotechApi.ScenarioLastRun
- CosmotechApi.ScenarioResourceSizing
- CosmotechApi.ScenarioRole
- CosmotechApi.ScenarioRun
- CosmotechApi.ScenarioRunContainer
- CosmotechApi.ScenarioRunContainerArtifact
- CosmotechApi.ScenarioRunContainerLogs
- CosmotechApi.ScenarioRunLogs
- CosmotechApi.ScenarioRunResourceRequested
- CosmotechApi.ScenarioRunSearch
- CosmotechApi.ScenarioRunStartContainers
- CosmotechApi.ScenarioRunState
- CosmotechApi.ScenarioRunStatus
- CosmotechApi.ScenarioRunStatusNode
- CosmotechApi.ScenarioRunTemplateParameterValue
- CosmotechApi.ScenarioSecurity
- CosmotechApi.ScenarioValidationStatus
- CosmotechApi.SendRunDataRequest
- CosmotechApi.Solution
- CosmotechApi.SolutionAccessControl
- CosmotechApi.SolutionRole
- CosmotechApi.SolutionSecurity
- CosmotechApi.SourceInfo
- CosmotechApi.SubDatasetGraphQuery
- CosmotechApi.TwinGraphBatchResult
- CosmotechApi.TwinGraphHash
- CosmotechApi.TwinGraphQuery
- CosmotechApi.Validator
- CosmotechApi.ValidatorRun
- CosmotechApi.Workspace
- CosmotechApi.WorkspaceAccessControl
- CosmotechApi.WorkspaceFile
- CosmotechApi.WorkspaceRole
- CosmotechApi.WorkspaceSecret
- CosmotechApi.WorkspaceSecurity
- CosmotechApi.WorkspaceSolution
- CosmotechApi.WorkspaceWebApp
Authentication schemes defined for the API:
- Type: OAuth
- Flow: implicit
- Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
-
Scopes:
- http://dev.api.cosmotech.com/platform: Platform scope