Cosmo Tech Platform API
This C# SDK is automatically generated by the OpenAPI Generator project:
- API version: 3.2.2-SNAPSHOT
- SDK version: 1.0.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api
- RestSharp - 106.13.0 or later
- Json.NET - 13.0.2 or later
- JsonSubTypes - 1.8.0 or later
- System.ComponentModel.Annotations - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.
Run the following command to generate the DLL
- [Mac/Linux]
/bin/sh build.sh
- [Windows]
build.bat
Then include the DLL (under the bin
folder) in the C# project, and use the namespaces:
using Com.Cosmotech.Api;
using Com.Cosmotech.Client;
using Com.Cosmotech.Model;
A .nuspec
is included with the project. You can follow the Nuget quickstart to create and publish packages.
This .nuspec
uses placeholders from the .csproj
, so build the .csproj
directly:
nuget pack -Build -OutputDirectory out Com.Cosmotech.csproj
Then, publish to a local feed or other host and consume the new package via Nuget as usual.
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
using System.Collections.Generic;
using System.Diagnostics;
using Com.Cosmotech.Api;
using Com.Cosmotech.Client;
using Com.Cosmotech.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://dev.api.cosmotech.com";
// Configure OAuth2 access token for authorization: oAuth2AuthCode
config.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new ConnectorApi(config);
var page = 56; // int? | page number to query (optional)
var size = 56; // int? | amount of result by page (optional)
try
{
// List all Connectors
List<Connector> result = apiInstance.FindAllConnectors(page, size);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ConnectorApi.FindAllConnectors: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
All URIs are relative to https://dev.api.cosmotech.com
Class | Method | HTTP request | Description |
---|---|---|---|
ConnectorApi | FindAllConnectors | GET /connectors | List all Connectors |
ConnectorApi | FindConnectorById | GET /connectors/{connector_id} | Get the details of a connector |
ConnectorApi | FindConnectorByName | GET /connectors/name/{connector_name} | Get the details of a connector |
ConnectorApi | RegisterConnector | POST /connectors | Register a new connector |
ConnectorApi | UnregisterConnector | DELETE /connectors/{connector_id} | Unregister a connector |
DatasetApi | AddDatasetAccessControl | POST /organizations/{organization_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset |
DatasetApi | AddOrReplaceDatasetCompatibilityElements | POST /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Add Dataset Compatibility elements. |
DatasetApi | CopyDataset | POST /organizations/{organization_id}/datasets/copy | Copy a Dataset to another Dataset. |
DatasetApi | CreateDataset | POST /organizations/{organization_id}/datasets | Create a new Dataset |
DatasetApi | CreateSubDataset | POST /organizations/{organization_id}/datasets/{dataset_id}/subdataset | Create a sub-dataset from the dataset in parameter |
DatasetApi | CreateTwingraphEntities | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Create new entities in a graph instance |
DatasetApi | DeleteDataset | DELETE /organizations/{organization_id}/datasets/{dataset_id} | Delete a dataset |
DatasetApi | DeleteTwingraphEntities | DELETE /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Delete entities in a graph instance |
DatasetApi | DownloadTwingraph | GET /organizations/{organization_id}/datasets/twingraph/download/{hash} | Download a graph as a zip file |
DatasetApi | FindAllDatasets | GET /organizations/{organization_id}/datasets | List all Datasets |
DatasetApi | FindDatasetById | GET /organizations/{organization_id}/datasets/{dataset_id} | Get the details of a Dataset |
DatasetApi | GetDatasetAccessControl | GET /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset |
DatasetApi | GetDatasetSecurity | GET /organizations/{organization_id}/datasets/{dataset_id}/security | Get the Dataset security information |
DatasetApi | GetDatasetSecurityUsers | GET /organizations/{organization_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list |
DatasetApi | GetDatasetTwingraphStatus | GET /organizations/{organization_id}/datasets/{dataset_id}/status | Get the dataset's refresh job status |
DatasetApi | GetTwingraphEntities | GET /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Get entities in a graph instance |
DatasetApi | LinkWorkspace | POST /organizations/{organization_id}/datasets/{dataset_id}/link | |
DatasetApi | RefreshDataset | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh | Refresh data on dataset from dataset's source |
DatasetApi | RemoveAllDatasetCompatibilityElements | DELETE /organizations/{organization_id}/datasets/{dataset_id}/compatibility | Remove all Dataset Compatibility elements from the Dataset specified |
DatasetApi | RemoveDatasetAccessControl | DELETE /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset |
DatasetApi | RollbackRefresh | POST /organizations/{organization_id}/datasets/{dataset_id}/refresh/rollback | Rollback the dataset after a failed refresh |
DatasetApi | SearchDatasets | POST /organizations/{organization_id}/datasets/search | Search Datasets by tags |
DatasetApi | SetDatasetDefaultSecurity | POST /organizations/{organization_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
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 |
DatasetApi | TwingraphBatchUpdate | POST /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance |
DatasetApi | TwingraphQuery | POST /organizations/{organization_id}/datasets/{dataset_id}/twingraph | Return the result of a query made on the graph instance as a json |
DatasetApi | UnlinkWorkspace | POST /organizations/{organization_id}/datasets/{dataset_id}/unlink | |
DatasetApi | UpdateDataset | PATCH /organizations/{organization_id}/datasets/{dataset_id} | Update a dataset |
DatasetApi | UpdateDatasetAccessControl | PATCH /organizations/{organization_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset |
DatasetApi | UpdateTwingraphEntities | PATCH /organizations/{organization_id}/datasets/{dataset_id}/twingraph/{type} | Update entities in a graph instance |
DatasetApi | UploadTwingraph | POST /organizations/{organization_id}/datasets/{dataset_id} | Upload data from zip file to dataset's twingraph |
OrganizationApi | AddOrganizationAccessControl | POST /organizations/{organization_id}/security/access | Add a control access to the Organization |
OrganizationApi | FindAllOrganizations | GET /organizations | List all Organizations |
OrganizationApi | FindOrganizationById | GET /organizations/{organization_id} | Get the details of an Organization |
OrganizationApi | GetAllPermissions | GET /organizations/permissions | Get all permissions per components |
OrganizationApi | GetOrganizationAccessControl | GET /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization |
OrganizationApi | GetOrganizationPermissions | GET /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role |
OrganizationApi | GetOrganizationSecurity | GET /organizations/{organization_id}/security | Get the Organization security information |
OrganizationApi | GetOrganizationSecurityUsers | GET /organizations/{organization_id}/security/users | Get the Organization security users list |
OrganizationApi | RegisterOrganization | POST /organizations | Register a new organization |
OrganizationApi | RemoveOrganizationAccessControl | DELETE /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization |
OrganizationApi | SetOrganizationDefaultSecurity | POST /organizations/{organization_id}/security/default | Set the Organization default security |
OrganizationApi | UnregisterOrganization | DELETE /organizations/{organization_id} | Unregister an organization |
OrganizationApi | UpdateOrganization | PATCH /organizations/{organization_id} | Update an Organization |
OrganizationApi | UpdateOrganizationAccessControl | PATCH /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization |
RunApi | DeleteRun | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run |
RunApi | GetRun | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run |
RunApi | GetRunLogs | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run |
RunApi | GetRunStatus | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run |
RunApi | ListRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner |
RunApi | QueryRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data |
RunApi | SendRunData | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run |
RunnerApi | AddRunnerAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner |
RunnerApi | CreateRunner | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner |
RunnerApi | DeleteRunner | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner |
RunnerApi | GetRunner | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of an runner |
RunnerApi | GetRunnerAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner |
RunnerApi | GetRunnerPermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role |
RunnerApi | GetRunnerSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information |
RunnerApi | GetRunnerSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list |
RunnerApi | ListRunners | GET /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners |
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 |
RunnerApi | SetRunnerDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security |
RunnerApi | StartRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters |
RunnerApi | StopRun | POST /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run |
RunnerApi | UpdateRunner | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner |
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 |
ScenarioApi | AddOrReplaceScenarioParameterValues | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/parameterValues | Add (or replace) Parameter Values for the Scenario specified |
ScenarioApi | AddScenarioAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access | Add a control access to the Scenario |
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 |
ScenarioApi | CreateScenario | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | Create a new Scenario |
ScenarioApi | DeleteAllScenarios | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | Delete all Scenarios of the Workspace |
ScenarioApi | DeleteScenario | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Delete a scenario |
ScenarioApi | DownloadScenarioData | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/downloads | Download Scenario data |
ScenarioApi | FindAllScenarios | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios | List all Scenarios |
ScenarioApi | FindAllScenariosByValidationStatus | GET /organizations/{organization_id}/workspaces/{workspace_id}/{validationStatus} | List all Scenarios by validation status |
ScenarioApi | FindScenarioById | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Get the details of an scenario |
ScenarioApi | GetScenarioAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/access/{identity_id} | Get a control access for the Scenario |
ScenarioApi | GetScenarioDataDownloadJobInfo | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/downloads/{download_id} | Get Scenario data download URL |
ScenarioApi | GetScenarioPermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/permissions/{role} | Get the Scenario permission by given role |
ScenarioApi | GetScenarioSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security | Get the Scenario security information |
ScenarioApi | GetScenarioSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/users | Get the Scenario security users list |
ScenarioApi | GetScenarioValidationStatusById | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/ValidationStatus | Get the validation status of an scenario |
ScenarioApi | GetScenariosTree | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/tree | Get the Scenarios Tree |
ScenarioApi | RemoveAllScenarioParameterValues | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/parameterValues | Remove all Parameter Values from the Scenario specified |
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 |
ScenarioApi | SetScenarioDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/security/default | Set the Scenario default security |
ScenarioApi | UpdateScenario | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id} | Update a scenario |
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 |
ScenariorunApi | DeleteHistoricalDataOrganization | DELETE /organizations/{organization_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Organization |
ScenariorunApi | DeleteHistoricalDataScenario | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Scenario |
ScenariorunApi | DeleteHistoricalDataWorkspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns/historicaldata | Delete all historical ScenarioRuns in the Workspace |
ScenariorunApi | DeleteScenarioRun | DELETE /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Delete a scenariorun |
ScenariorunApi | FindScenarioRunById | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id} | Get the details of a scenariorun |
ScenariorunApi | GetScenarioRunCumulatedLogs | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/cumulatedlogs | Get the cumulated logs of a scenariorun |
ScenariorunApi | GetScenarioRunLogs | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/logs | get the logs for the ScenarioRun |
ScenariorunApi | GetScenarioRunStatus | GET /organizations/{organization_id}/scenarioruns/{scenariorun_id}/status | get the status for the ScenarioRun |
ScenariorunApi | GetScenarioRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/scenarioruns | get the list of ScenarioRuns for the Scenario |
ScenariorunApi | GetWorkspaceScenarioRuns | GET /organizations/{organization_id}/workspaces/{workspace_id}/scenarioruns | get the list of ScenarioRuns for the Workspace |
ScenariorunApi | RunScenario | POST /organizations/{organization_id}/workspaces/{workspace_id}/scenarios/{scenario_id}/run | run a ScenarioRun for the Scenario |
ScenariorunApi | SearchScenarioRuns | POST /organizations/{organization_id}/scenarioruns/search | Search ScenarioRuns |
ScenariorunApi | StartScenarioRunContainers | POST /organizations/{organization_id}/scenarioruns/startcontainers | Start a new scenariorun with raw containers definition |
ScenariorunApi | StopScenarioRun | POST /organizations/{organization_id}/scenarioruns/{scenariorun_id}/stop | stop a ScenarioRun for the Scenario |
SolutionApi | AddOrReplaceParameterGroups | POST /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Add Parameter Groups. Any item with the same ID will be overwritten |
SolutionApi | AddOrReplaceParameters | POST /organizations/{organization_id}/solutions/{solution_id}/parameters | Add Parameters. Any item with the same ID will be overwritten |
SolutionApi | AddOrReplaceRunTemplates | POST /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Add Run Templates. Any item with the same ID will be overwritten |
SolutionApi | AddSolutionAccessControl | POST /organizations/{organization_id}/solutions/{solution_id}/security/access | Add a control access to the Solution |
SolutionApi | CreateSolution | POST /organizations/{organization_id}/solutions | Register a new solution |
SolutionApi | DeleteSolution | DELETE /organizations/{organization_id}/solutions/{solution_id} | Delete a solution |
SolutionApi | DeleteSolutionRunTemplate | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Remove the specified Solution Run Template |
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 |
SolutionApi | FindAllSolutions | GET /organizations/{organization_id}/solutions | List all Solutions |
SolutionApi | FindSolutionById | GET /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution |
SolutionApi | GetSolutionAccessControl | GET /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get a control access for the Solution |
SolutionApi | GetSolutionSecurity | GET /organizations/{organization_id}/solutions/{solution_id}/security | Get the Solution security information |
SolutionApi | GetSolutionSecurityUsers | GET /organizations/{organization_id}/solutions/{solution_id}/security/users | Get the Solution security users list |
SolutionApi | RemoveAllRunTemplates | DELETE /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Remove all Run Templates from the Solution specified |
SolutionApi | RemoveAllSolutionParameterGroups | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Remove all Parameter Groups from the Solution specified |
SolutionApi | RemoveAllSolutionParameters | DELETE /organizations/{organization_id}/solutions/{solution_id}/parameters | Remove all Parameters from the Solution specified |
SolutionApi | RemoveSolutionAccessControl | DELETE /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Remove the specified access from the given Organization Solution |
SolutionApi | SetSolutionDefaultSecurity | POST /organizations/{organization_id}/solutions/{solution_id}/security/default | Set the Solution default security |
SolutionApi | UpdateSolution | PATCH /organizations/{organization_id}/solutions/{solution_id} | Update a solution |
SolutionApi | UpdateSolutionAccessControl | PATCH /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update the specified access to User for a Solution |
SolutionApi | UpdateSolutionRunTemplate | PATCH /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update the specified Solution Run Template |
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 |
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 |
TwingraphApi | BatchUploadUpdate | POST /organizations/{organization_id}/twingraph/{graph_id}/batch | Async batch update by loading a CSV file on a graph instance |
TwingraphApi | CreateEntities | POST /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Create new entities in a graph instance |
TwingraphApi | CreateGraph | POST /organizations/{organization_id}/twingraph/{graph_id} | Create a new graph |
TwingraphApi | Delete | DELETE /organizations/{organization_id}/twingraph/{graph_id} | Delete all versions of a graph and his metadatas |
TwingraphApi | DeleteEntities | DELETE /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Delete entities in a graph instance |
TwingraphApi | DownloadGraph | GET /organizations/{organization_id}/twingraph/download/{hash} | Download a graph compressed in a zip file |
TwingraphApi | FindAllTwingraphs | GET /organizations/{organization_id}/twingraphs | Return the list of all graphs stored in the organization |
TwingraphApi | GetEntities | GET /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Get entities in a graph instance |
TwingraphApi | GetGraphMetaData | GET /organizations/{organization_id}/twingraph/{graph_id}/metadata | Return the metaData of the specified graph |
TwingraphApi | JobStatus | GET /organizations/{organization_id}/job/{job_id}/status | Get the status of a job |
TwingraphApi | Query | POST /organizations/{organization_id}/twingraph/{graph_id}/query | Run a query on a graph instance |
TwingraphApi | UpdateEntities | PATCH /organizations/{organization_id}/twingraph/{graph_id}/entity/{type} | Update entities in a graph instance |
TwingraphApi | UpdateGraphMetaData | PATCH /organizations/{organization_id}/twingraph/{graph_id}/metadata | Update the metaData of the specified graph |
WorkspaceApi | AddWorkspaceAccessControl | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace |
WorkspaceApi | CreateSecret | POST /organizations/{organization_id}/workspaces/{workspace_id}/secret | Create a secret for the Workspace |
WorkspaceApi | CreateWorkspace | POST /organizations/{organization_id}/workspaces | Create a new workspace |
WorkspaceApi | DeleteAllWorkspaceFiles | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files |
WorkspaceApi | DeleteWorkspace | DELETE /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace |
WorkspaceApi | DeleteWorkspaceFile | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file |
WorkspaceApi | DownloadWorkspaceFile | GET /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified |
WorkspaceApi | FindAllWorkspaceFiles | GET /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files |
WorkspaceApi | FindAllWorkspaces | GET /organizations/{organization_id}/workspaces | List all Workspaces |
WorkspaceApi | FindWorkspaceById | GET /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of an workspace |
WorkspaceApi | GetWorkspaceAccessControl | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace |
WorkspaceApi | GetWorkspacePermissions | GET /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role |
WorkspaceApi | GetWorkspaceSecurity | GET /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information |
WorkspaceApi | GetWorkspaceSecurityUsers | GET /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list |
WorkspaceApi | LinkDataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/link | |
WorkspaceApi | RemoveWorkspaceAccessControl | DELETE /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Organization Workspace |
WorkspaceApi | SetWorkspaceDefaultSecurity | POST /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Set the Workspace default security |
WorkspaceApi | UnlinkDataset | POST /organizations/{organization_id}/workspaces/{workspace_id}/unlink | |
WorkspaceApi | UpdateWorkspace | PATCH /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace |
WorkspaceApi | UpdateWorkspaceAccessControl | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace |
WorkspaceApi | UploadWorkspaceFile | POST /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace |
- Model.ComponentRolePermissions
- Model.Connector
- Model.ConnectorParameter
- Model.ConnectorParameterGroup
- Model.ContainerResourceSizeInfo
- Model.ContainerResourceSizing
- Model.Dataset
- Model.DatasetAccessControl
- Model.DatasetCompatibility
- Model.DatasetConnector
- Model.DatasetCopyParameters
- Model.DatasetRole
- Model.DatasetSearch
- Model.DatasetSecurity
- Model.DatasetSourceType
- Model.DatasetTwinGraphHash
- Model.DatasetTwinGraphInfo
- Model.DatasetTwinGraphQuery
- Model.DeleteHistoricalData
- Model.FileUploadMetadata
- Model.FileUploadValidation
- Model.GraphProperties
- Model.IngestionStatusEnum
- Model.IoTypesEnum
- Model.Organization
- Model.OrganizationAccessControl
- Model.OrganizationRole
- Model.OrganizationSecurity
- Model.QueryResult
- Model.ResourceSizeInfo
- Model.Run
- Model.RunContainer
- Model.RunContainerArtifact
- Model.RunContainerLogs
- Model.RunData
- Model.RunDataQuery
- Model.RunLogs
- Model.RunResourceRequested
- Model.RunSearch
- Model.RunSearchState
- Model.RunStartContainers
- Model.RunState
- Model.RunStatus
- Model.RunStatusNode
- Model.RunTemplate
- Model.RunTemplateHandlerId
- Model.RunTemplateOrchestrator
- Model.RunTemplateParameter
- Model.RunTemplateParameterGroup
- Model.RunTemplateParameterValue
- Model.RunTemplateResourceSizing
- Model.RunTemplateStepSource
- Model.Runner
- Model.RunnerAccessControl
- Model.RunnerChangedParameterValue
- Model.RunnerComparisonResult
- Model.RunnerDataDownloadInfo
- Model.RunnerDataDownloadJob
- Model.RunnerResourceSizing
- Model.RunnerRole
- Model.RunnerRunTemplateParameterValue
- Model.RunnerSecurity
- Model.RunnerValidationStatus
- Model.Scenario
- Model.ScenarioAccessControl
- Model.ScenarioChangedParameterValue
- Model.ScenarioComparisonResult
- Model.ScenarioDataDownloadInfo
- Model.ScenarioDataDownloadJob
- Model.ScenarioJobState
- Model.ScenarioLastRun
- Model.ScenarioResourceSizing
- Model.ScenarioRole
- Model.ScenarioRun
- Model.ScenarioRunContainer
- Model.ScenarioRunContainerArtifact
- Model.ScenarioRunContainerLogs
- Model.ScenarioRunLogs
- Model.ScenarioRunResourceRequested
- Model.ScenarioRunSearch
- Model.ScenarioRunSearchState
- Model.ScenarioRunStartContainers
- Model.ScenarioRunState
- Model.ScenarioRunStatus
- Model.ScenarioRunStatusNode
- Model.ScenarioRunTemplateParameterValue
- Model.ScenarioSecurity
- Model.ScenarioValidationStatus
- Model.SendRunDataRequest
- Model.Solution
- Model.SolutionAccessControl
- Model.SolutionRole
- Model.SolutionSecurity
- Model.SourceInfo
- Model.SubDatasetGraphQuery
- Model.TwinGraphBatchResult
- Model.TwinGraphHash
- Model.TwinGraphQuery
- Model.TwincacheStatusEnum
- Model.Validator
- Model.Workspace
- Model.WorkspaceAccessControl
- Model.WorkspaceFile
- Model.WorkspaceRole
- Model.WorkspaceSecret
- Model.WorkspaceSecurity
- Model.WorkspaceSolution
- Model.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