@cosmotech/api-ts 3.3.4 → 5.0.0-beta3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +83 -0
- package/.openapi-generator/VERSION +1 -1
- package/LICENSE +1 -1
- package/README.md +206 -2
- package/api.ts +6034 -13173
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/configuration.ts +7 -2
- package/dist/api.d.ts +3440 -7510
- package/dist/api.js +3853 -11153
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +14 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AboutInfo.md +21 -0
- package/docs/AboutInfoVersion.md +33 -0
- package/docs/ComponentRolePermissions.md +23 -0
- package/docs/ContainerResourceSizeInfo.md +23 -0
- package/docs/ContainerResourceSizing.md +23 -0
- package/docs/CreateInfo.md +24 -0
- package/docs/CreatedRun.md +21 -0
- package/docs/Dataset.md +39 -0
- package/docs/DatasetAccessControl.md +23 -0
- package/docs/DatasetApi.md +1289 -0
- package/docs/DatasetCreateRequest.md +31 -0
- package/docs/DatasetPart.md +41 -0
- package/docs/DatasetPartCreateRequest.md +29 -0
- package/docs/DatasetPartTypeEnum.md +11 -0
- package/docs/DatasetPartUpdateRequest.md +23 -0
- package/docs/DatasetRole.md +21 -0
- package/docs/DatasetSecurity.md +23 -0
- package/docs/DatasetUpdateRequest.md +29 -0
- package/docs/EditInfo.md +22 -0
- package/docs/LastRunInfo.md +23 -0
- package/docs/MetaApi.md +51 -0
- package/docs/Organization.md +29 -0
- package/docs/OrganizationAccessControl.md +23 -0
- package/docs/OrganizationApi.md +758 -0
- package/docs/OrganizationCreateRequest.md +23 -0
- package/docs/OrganizationEditInfo.md +22 -0
- package/docs/OrganizationRole.md +21 -0
- package/docs/OrganizationSecurity.md +23 -0
- package/docs/OrganizationUpdateRequest.md +21 -0
- package/docs/QueryResult.md +21 -0
- package/docs/ResourceSizeInfo.md +23 -0
- package/docs/Run.md +55 -0
- package/docs/RunApi.md +442 -0
- package/docs/RunContainer.md +41 -0
- package/docs/RunData.md +25 -0
- package/docs/RunDataQuery.md +21 -0
- package/docs/RunEditInfo.md +22 -0
- package/docs/RunResourceRequested.md +23 -0
- package/docs/RunState.md +17 -0
- package/docs/RunStatus.md +49 -0
- package/docs/RunStatusNode.md +43 -0
- package/docs/RunTemplate.md +37 -0
- package/docs/RunTemplateCreateRequest.md +37 -0
- package/docs/RunTemplateParameter.md +37 -0
- package/docs/RunTemplateParameterCreateRequest.md +37 -0
- package/docs/RunTemplateParameterGroup.md +33 -0
- package/docs/RunTemplateParameterGroupCreateRequest.md +33 -0
- package/docs/RunTemplateParameterGroupUpdateRequest.md +31 -0
- package/docs/RunTemplateParameterUpdateRequest.md +35 -0
- package/docs/RunTemplateParameterValue.md +25 -0
- package/docs/RunTemplateResourceSizing.md +23 -0
- package/docs/RunTemplateUpdateRequest.md +35 -0
- package/docs/Runner.md +61 -0
- package/docs/RunnerAccessControl.md +23 -0
- package/docs/RunnerApi.md +908 -0
- package/docs/RunnerCreateRequest.md +45 -0
- package/docs/RunnerEditInfo.md +22 -0
- package/docs/RunnerResourceSizing.md +23 -0
- package/docs/RunnerRole.md +21 -0
- package/docs/RunnerRunTemplateParameterValue.md +27 -0
- package/docs/RunnerSecurity.md +23 -0
- package/docs/RunnerUpdateRequest.md +39 -0
- package/docs/RunnerValidationStatus.md +15 -0
- package/docs/SendRunDataRequest.md +23 -0
- package/docs/Solution.md +53 -0
- package/docs/SolutionAccessControl.md +23 -0
- package/docs/SolutionApi.md +1580 -0
- package/docs/SolutionCreateRequest.md +43 -0
- package/docs/SolutionEditInfo.md +22 -0
- package/docs/SolutionRole.md +21 -0
- package/docs/SolutionSecurity.md +23 -0
- package/docs/SolutionUpdateRequest.md +41 -0
- package/docs/Workspace.md +45 -0
- package/docs/WorkspaceAccessControl.md +23 -0
- package/docs/WorkspaceApi.md +1044 -0
- package/docs/WorkspaceCreateRequest.md +37 -0
- package/docs/WorkspaceEditInfo.md +22 -0
- package/docs/WorkspaceFile.md +21 -0
- package/docs/WorkspaceRole.md +21 -0
- package/docs/WorkspaceSecurity.md +23 -0
- package/docs/WorkspaceSolution.md +25 -0
- package/docs/WorkspaceUpdateRequest.md +33 -0
- package/docs/WorkspaceWebApp.md +25 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/scripts/git_push.sh +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -6,6 +6,89 @@ api.ts
|
|
|
6
6
|
base.ts
|
|
7
7
|
common.ts
|
|
8
8
|
configuration.ts
|
|
9
|
+
docs/AboutInfo.md
|
|
10
|
+
docs/AboutInfoVersion.md
|
|
11
|
+
docs/ComponentRolePermissions.md
|
|
12
|
+
docs/ContainerResourceSizeInfo.md
|
|
13
|
+
docs/ContainerResourceSizing.md
|
|
14
|
+
docs/CreateInfo.md
|
|
15
|
+
docs/CreatedRun.md
|
|
16
|
+
docs/Dataset.md
|
|
17
|
+
docs/DatasetAccessControl.md
|
|
18
|
+
docs/DatasetApi.md
|
|
19
|
+
docs/DatasetCreateRequest.md
|
|
20
|
+
docs/DatasetPart.md
|
|
21
|
+
docs/DatasetPartCreateRequest.md
|
|
22
|
+
docs/DatasetPartTypeEnum.md
|
|
23
|
+
docs/DatasetPartUpdateRequest.md
|
|
24
|
+
docs/DatasetRole.md
|
|
25
|
+
docs/DatasetSecurity.md
|
|
26
|
+
docs/DatasetUpdateRequest.md
|
|
27
|
+
docs/EditInfo.md
|
|
28
|
+
docs/LastRunInfo.md
|
|
29
|
+
docs/MetaApi.md
|
|
30
|
+
docs/Organization.md
|
|
31
|
+
docs/OrganizationAccessControl.md
|
|
32
|
+
docs/OrganizationApi.md
|
|
33
|
+
docs/OrganizationCreateRequest.md
|
|
34
|
+
docs/OrganizationEditInfo.md
|
|
35
|
+
docs/OrganizationRole.md
|
|
36
|
+
docs/OrganizationSecurity.md
|
|
37
|
+
docs/OrganizationUpdateRequest.md
|
|
38
|
+
docs/QueryResult.md
|
|
39
|
+
docs/ResourceSizeInfo.md
|
|
40
|
+
docs/Run.md
|
|
41
|
+
docs/RunApi.md
|
|
42
|
+
docs/RunContainer.md
|
|
43
|
+
docs/RunData.md
|
|
44
|
+
docs/RunDataQuery.md
|
|
45
|
+
docs/RunEditInfo.md
|
|
46
|
+
docs/RunResourceRequested.md
|
|
47
|
+
docs/RunState.md
|
|
48
|
+
docs/RunStatus.md
|
|
49
|
+
docs/RunStatusNode.md
|
|
50
|
+
docs/RunTemplate.md
|
|
51
|
+
docs/RunTemplateCreateRequest.md
|
|
52
|
+
docs/RunTemplateParameter.md
|
|
53
|
+
docs/RunTemplateParameterCreateRequest.md
|
|
54
|
+
docs/RunTemplateParameterGroup.md
|
|
55
|
+
docs/RunTemplateParameterGroupCreateRequest.md
|
|
56
|
+
docs/RunTemplateParameterGroupUpdateRequest.md
|
|
57
|
+
docs/RunTemplateParameterUpdateRequest.md
|
|
58
|
+
docs/RunTemplateParameterValue.md
|
|
59
|
+
docs/RunTemplateResourceSizing.md
|
|
60
|
+
docs/RunTemplateUpdateRequest.md
|
|
61
|
+
docs/Runner.md
|
|
62
|
+
docs/RunnerAccessControl.md
|
|
63
|
+
docs/RunnerApi.md
|
|
64
|
+
docs/RunnerCreateRequest.md
|
|
65
|
+
docs/RunnerEditInfo.md
|
|
66
|
+
docs/RunnerResourceSizing.md
|
|
67
|
+
docs/RunnerRole.md
|
|
68
|
+
docs/RunnerRunTemplateParameterValue.md
|
|
69
|
+
docs/RunnerSecurity.md
|
|
70
|
+
docs/RunnerUpdateRequest.md
|
|
71
|
+
docs/RunnerValidationStatus.md
|
|
72
|
+
docs/SendRunDataRequest.md
|
|
73
|
+
docs/Solution.md
|
|
74
|
+
docs/SolutionAccessControl.md
|
|
75
|
+
docs/SolutionApi.md
|
|
76
|
+
docs/SolutionCreateRequest.md
|
|
77
|
+
docs/SolutionEditInfo.md
|
|
78
|
+
docs/SolutionRole.md
|
|
79
|
+
docs/SolutionSecurity.md
|
|
80
|
+
docs/SolutionUpdateRequest.md
|
|
81
|
+
docs/Workspace.md
|
|
82
|
+
docs/WorkspaceAccessControl.md
|
|
83
|
+
docs/WorkspaceApi.md
|
|
84
|
+
docs/WorkspaceCreateRequest.md
|
|
85
|
+
docs/WorkspaceEditInfo.md
|
|
86
|
+
docs/WorkspaceFile.md
|
|
87
|
+
docs/WorkspaceRole.md
|
|
88
|
+
docs/WorkspaceSecurity.md
|
|
89
|
+
docs/WorkspaceSolution.md
|
|
90
|
+
docs/WorkspaceUpdateRequest.md
|
|
91
|
+
docs/WorkspaceWebApp.md
|
|
9
92
|
git_push.sh
|
|
10
93
|
index.ts
|
|
11
94
|
package.json
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.13.0
|
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @cosmotech/api-ts@
|
|
1
|
+
## @cosmotech/api-ts@5.0.1-SNAPSHOT
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @cosmotech/api-ts@
|
|
39
|
+
npm install @cosmotech/api-ts@5.0.1-SNAPSHOT --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,3 +44,207 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *http://localhost:8080*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*DatasetApi* | [**createDataset**](docs/DatasetApi.md#createdataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a Dataset
|
|
55
|
+
*DatasetApi* | [**createDatasetAccessControl**](docs/DatasetApi.md#createdatasetaccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Add a control access to the Dataset
|
|
56
|
+
*DatasetApi* | [**createDatasetPart**](docs/DatasetApi.md#createdatasetpart) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Create a data part of a Dataset
|
|
57
|
+
*DatasetApi* | [**deleteDataset**](docs/DatasetApi.md#deletedataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a Dataset
|
|
58
|
+
*DatasetApi* | [**deleteDatasetAccessControl**](docs/DatasetApi.md#deletedatasetaccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Remove the specified access from the given Dataset
|
|
59
|
+
*DatasetApi* | [**deleteDatasetPart**](docs/DatasetApi.md#deletedatasetpart) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Delete a Dataset part
|
|
60
|
+
*DatasetApi* | [**downloadDatasetPart**](docs/DatasetApi.md#downloaddatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/download | Download data from a dataset part
|
|
61
|
+
*DatasetApi* | [**getDataset**](docs/DatasetApi.md#getdataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Retrieve a Dataset
|
|
62
|
+
*DatasetApi* | [**getDatasetAccessControl**](docs/DatasetApi.md#getdatasetaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset
|
|
63
|
+
*DatasetApi* | [**getDatasetPart**](docs/DatasetApi.md#getdatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Retrieve a data part of a Dataset
|
|
64
|
+
*DatasetApi* | [**listDatasetParts**](docs/DatasetApi.md#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset
|
|
65
|
+
*DatasetApi* | [**listDatasetSecurityUsers**](docs/DatasetApi.md#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list
|
|
66
|
+
*DatasetApi* | [**listDatasets**](docs/DatasetApi.md#listdatasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Retrieve a list of defined Dataset
|
|
67
|
+
*DatasetApi* | [**queryData**](docs/DatasetApi.md#querydata) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/query | Get data of a Dataset
|
|
68
|
+
*DatasetApi* | [**replaceDatasetPart**](docs/DatasetApi.md#replacedatasetpart) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Replace existing dataset parts of a Dataset
|
|
69
|
+
*DatasetApi* | [**searchDatasetParts**](docs/DatasetApi.md#searchdatasetparts) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/search | Search Dataset parts by tags
|
|
70
|
+
*DatasetApi* | [**searchDatasets**](docs/DatasetApi.md#searchdatasets) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/search | Search Datasets by tags
|
|
71
|
+
*DatasetApi* | [**updateDataset**](docs/DatasetApi.md#updatedataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset
|
|
72
|
+
*DatasetApi* | [**updateDatasetAccessControl**](docs/DatasetApi.md#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset
|
|
73
|
+
*DatasetApi* | [**updateDatasetDefaultSecurity**](docs/DatasetApi.md#updatedatasetdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security
|
|
74
|
+
*MetaApi* | [**about**](docs/MetaApi.md#about) | **GET** /about | Get various information about the API
|
|
75
|
+
*OrganizationApi* | [**createOrganization**](docs/OrganizationApi.md#createorganization) | **POST** /organizations | Create a new organization
|
|
76
|
+
*OrganizationApi* | [**createOrganizationAccessControl**](docs/OrganizationApi.md#createorganizationaccesscontrol) | **POST** /organizations/{organization_id}/security/access | Add a control access to the Organization
|
|
77
|
+
*OrganizationApi* | [**deleteOrganization**](docs/OrganizationApi.md#deleteorganization) | **DELETE** /organizations/{organization_id} | Delete an organization
|
|
78
|
+
*OrganizationApi* | [**deleteOrganizationAccessControl**](docs/OrganizationApi.md#deleteorganizationaccesscontrol) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization
|
|
79
|
+
*OrganizationApi* | [**getOrganization**](docs/OrganizationApi.md#getorganization) | **GET** /organizations/{organization_id} | Get the details of an Organization
|
|
80
|
+
*OrganizationApi* | [**getOrganizationAccessControl**](docs/OrganizationApi.md#getorganizationaccesscontrol) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization
|
|
81
|
+
*OrganizationApi* | [**getOrganizationPermissions**](docs/OrganizationApi.md#getorganizationpermissions) | **GET** /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role
|
|
82
|
+
*OrganizationApi* | [**getOrganizationSecurity**](docs/OrganizationApi.md#getorganizationsecurity) | **GET** /organizations/{organization_id}/security | Get the Organization security information
|
|
83
|
+
*OrganizationApi* | [**listOrganizationSecurityUsers**](docs/OrganizationApi.md#listorganizationsecurityusers) | **GET** /organizations/{organization_id}/security/users | Get the Organization security users list
|
|
84
|
+
*OrganizationApi* | [**listOrganizations**](docs/OrganizationApi.md#listorganizations) | **GET** /organizations | List all Organizations
|
|
85
|
+
*OrganizationApi* | [**listPermissions**](docs/OrganizationApi.md#listpermissions) | **GET** /organizations/permissions | Get all permissions per components
|
|
86
|
+
*OrganizationApi* | [**updateOrganization**](docs/OrganizationApi.md#updateorganization) | **PATCH** /organizations/{organization_id} | Update an Organization
|
|
87
|
+
*OrganizationApi* | [**updateOrganizationAccessControl**](docs/OrganizationApi.md#updateorganizationaccesscontrol) | **PATCH** /organizations/{organization_id}/security/access/{identity_id} | Update the specified access to User for an Organization
|
|
88
|
+
*OrganizationApi* | [**updateOrganizationDefaultSecurity**](docs/OrganizationApi.md#updateorganizationdefaultsecurity) | **PATCH** /organizations/{organization_id}/security/default | Update the Organization default security
|
|
89
|
+
*RunApi* | [**deleteRun**](docs/RunApi.md#deleterun) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Delete a run
|
|
90
|
+
*RunApi* | [**getRun**](docs/RunApi.md#getrun) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id} | Get the details of a run
|
|
91
|
+
*RunApi* | [**getRunLogs**](docs/RunApi.md#getrunlogs) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/logs | get the logs for the Run
|
|
92
|
+
*RunApi* | [**getRunStatus**](docs/RunApi.md#getrunstatus) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/status | get the status for the Run
|
|
93
|
+
*RunApi* | [**listRuns**](docs/RunApi.md#listruns) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs | get the list of Runs for the Runner
|
|
94
|
+
*RunApi* | [**queryRunData**](docs/RunApi.md#queryrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/query | query the run data
|
|
95
|
+
*RunApi* | [**sendRunData**](docs/RunApi.md#sendrundata) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/runs/{run_id}/data/send | Send data associated to a run
|
|
96
|
+
*RunnerApi* | [**createRunner**](docs/RunnerApi.md#createrunner) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners | Create a new Runner
|
|
97
|
+
*RunnerApi* | [**createRunnerAccessControl**](docs/RunnerApi.md#createrunneraccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access | Add a control access to the Runner
|
|
98
|
+
*RunnerApi* | [**deleteRunner**](docs/RunnerApi.md#deleterunner) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Delete a runner
|
|
99
|
+
*RunnerApi* | [**deleteRunnerAccessControl**](docs/RunnerApi.md#deleterunneraccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Runner
|
|
100
|
+
*RunnerApi* | [**getRunner**](docs/RunnerApi.md#getrunner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of a runner
|
|
101
|
+
*RunnerApi* | [**getRunnerAccessControl**](docs/RunnerApi.md#getrunneraccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner
|
|
102
|
+
*RunnerApi* | [**getRunnerSecurity**](docs/RunnerApi.md#getrunnersecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information
|
|
103
|
+
*RunnerApi* | [**listRunnerPermissions**](docs/RunnerApi.md#listrunnerpermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role
|
|
104
|
+
*RunnerApi* | [**listRunnerSecurityUsers**](docs/RunnerApi.md#listrunnersecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list
|
|
105
|
+
*RunnerApi* | [**listRunners**](docs/RunnerApi.md#listrunners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List all Runners
|
|
106
|
+
*RunnerApi* | [**startRun**](docs/RunnerApi.md#startrun) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/start | Start a run with runner parameters
|
|
107
|
+
*RunnerApi* | [**stopRun**](docs/RunnerApi.md#stoprun) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/stop | Stop the last run
|
|
108
|
+
*RunnerApi* | [**updateRunner**](docs/RunnerApi.md#updaterunner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update a runner
|
|
109
|
+
*RunnerApi* | [**updateRunnerAccessControl**](docs/RunnerApi.md#updaterunneraccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Update the specified access to User for a Runner
|
|
110
|
+
*RunnerApi* | [**updateRunnerDefaultSecurity**](docs/RunnerApi.md#updaterunnerdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/default | Set the Runner default security
|
|
111
|
+
*SolutionApi* | [**createSolution**](docs/SolutionApi.md#createsolution) | **POST** /organizations/{organization_id}/solutions | Create a new solution
|
|
112
|
+
*SolutionApi* | [**createSolutionAccessControl**](docs/SolutionApi.md#createsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Create solution access control
|
|
113
|
+
*SolutionApi* | [**createSolutionParameter**](docs/SolutionApi.md#createsolutionparameter) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Create solution parameter for a solution
|
|
114
|
+
*SolutionApi* | [**createSolutionParameterGroup**](docs/SolutionApi.md#createsolutionparametergroup) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Create a solution parameter group
|
|
115
|
+
*SolutionApi* | [**createSolutionRunTemplate**](docs/SolutionApi.md#createsolutionruntemplate) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Create a solution run template
|
|
116
|
+
*SolutionApi* | [**deleteSolution**](docs/SolutionApi.md#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution
|
|
117
|
+
*SolutionApi* | [**deleteSolutionAccessControl**](docs/SolutionApi.md#deletesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Delete solution access control
|
|
118
|
+
*SolutionApi* | [**deleteSolutionParameter**](docs/SolutionApi.md#deletesolutionparameter) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Delete specific parameter from the solution
|
|
119
|
+
*SolutionApi* | [**deleteSolutionParameterGroup**](docs/SolutionApi.md#deletesolutionparametergroup) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Delete a parameter group from the solution
|
|
120
|
+
*SolutionApi* | [**deleteSolutionRunTemplate**](docs/SolutionApi.md#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Delete a specific run template
|
|
121
|
+
*SolutionApi* | [**getRunTemplate**](docs/SolutionApi.md#getruntemplate) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Retrieve a solution run templates
|
|
122
|
+
*SolutionApi* | [**getSolution**](docs/SolutionApi.md#getsolution) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution
|
|
123
|
+
*SolutionApi* | [**getSolutionAccessControl**](docs/SolutionApi.md#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get solution access control
|
|
124
|
+
*SolutionApi* | [**getSolutionParameter**](docs/SolutionApi.md#getsolutionparameter) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Get the details of a solution parameter
|
|
125
|
+
*SolutionApi* | [**getSolutionParameterGroup**](docs/SolutionApi.md#getsolutionparametergroup) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Get details of a solution parameter group
|
|
126
|
+
*SolutionApi* | [**getSolutionSecurity**](docs/SolutionApi.md#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get solution security information
|
|
127
|
+
*SolutionApi* | [**listRunTemplates**](docs/SolutionApi.md#listruntemplates) | **GET** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | List all solution run templates
|
|
128
|
+
*SolutionApi* | [**listSolutionParameterGroups**](docs/SolutionApi.md#listsolutionparametergroups) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | List all solution parameter groups
|
|
129
|
+
*SolutionApi* | [**listSolutionParameters**](docs/SolutionApi.md#listsolutionparameters) | **GET** /organizations/{organization_id}/solutions/{solution_id}/parameters | List all solution parameters
|
|
130
|
+
*SolutionApi* | [**listSolutionSecurityUsers**](docs/SolutionApi.md#listsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | List solution security users
|
|
131
|
+
*SolutionApi* | [**listSolutions**](docs/SolutionApi.md#listsolutions) | **GET** /organizations/{organization_id}/solutions | List all Solutions
|
|
132
|
+
*SolutionApi* | [**updateSolution**](docs/SolutionApi.md#updatesolution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution
|
|
133
|
+
*SolutionApi* | [**updateSolutionAccessControl**](docs/SolutionApi.md#updatesolutionaccesscontrol) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update solution access control
|
|
134
|
+
*SolutionApi* | [**updateSolutionDefaultSecurity**](docs/SolutionApi.md#updatesolutiondefaultsecurity) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/default | Update solution default security
|
|
135
|
+
*SolutionApi* | [**updateSolutionParameter**](docs/SolutionApi.md#updatesolutionparameter) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameters/{parameter_id} | Update solution parameter
|
|
136
|
+
*SolutionApi* | [**updateSolutionParameterGroup**](docs/SolutionApi.md#updatesolutionparametergroup) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups/{parameter_group_id} | Update a solution parameter group
|
|
137
|
+
*SolutionApi* | [**updateSolutionRunTemplate**](docs/SolutionApi.md#updatesolutionruntemplate) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update a specific run template
|
|
138
|
+
*WorkspaceApi* | [**createWorkspace**](docs/WorkspaceApi.md#createworkspace) | **POST** /organizations/{organization_id}/workspaces | Create a new workspace
|
|
139
|
+
*WorkspaceApi* | [**createWorkspaceAccessControl**](docs/WorkspaceApi.md#createworkspaceaccesscontrol) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/security/access | Add a control access to the Workspace
|
|
140
|
+
*WorkspaceApi* | [**createWorkspaceFile**](docs/WorkspaceApi.md#createworkspacefile) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/files | Upload a file for the Workspace
|
|
141
|
+
*WorkspaceApi* | [**deleteWorkspace**](docs/WorkspaceApi.md#deleteworkspace) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id} | Delete a workspace
|
|
142
|
+
*WorkspaceApi* | [**deleteWorkspaceAccessControl**](docs/WorkspaceApi.md#deleteworkspaceaccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Remove the specified access from the given Workspace
|
|
143
|
+
*WorkspaceApi* | [**deleteWorkspaceFile**](docs/WorkspaceApi.md#deleteworkspacefile) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files/delete | Delete a workspace file
|
|
144
|
+
*WorkspaceApi* | [**deleteWorkspaceFiles**](docs/WorkspaceApi.md#deleteworkspacefiles) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/files | Delete all Workspace files
|
|
145
|
+
*WorkspaceApi* | [**getWorkspace**](docs/WorkspaceApi.md#getworkspace) | **GET** /organizations/{organization_id}/workspaces/{workspace_id} | Get the details of a workspace
|
|
146
|
+
*WorkspaceApi* | [**getWorkspaceAccessControl**](docs/WorkspaceApi.md#getworkspaceaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Get a control access for the Workspace
|
|
147
|
+
*WorkspaceApi* | [**getWorkspaceFile**](docs/WorkspaceApi.md#getworkspacefile) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files/download | Download the Workspace File specified
|
|
148
|
+
*WorkspaceApi* | [**getWorkspaceSecurity**](docs/WorkspaceApi.md#getworkspacesecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security | Get the Workspace security information
|
|
149
|
+
*WorkspaceApi* | [**listWorkspaceFiles**](docs/WorkspaceApi.md#listworkspacefiles) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/files | List all Workspace files
|
|
150
|
+
*WorkspaceApi* | [**listWorkspaceRolePermissions**](docs/WorkspaceApi.md#listworkspacerolepermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/permissions/{role} | Get the Workspace permission by given role
|
|
151
|
+
*WorkspaceApi* | [**listWorkspaceSecurityUsers**](docs/WorkspaceApi.md#listworkspacesecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/security/users | Get the Workspace security users list
|
|
152
|
+
*WorkspaceApi* | [**listWorkspaces**](docs/WorkspaceApi.md#listworkspaces) | **GET** /organizations/{organization_id}/workspaces | List all Workspaces
|
|
153
|
+
*WorkspaceApi* | [**updateWorkspace**](docs/WorkspaceApi.md#updateworkspace) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id} | Update a workspace
|
|
154
|
+
*WorkspaceApi* | [**updateWorkspaceAccessControl**](docs/WorkspaceApi.md#updateworkspaceaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/access/{identity_id} | Update the specified access to User for a Workspace
|
|
155
|
+
*WorkspaceApi* | [**updateWorkspaceDefaultSecurity**](docs/WorkspaceApi.md#updateworkspacedefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/security/default | Update the Workspace default security
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Documentation For Models
|
|
159
|
+
|
|
160
|
+
- [AboutInfo](docs/AboutInfo.md)
|
|
161
|
+
- [AboutInfoVersion](docs/AboutInfoVersion.md)
|
|
162
|
+
- [ComponentRolePermissions](docs/ComponentRolePermissions.md)
|
|
163
|
+
- [ContainerResourceSizeInfo](docs/ContainerResourceSizeInfo.md)
|
|
164
|
+
- [ContainerResourceSizing](docs/ContainerResourceSizing.md)
|
|
165
|
+
- [CreateInfo](docs/CreateInfo.md)
|
|
166
|
+
- [CreatedRun](docs/CreatedRun.md)
|
|
167
|
+
- [Dataset](docs/Dataset.md)
|
|
168
|
+
- [DatasetAccessControl](docs/DatasetAccessControl.md)
|
|
169
|
+
- [DatasetCreateRequest](docs/DatasetCreateRequest.md)
|
|
170
|
+
- [DatasetPart](docs/DatasetPart.md)
|
|
171
|
+
- [DatasetPartCreateRequest](docs/DatasetPartCreateRequest.md)
|
|
172
|
+
- [DatasetPartTypeEnum](docs/DatasetPartTypeEnum.md)
|
|
173
|
+
- [DatasetPartUpdateRequest](docs/DatasetPartUpdateRequest.md)
|
|
174
|
+
- [DatasetRole](docs/DatasetRole.md)
|
|
175
|
+
- [DatasetSecurity](docs/DatasetSecurity.md)
|
|
176
|
+
- [DatasetUpdateRequest](docs/DatasetUpdateRequest.md)
|
|
177
|
+
- [EditInfo](docs/EditInfo.md)
|
|
178
|
+
- [LastRunInfo](docs/LastRunInfo.md)
|
|
179
|
+
- [Organization](docs/Organization.md)
|
|
180
|
+
- [OrganizationAccessControl](docs/OrganizationAccessControl.md)
|
|
181
|
+
- [OrganizationCreateRequest](docs/OrganizationCreateRequest.md)
|
|
182
|
+
- [OrganizationEditInfo](docs/OrganizationEditInfo.md)
|
|
183
|
+
- [OrganizationRole](docs/OrganizationRole.md)
|
|
184
|
+
- [OrganizationSecurity](docs/OrganizationSecurity.md)
|
|
185
|
+
- [OrganizationUpdateRequest](docs/OrganizationUpdateRequest.md)
|
|
186
|
+
- [QueryResult](docs/QueryResult.md)
|
|
187
|
+
- [ResourceSizeInfo](docs/ResourceSizeInfo.md)
|
|
188
|
+
- [Run](docs/Run.md)
|
|
189
|
+
- [RunContainer](docs/RunContainer.md)
|
|
190
|
+
- [RunData](docs/RunData.md)
|
|
191
|
+
- [RunDataQuery](docs/RunDataQuery.md)
|
|
192
|
+
- [RunEditInfo](docs/RunEditInfo.md)
|
|
193
|
+
- [RunResourceRequested](docs/RunResourceRequested.md)
|
|
194
|
+
- [RunState](docs/RunState.md)
|
|
195
|
+
- [RunStatus](docs/RunStatus.md)
|
|
196
|
+
- [RunStatusNode](docs/RunStatusNode.md)
|
|
197
|
+
- [RunTemplate](docs/RunTemplate.md)
|
|
198
|
+
- [RunTemplateCreateRequest](docs/RunTemplateCreateRequest.md)
|
|
199
|
+
- [RunTemplateParameter](docs/RunTemplateParameter.md)
|
|
200
|
+
- [RunTemplateParameterCreateRequest](docs/RunTemplateParameterCreateRequest.md)
|
|
201
|
+
- [RunTemplateParameterGroup](docs/RunTemplateParameterGroup.md)
|
|
202
|
+
- [RunTemplateParameterGroupCreateRequest](docs/RunTemplateParameterGroupCreateRequest.md)
|
|
203
|
+
- [RunTemplateParameterGroupUpdateRequest](docs/RunTemplateParameterGroupUpdateRequest.md)
|
|
204
|
+
- [RunTemplateParameterUpdateRequest](docs/RunTemplateParameterUpdateRequest.md)
|
|
205
|
+
- [RunTemplateParameterValue](docs/RunTemplateParameterValue.md)
|
|
206
|
+
- [RunTemplateResourceSizing](docs/RunTemplateResourceSizing.md)
|
|
207
|
+
- [RunTemplateUpdateRequest](docs/RunTemplateUpdateRequest.md)
|
|
208
|
+
- [Runner](docs/Runner.md)
|
|
209
|
+
- [RunnerAccessControl](docs/RunnerAccessControl.md)
|
|
210
|
+
- [RunnerCreateRequest](docs/RunnerCreateRequest.md)
|
|
211
|
+
- [RunnerEditInfo](docs/RunnerEditInfo.md)
|
|
212
|
+
- [RunnerResourceSizing](docs/RunnerResourceSizing.md)
|
|
213
|
+
- [RunnerRole](docs/RunnerRole.md)
|
|
214
|
+
- [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
|
|
215
|
+
- [RunnerSecurity](docs/RunnerSecurity.md)
|
|
216
|
+
- [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
|
|
217
|
+
- [RunnerValidationStatus](docs/RunnerValidationStatus.md)
|
|
218
|
+
- [SendRunDataRequest](docs/SendRunDataRequest.md)
|
|
219
|
+
- [Solution](docs/Solution.md)
|
|
220
|
+
- [SolutionAccessControl](docs/SolutionAccessControl.md)
|
|
221
|
+
- [SolutionCreateRequest](docs/SolutionCreateRequest.md)
|
|
222
|
+
- [SolutionEditInfo](docs/SolutionEditInfo.md)
|
|
223
|
+
- [SolutionRole](docs/SolutionRole.md)
|
|
224
|
+
- [SolutionSecurity](docs/SolutionSecurity.md)
|
|
225
|
+
- [SolutionUpdateRequest](docs/SolutionUpdateRequest.md)
|
|
226
|
+
- [Workspace](docs/Workspace.md)
|
|
227
|
+
- [WorkspaceAccessControl](docs/WorkspaceAccessControl.md)
|
|
228
|
+
- [WorkspaceCreateRequest](docs/WorkspaceCreateRequest.md)
|
|
229
|
+
- [WorkspaceEditInfo](docs/WorkspaceEditInfo.md)
|
|
230
|
+
- [WorkspaceFile](docs/WorkspaceFile.md)
|
|
231
|
+
- [WorkspaceRole](docs/WorkspaceRole.md)
|
|
232
|
+
- [WorkspaceSecurity](docs/WorkspaceSecurity.md)
|
|
233
|
+
- [WorkspaceSolution](docs/WorkspaceSolution.md)
|
|
234
|
+
- [WorkspaceUpdateRequest](docs/WorkspaceUpdateRequest.md)
|
|
235
|
+
- [WorkspaceWebApp](docs/WorkspaceWebApp.md)
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<a id="documentation-for-authorization"></a>
|
|
239
|
+
## Documentation For Authorization
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
Authentication schemes defined for the API:
|
|
243
|
+
<a id="oAuth2AuthCode"></a>
|
|
244
|
+
### oAuth2AuthCode
|
|
245
|
+
|
|
246
|
+
- **Type**: OAuth
|
|
247
|
+
- **Flow**: accessCode
|
|
248
|
+
- **Authorization URL**: https://example.com/authorize
|
|
249
|
+
- **Scopes**: N/A
|
|
250
|
+
|