@cosmotech/api-ts 3.3.4 → 4.2.5-onprem
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/.github/workflows/publish.yaml +13 -12
- package/.github/workflows/track_dependencies.yml +31 -0
- package/.openapi-generator/FILES +98 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +210 -2
- package/api.ts +4650 -11656
- package/base.ts +2 -2
- package/common.ts +22 -44
- package/configuration.ts +7 -2
- package/dist/api.d.ts +2165 -6422
- package/dist/api.js +726 -7302
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +5 -36
- package/dist/common.js +17 -39
- 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/Connector.md +41 -0
- package/docs/ConnectorApi.md +218 -0
- package/docs/ConnectorParameter.md +31 -0
- package/docs/ConnectorParameterGroup.md +25 -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 +65 -0
- package/docs/DatasetAccessControl.md +23 -0
- package/docs/DatasetApi.md +1809 -0
- package/docs/DatasetCompatibility.md +25 -0
- package/docs/DatasetConnector.md +27 -0
- package/docs/DatasetCopyParameters.md +25 -0
- package/docs/DatasetCreateInfo.md +24 -0
- package/docs/DatasetCreateRequest.md +31 -0
- package/docs/DatasetEditInfo.md +22 -0
- package/docs/DatasetMemberGroup.md +25 -0
- package/docs/DatasetMemberUser.md +23 -0
- package/docs/DatasetMembers.md +23 -0
- package/docs/DatasetPart.md +43 -0
- package/docs/DatasetPartCreateRequest.md +31 -0
- package/docs/DatasetPartTypeEnum.md +11 -0
- package/docs/DatasetPartUpdateRequest.md +27 -0
- package/docs/DatasetRole.md +21 -0
- package/docs/DatasetSearch.md +21 -0
- package/docs/DatasetSecurity.md +23 -0
- package/docs/DatasetSourceType.md +19 -0
- package/docs/DatasetTwinGraphHash.md +21 -0
- package/docs/DatasetTwinGraphInfo.md +25 -0
- package/docs/DatasetTwinGraphQuery.md +21 -0
- package/docs/DatasetUpdateRequest.md +29 -0
- package/docs/DeleteHistoricalData.md +25 -0
- package/docs/EditInfo.md +22 -0
- package/docs/FileUploadMetadata.md +22 -0
- package/docs/FileUploadValidation.md +23 -0
- package/docs/GraphProperties.md +28 -0
- package/docs/IAMInfoApi.md +95 -0
- package/docs/IngestionStatusEnum.md +15 -0
- package/docs/IoTypesEnum.md +11 -0
- package/docs/LastRunInfo.md +23 -0
- package/docs/MemberGroup.md +25 -0
- package/docs/MemberUser.md +23 -0
- package/docs/Members.md +23 -0
- package/docs/MetaApi.md +52 -0
- package/docs/Organization.md +27 -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/OrganizationMemberGroup.md +25 -0
- package/docs/OrganizationMemberUser.md +23 -0
- package/docs/OrganizationMembers.md +23 -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 +57 -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/RunLogs.md +23 -0
- package/docs/RunLogsEntry.md +21 -0
- package/docs/RunResourceRequested.md +23 -0
- package/docs/RunState.md +15 -0
- package/docs/RunStatus.md +47 -0
- package/docs/RunStatusNode.md +43 -0
- package/docs/RunTemplate.md +87 -0
- package/docs/RunTemplateCreateRequest.md +37 -0
- package/docs/RunTemplateOrchestrator.md +11 -0
- package/docs/RunTemplateParameter.md +35 -0
- package/docs/RunTemplateParameterCreateRequest.md +35 -0
- package/docs/RunTemplateParameterGroup.md +31 -0
- package/docs/RunTemplateParameterGroupCreateRequest.md +29 -0
- package/docs/RunTemplateParameterGroupUpdateRequest.md +27 -0
- package/docs/RunTemplateParameterUpdateRequest.md +33 -0
- package/docs/RunTemplateParameterValue.md +25 -0
- package/docs/RunTemplateResourceSizing.md +23 -0
- package/docs/RunTemplateStepSource.md +15 -0
- package/docs/RunTemplateUpdateRequest.md +35 -0
- package/docs/Runner.md +63 -0
- package/docs/RunnerAccessControl.md +23 -0
- package/docs/RunnerApi.md +908 -0
- package/docs/RunnerCreateRequest.md +45 -0
- package/docs/RunnerDatasets.md +24 -0
- package/docs/RunnerEditInfo.md +22 -0
- package/docs/RunnerMemberGroup.md +25 -0
- package/docs/RunnerMemberUser.md +23 -0
- package/docs/RunnerMembers.md +23 -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/RunnerStatus.md +11 -0
- package/docs/RunnerUpdateRequest.md +41 -0
- package/docs/RunnerValidationStatus.md +15 -0
- package/docs/SendRunDataRequest.md +22 -0
- package/docs/Solution.md +53 -0
- package/docs/SolutionAccessControl.md +23 -0
- package/docs/SolutionApi.md +1159 -0
- package/docs/SolutionCreateRequest.md +43 -0
- package/docs/SolutionEditInfo.md +22 -0
- package/docs/SolutionFile.md +21 -0
- package/docs/SolutionMemberGroup.md +25 -0
- package/docs/SolutionMemberUser.md +23 -0
- package/docs/SolutionMembers.md +23 -0
- package/docs/SolutionRole.md +21 -0
- package/docs/SolutionSecurity.md +23 -0
- package/docs/SolutionUpdateRequest.md +41 -0
- package/docs/SourceInfo.md +27 -0
- package/docs/SubDatasetGraphQuery.md +27 -0
- package/docs/TwinGraphBatchResult.md +25 -0
- package/docs/TwincacheStatusEnum.md +11 -0
- package/docs/Workspace.md +57 -0
- package/docs/WorkspaceAccessControl.md +23 -0
- package/docs/WorkspaceApi.md +1162 -0
- package/docs/WorkspaceCreateRequest.md +35 -0
- package/docs/WorkspaceEditInfo.md +22 -0
- package/docs/WorkspaceFile.md +21 -0
- package/docs/WorkspaceMemberGroup.md +25 -0
- package/docs/WorkspaceMemberUser.md +23 -0
- package/docs/WorkspaceMembers.md +23 -0
- package/docs/WorkspaceRole.md +21 -0
- package/docs/WorkspaceSecurity.md +23 -0
- package/docs/WorkspaceSolution.md +25 -0
- package/docs/WorkspaceUpdateRequest.md +31 -0
- package/docs/WorkspaceWebApp.md +25 -0
- package/index.ts +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,1159 @@
|
|
|
1
|
+
# SolutionApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addOrReplaceParameterGroups**](#addorreplaceparametergroups) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Add Parameter Groups. Any item with the same ID will be overwritten|
|
|
8
|
+
|[**addOrReplaceParameters**](#addorreplaceparameters) | **POST** /organizations/{organization_id}/solutions/{solution_id}/parameters | Add Parameters. Any item with the same ID will be overwritten|
|
|
9
|
+
|[**addOrReplaceRunTemplates**](#addorreplaceruntemplates) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Add Run Templates. Any item with the same ID will be overwritten|
|
|
10
|
+
|[**addSolutionAccessControl**](#addsolutionaccesscontrol) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/access | Add a control access to the Solution|
|
|
11
|
+
|[**createSolution**](#createsolution) | **POST** /organizations/{organization_id}/solutions | Register a new solution|
|
|
12
|
+
|[**deleteSolution**](#deletesolution) | **DELETE** /organizations/{organization_id}/solutions/{solution_id} | Delete a solution|
|
|
13
|
+
|[**deleteSolutionRunTemplate**](#deletesolutionruntemplate) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Remove the specified Solution Run Template|
|
|
14
|
+
|[**findAllSolutions**](#findallsolutions) | **GET** /organizations/{organization_id}/solutions | List all Solutions|
|
|
15
|
+
|[**findSolutionById**](#findsolutionbyid) | **GET** /organizations/{organization_id}/solutions/{solution_id} | Get the details of a solution|
|
|
16
|
+
|[**getSolutionAccessControl**](#getsolutionaccesscontrol) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Get a control access for the Solution|
|
|
17
|
+
|[**getSolutionSecurity**](#getsolutionsecurity) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security | Get the Solution security information|
|
|
18
|
+
|[**getSolutionSecurityUsers**](#getsolutionsecurityusers) | **GET** /organizations/{organization_id}/solutions/{solution_id}/security/users | Get the Solution security users list|
|
|
19
|
+
|[**removeAllRunTemplates**](#removeallruntemplates) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/runTemplates | Remove all Run Templates from the Solution specified|
|
|
20
|
+
|[**removeAllSolutionParameterGroups**](#removeallsolutionparametergroups) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameterGroups | Remove all Parameter Groups from the Solution specified|
|
|
21
|
+
|[**removeAllSolutionParameters**](#removeallsolutionparameters) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/parameters | Remove all Parameters from the Solution specified|
|
|
22
|
+
|[**removeSolutionAccessControl**](#removesolutionaccesscontrol) | **DELETE** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Remove the specified access from the given Organization Solution|
|
|
23
|
+
|[**setSolutionDefaultSecurity**](#setsolutiondefaultsecurity) | **POST** /organizations/{organization_id}/solutions/{solution_id}/security/default | Set the Solution default security|
|
|
24
|
+
|[**updateSolution**](#updatesolution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution|
|
|
25
|
+
|[**updateSolutionAccessControl**](#updatesolutionaccesscontrol) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/security/access/{identity_id} | Update the specified access to User for a Solution|
|
|
26
|
+
|[**updateSolutionRunTemplate**](#updatesolutionruntemplate) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update the specified Solution Run Template|
|
|
27
|
+
|
|
28
|
+
# **addOrReplaceParameterGroups**
|
|
29
|
+
> Array<RunTemplateParameterGroup> addOrReplaceParameterGroups(runTemplateParameterGroup)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Example
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import {
|
|
36
|
+
SolutionApi,
|
|
37
|
+
Configuration
|
|
38
|
+
} from '@cosmotech/api-ts';
|
|
39
|
+
|
|
40
|
+
const configuration = new Configuration();
|
|
41
|
+
const apiInstance = new SolutionApi(configuration);
|
|
42
|
+
|
|
43
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
44
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
45
|
+
let runTemplateParameterGroup: Array<RunTemplateParameterGroup>; //the Parameter Groups
|
|
46
|
+
|
|
47
|
+
const { status, data } = await apiInstance.addOrReplaceParameterGroups(
|
|
48
|
+
organizationId,
|
|
49
|
+
solutionId,
|
|
50
|
+
runTemplateParameterGroup
|
|
51
|
+
);
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|Name | Type | Description | Notes|
|
|
57
|
+
|------------- | ------------- | ------------- | -------------|
|
|
58
|
+
| **runTemplateParameterGroup** | **Array<RunTemplateParameterGroup>**| the Parameter Groups | |
|
|
59
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
60
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
**Array<RunTemplateParameterGroup>**
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: application/json
|
|
74
|
+
- **Accept**: application/json
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### HTTP response details
|
|
78
|
+
| Status code | Description | Response headers |
|
|
79
|
+
|-------------|-------------|------------------|
|
|
80
|
+
|**201** | the Parameter Groups | - |
|
|
81
|
+
|**400** | Bad request | - |
|
|
82
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
83
|
+
|
|
84
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
85
|
+
|
|
86
|
+
# **addOrReplaceParameters**
|
|
87
|
+
> Array<RunTemplateParameter> addOrReplaceParameters(runTemplateParameter)
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
|
|
92
|
+
```typescript
|
|
93
|
+
import {
|
|
94
|
+
SolutionApi,
|
|
95
|
+
Configuration
|
|
96
|
+
} from '@cosmotech/api-ts';
|
|
97
|
+
|
|
98
|
+
const configuration = new Configuration();
|
|
99
|
+
const apiInstance = new SolutionApi(configuration);
|
|
100
|
+
|
|
101
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
102
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
103
|
+
let runTemplateParameter: Array<RunTemplateParameter>; //the Parameters
|
|
104
|
+
|
|
105
|
+
const { status, data } = await apiInstance.addOrReplaceParameters(
|
|
106
|
+
organizationId,
|
|
107
|
+
solutionId,
|
|
108
|
+
runTemplateParameter
|
|
109
|
+
);
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Parameters
|
|
113
|
+
|
|
114
|
+
|Name | Type | Description | Notes|
|
|
115
|
+
|------------- | ------------- | ------------- | -------------|
|
|
116
|
+
| **runTemplateParameter** | **Array<RunTemplateParameter>**| the Parameters | |
|
|
117
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
118
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
**Array<RunTemplateParameter>**
|
|
124
|
+
|
|
125
|
+
### Authorization
|
|
126
|
+
|
|
127
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
128
|
+
|
|
129
|
+
### HTTP request headers
|
|
130
|
+
|
|
131
|
+
- **Content-Type**: application/json
|
|
132
|
+
- **Accept**: application/json
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
### HTTP response details
|
|
136
|
+
| Status code | Description | Response headers |
|
|
137
|
+
|-------------|-------------|------------------|
|
|
138
|
+
|**201** | the Parameters | - |
|
|
139
|
+
|**400** | Bad request | - |
|
|
140
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
141
|
+
|
|
142
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
143
|
+
|
|
144
|
+
# **addOrReplaceRunTemplates**
|
|
145
|
+
> Array<RunTemplate> addOrReplaceRunTemplates(runTemplate)
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
### Example
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
import {
|
|
152
|
+
SolutionApi,
|
|
153
|
+
Configuration
|
|
154
|
+
} from '@cosmotech/api-ts';
|
|
155
|
+
|
|
156
|
+
const configuration = new Configuration();
|
|
157
|
+
const apiInstance = new SolutionApi(configuration);
|
|
158
|
+
|
|
159
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
160
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
161
|
+
let runTemplate: Array<RunTemplate>; //the Run Templates
|
|
162
|
+
|
|
163
|
+
const { status, data } = await apiInstance.addOrReplaceRunTemplates(
|
|
164
|
+
organizationId,
|
|
165
|
+
solutionId,
|
|
166
|
+
runTemplate
|
|
167
|
+
);
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
|Name | Type | Description | Notes|
|
|
173
|
+
|------------- | ------------- | ------------- | -------------|
|
|
174
|
+
| **runTemplate** | **Array<RunTemplate>**| the Run Templates | |
|
|
175
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
176
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
**Array<RunTemplate>**
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: application/json
|
|
190
|
+
- **Accept**: application/json
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
### HTTP response details
|
|
194
|
+
| Status code | Description | Response headers |
|
|
195
|
+
|-------------|-------------|------------------|
|
|
196
|
+
|**201** | the Parameters | - |
|
|
197
|
+
|**400** | Bad request | - |
|
|
198
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
199
|
+
|
|
200
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
201
|
+
|
|
202
|
+
# **addSolutionAccessControl**
|
|
203
|
+
> SolutionAccessControl addSolutionAccessControl(solutionAccessControl)
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import {
|
|
210
|
+
SolutionApi,
|
|
211
|
+
Configuration,
|
|
212
|
+
SolutionAccessControl
|
|
213
|
+
} from '@cosmotech/api-ts';
|
|
214
|
+
|
|
215
|
+
const configuration = new Configuration();
|
|
216
|
+
const apiInstance = new SolutionApi(configuration);
|
|
217
|
+
|
|
218
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
219
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
220
|
+
let solutionAccessControl: SolutionAccessControl; //the new Solution security access to add.
|
|
221
|
+
|
|
222
|
+
const { status, data } = await apiInstance.addSolutionAccessControl(
|
|
223
|
+
organizationId,
|
|
224
|
+
solutionId,
|
|
225
|
+
solutionAccessControl
|
|
226
|
+
);
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Parameters
|
|
230
|
+
|
|
231
|
+
|Name | Type | Description | Notes|
|
|
232
|
+
|------------- | ------------- | ------------- | -------------|
|
|
233
|
+
| **solutionAccessControl** | **SolutionAccessControl**| the new Solution security access to add. | |
|
|
234
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
235
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
### Return type
|
|
239
|
+
|
|
240
|
+
**SolutionAccessControl**
|
|
241
|
+
|
|
242
|
+
### Authorization
|
|
243
|
+
|
|
244
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
245
|
+
|
|
246
|
+
### HTTP request headers
|
|
247
|
+
|
|
248
|
+
- **Content-Type**: application/json, application/yaml
|
|
249
|
+
- **Accept**: application/json
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### HTTP response details
|
|
253
|
+
| Status code | Description | Response headers |
|
|
254
|
+
|-------------|-------------|------------------|
|
|
255
|
+
|**201** | The Solution access | - |
|
|
256
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
257
|
+
|
|
258
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
259
|
+
|
|
260
|
+
# **createSolution**
|
|
261
|
+
> Solution createSolution(solution)
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
### Example
|
|
265
|
+
|
|
266
|
+
```typescript
|
|
267
|
+
import {
|
|
268
|
+
SolutionApi,
|
|
269
|
+
Configuration,
|
|
270
|
+
Solution
|
|
271
|
+
} from '@cosmotech/api-ts';
|
|
272
|
+
|
|
273
|
+
const configuration = new Configuration();
|
|
274
|
+
const apiInstance = new SolutionApi(configuration);
|
|
275
|
+
|
|
276
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
277
|
+
let solution: Solution; //the Solution to create
|
|
278
|
+
|
|
279
|
+
const { status, data } = await apiInstance.createSolution(
|
|
280
|
+
organizationId,
|
|
281
|
+
solution
|
|
282
|
+
);
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Parameters
|
|
286
|
+
|
|
287
|
+
|Name | Type | Description | Notes|
|
|
288
|
+
|------------- | ------------- | ------------- | -------------|
|
|
289
|
+
| **solution** | **Solution**| the Solution to create | |
|
|
290
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
**Solution**
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: application/json, application/yaml
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### HTTP response details
|
|
308
|
+
| Status code | Description | Response headers |
|
|
309
|
+
|-------------|-------------|------------------|
|
|
310
|
+
|**201** | the solution details | - |
|
|
311
|
+
|**400** | Bad request | - |
|
|
312
|
+
|
|
313
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
314
|
+
|
|
315
|
+
# **deleteSolution**
|
|
316
|
+
> deleteSolution()
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
### Example
|
|
320
|
+
|
|
321
|
+
```typescript
|
|
322
|
+
import {
|
|
323
|
+
SolutionApi,
|
|
324
|
+
Configuration
|
|
325
|
+
} from '@cosmotech/api-ts';
|
|
326
|
+
|
|
327
|
+
const configuration = new Configuration();
|
|
328
|
+
const apiInstance = new SolutionApi(configuration);
|
|
329
|
+
|
|
330
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
331
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
332
|
+
|
|
333
|
+
const { status, data } = await apiInstance.deleteSolution(
|
|
334
|
+
organizationId,
|
|
335
|
+
solutionId
|
|
336
|
+
);
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Parameters
|
|
340
|
+
|
|
341
|
+
|Name | Type | Description | Notes|
|
|
342
|
+
|------------- | ------------- | ------------- | -------------|
|
|
343
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
344
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### Return type
|
|
348
|
+
|
|
349
|
+
void (empty response body)
|
|
350
|
+
|
|
351
|
+
### Authorization
|
|
352
|
+
|
|
353
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
354
|
+
|
|
355
|
+
### HTTP request headers
|
|
356
|
+
|
|
357
|
+
- **Content-Type**: Not defined
|
|
358
|
+
- **Accept**: Not defined
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
### HTTP response details
|
|
362
|
+
| Status code | Description | Response headers |
|
|
363
|
+
|-------------|-------------|------------------|
|
|
364
|
+
|**204** | Request succeeded | - |
|
|
365
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
366
|
+
|
|
367
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
368
|
+
|
|
369
|
+
# **deleteSolutionRunTemplate**
|
|
370
|
+
> deleteSolutionRunTemplate()
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
### Example
|
|
374
|
+
|
|
375
|
+
```typescript
|
|
376
|
+
import {
|
|
377
|
+
SolutionApi,
|
|
378
|
+
Configuration
|
|
379
|
+
} from '@cosmotech/api-ts';
|
|
380
|
+
|
|
381
|
+
const configuration = new Configuration();
|
|
382
|
+
const apiInstance = new SolutionApi(configuration);
|
|
383
|
+
|
|
384
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
385
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
386
|
+
let runTemplateId: string; //the Run Template identifier (default to undefined)
|
|
387
|
+
|
|
388
|
+
const { status, data } = await apiInstance.deleteSolutionRunTemplate(
|
|
389
|
+
organizationId,
|
|
390
|
+
solutionId,
|
|
391
|
+
runTemplateId
|
|
392
|
+
);
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
### Parameters
|
|
396
|
+
|
|
397
|
+
|Name | Type | Description | Notes|
|
|
398
|
+
|------------- | ------------- | ------------- | -------------|
|
|
399
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
400
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
401
|
+
| **runTemplateId** | [**string**] | the Run Template identifier | defaults to undefined|
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
### Return type
|
|
405
|
+
|
|
406
|
+
void (empty response body)
|
|
407
|
+
|
|
408
|
+
### Authorization
|
|
409
|
+
|
|
410
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
411
|
+
|
|
412
|
+
### HTTP request headers
|
|
413
|
+
|
|
414
|
+
- **Content-Type**: Not defined
|
|
415
|
+
- **Accept**: Not defined
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
### HTTP response details
|
|
419
|
+
| Status code | Description | Response headers |
|
|
420
|
+
|-------------|-------------|------------------|
|
|
421
|
+
|**204** | the operation succeeded | - |
|
|
422
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
423
|
+
|
|
424
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
425
|
+
|
|
426
|
+
# **findAllSolutions**
|
|
427
|
+
> Array<Solution> findAllSolutions()
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
### Example
|
|
431
|
+
|
|
432
|
+
```typescript
|
|
433
|
+
import {
|
|
434
|
+
SolutionApi,
|
|
435
|
+
Configuration
|
|
436
|
+
} from '@cosmotech/api-ts';
|
|
437
|
+
|
|
438
|
+
const configuration = new Configuration();
|
|
439
|
+
const apiInstance = new SolutionApi(configuration);
|
|
440
|
+
|
|
441
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
442
|
+
let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
|
|
443
|
+
let size: number; //amount of result by page (optional) (default to undefined)
|
|
444
|
+
|
|
445
|
+
const { status, data } = await apiInstance.findAllSolutions(
|
|
446
|
+
organizationId,
|
|
447
|
+
page,
|
|
448
|
+
size
|
|
449
|
+
);
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
|Name | Type | Description | Notes|
|
|
455
|
+
|------------- | ------------- | ------------- | -------------|
|
|
456
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
457
|
+
| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
|
|
458
|
+
| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
### Return type
|
|
462
|
+
|
|
463
|
+
**Array<Solution>**
|
|
464
|
+
|
|
465
|
+
### Authorization
|
|
466
|
+
|
|
467
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
468
|
+
|
|
469
|
+
### HTTP request headers
|
|
470
|
+
|
|
471
|
+
- **Content-Type**: Not defined
|
|
472
|
+
- **Accept**: application/json
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
### HTTP response details
|
|
476
|
+
| Status code | Description | Response headers |
|
|
477
|
+
|-------------|-------------|------------------|
|
|
478
|
+
|**200** | the solution details | - |
|
|
479
|
+
|
|
480
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
481
|
+
|
|
482
|
+
# **findSolutionById**
|
|
483
|
+
> Solution findSolutionById()
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
### Example
|
|
487
|
+
|
|
488
|
+
```typescript
|
|
489
|
+
import {
|
|
490
|
+
SolutionApi,
|
|
491
|
+
Configuration
|
|
492
|
+
} from '@cosmotech/api-ts';
|
|
493
|
+
|
|
494
|
+
const configuration = new Configuration();
|
|
495
|
+
const apiInstance = new SolutionApi(configuration);
|
|
496
|
+
|
|
497
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
498
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
499
|
+
|
|
500
|
+
const { status, data } = await apiInstance.findSolutionById(
|
|
501
|
+
organizationId,
|
|
502
|
+
solutionId
|
|
503
|
+
);
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
### Parameters
|
|
507
|
+
|
|
508
|
+
|Name | Type | Description | Notes|
|
|
509
|
+
|------------- | ------------- | ------------- | -------------|
|
|
510
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
511
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
### Return type
|
|
515
|
+
|
|
516
|
+
**Solution**
|
|
517
|
+
|
|
518
|
+
### Authorization
|
|
519
|
+
|
|
520
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
521
|
+
|
|
522
|
+
### HTTP request headers
|
|
523
|
+
|
|
524
|
+
- **Content-Type**: Not defined
|
|
525
|
+
- **Accept**: application/json
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
### HTTP response details
|
|
529
|
+
| Status code | Description | Response headers |
|
|
530
|
+
|-------------|-------------|------------------|
|
|
531
|
+
|**200** | the Solution details | - |
|
|
532
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
533
|
+
|
|
534
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
535
|
+
|
|
536
|
+
# **getSolutionAccessControl**
|
|
537
|
+
> SolutionAccessControl getSolutionAccessControl()
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
### Example
|
|
541
|
+
|
|
542
|
+
```typescript
|
|
543
|
+
import {
|
|
544
|
+
SolutionApi,
|
|
545
|
+
Configuration
|
|
546
|
+
} from '@cosmotech/api-ts';
|
|
547
|
+
|
|
548
|
+
const configuration = new Configuration();
|
|
549
|
+
const apiInstance = new SolutionApi(configuration);
|
|
550
|
+
|
|
551
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
552
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
553
|
+
let identityId: string; //the User identifier (default to undefined)
|
|
554
|
+
|
|
555
|
+
const { status, data } = await apiInstance.getSolutionAccessControl(
|
|
556
|
+
organizationId,
|
|
557
|
+
solutionId,
|
|
558
|
+
identityId
|
|
559
|
+
);
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
### Parameters
|
|
563
|
+
|
|
564
|
+
|Name | Type | Description | Notes|
|
|
565
|
+
|------------- | ------------- | ------------- | -------------|
|
|
566
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
567
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
568
|
+
| **identityId** | [**string**] | the User identifier | defaults to undefined|
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
### Return type
|
|
572
|
+
|
|
573
|
+
**SolutionAccessControl**
|
|
574
|
+
|
|
575
|
+
### Authorization
|
|
576
|
+
|
|
577
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
578
|
+
|
|
579
|
+
### HTTP request headers
|
|
580
|
+
|
|
581
|
+
- **Content-Type**: Not defined
|
|
582
|
+
- **Accept**: application/json
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
### HTTP response details
|
|
586
|
+
| Status code | Description | Response headers |
|
|
587
|
+
|-------------|-------------|------------------|
|
|
588
|
+
|**200** | The Solution access | - |
|
|
589
|
+
|**404** | The Solution or user specified is unknown or you don\'t have access to it | - |
|
|
590
|
+
|
|
591
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
592
|
+
|
|
593
|
+
# **getSolutionSecurity**
|
|
594
|
+
> SolutionSecurity getSolutionSecurity()
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
### Example
|
|
598
|
+
|
|
599
|
+
```typescript
|
|
600
|
+
import {
|
|
601
|
+
SolutionApi,
|
|
602
|
+
Configuration
|
|
603
|
+
} from '@cosmotech/api-ts';
|
|
604
|
+
|
|
605
|
+
const configuration = new Configuration();
|
|
606
|
+
const apiInstance = new SolutionApi(configuration);
|
|
607
|
+
|
|
608
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
609
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
610
|
+
|
|
611
|
+
const { status, data } = await apiInstance.getSolutionSecurity(
|
|
612
|
+
organizationId,
|
|
613
|
+
solutionId
|
|
614
|
+
);
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
### Parameters
|
|
618
|
+
|
|
619
|
+
|Name | Type | Description | Notes|
|
|
620
|
+
|------------- | ------------- | ------------- | -------------|
|
|
621
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
622
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
### Return type
|
|
626
|
+
|
|
627
|
+
**SolutionSecurity**
|
|
628
|
+
|
|
629
|
+
### Authorization
|
|
630
|
+
|
|
631
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
632
|
+
|
|
633
|
+
### HTTP request headers
|
|
634
|
+
|
|
635
|
+
- **Content-Type**: Not defined
|
|
636
|
+
- **Accept**: application/json
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
### HTTP response details
|
|
640
|
+
| Status code | Description | Response headers |
|
|
641
|
+
|-------------|-------------|------------------|
|
|
642
|
+
|**200** | The Solution security | - |
|
|
643
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
644
|
+
|
|
645
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
646
|
+
|
|
647
|
+
# **getSolutionSecurityUsers**
|
|
648
|
+
> Array<string> getSolutionSecurityUsers()
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
### Example
|
|
652
|
+
|
|
653
|
+
```typescript
|
|
654
|
+
import {
|
|
655
|
+
SolutionApi,
|
|
656
|
+
Configuration
|
|
657
|
+
} from '@cosmotech/api-ts';
|
|
658
|
+
|
|
659
|
+
const configuration = new Configuration();
|
|
660
|
+
const apiInstance = new SolutionApi(configuration);
|
|
661
|
+
|
|
662
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
663
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
664
|
+
|
|
665
|
+
const { status, data } = await apiInstance.getSolutionSecurityUsers(
|
|
666
|
+
organizationId,
|
|
667
|
+
solutionId
|
|
668
|
+
);
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
### Parameters
|
|
672
|
+
|
|
673
|
+
|Name | Type | Description | Notes|
|
|
674
|
+
|------------- | ------------- | ------------- | -------------|
|
|
675
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
676
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
### Return type
|
|
680
|
+
|
|
681
|
+
**Array<string>**
|
|
682
|
+
|
|
683
|
+
### Authorization
|
|
684
|
+
|
|
685
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
686
|
+
|
|
687
|
+
### HTTP request headers
|
|
688
|
+
|
|
689
|
+
- **Content-Type**: Not defined
|
|
690
|
+
- **Accept**: application/json
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
### HTTP response details
|
|
694
|
+
| Status code | Description | Response headers |
|
|
695
|
+
|-------------|-------------|------------------|
|
|
696
|
+
|**200** | The Solution security users list | - |
|
|
697
|
+
|**404** | the Solution or the User specified is unknown or you don\'t have access to them | - |
|
|
698
|
+
|
|
699
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
700
|
+
|
|
701
|
+
# **removeAllRunTemplates**
|
|
702
|
+
> removeAllRunTemplates()
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
### Example
|
|
706
|
+
|
|
707
|
+
```typescript
|
|
708
|
+
import {
|
|
709
|
+
SolutionApi,
|
|
710
|
+
Configuration
|
|
711
|
+
} from '@cosmotech/api-ts';
|
|
712
|
+
|
|
713
|
+
const configuration = new Configuration();
|
|
714
|
+
const apiInstance = new SolutionApi(configuration);
|
|
715
|
+
|
|
716
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
717
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
718
|
+
|
|
719
|
+
const { status, data } = await apiInstance.removeAllRunTemplates(
|
|
720
|
+
organizationId,
|
|
721
|
+
solutionId
|
|
722
|
+
);
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
### Parameters
|
|
726
|
+
|
|
727
|
+
|Name | Type | Description | Notes|
|
|
728
|
+
|------------- | ------------- | ------------- | -------------|
|
|
729
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
730
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
### Return type
|
|
734
|
+
|
|
735
|
+
void (empty response body)
|
|
736
|
+
|
|
737
|
+
### Authorization
|
|
738
|
+
|
|
739
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
740
|
+
|
|
741
|
+
### HTTP request headers
|
|
742
|
+
|
|
743
|
+
- **Content-Type**: Not defined
|
|
744
|
+
- **Accept**: Not defined
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
### HTTP response details
|
|
748
|
+
| Status code | Description | Response headers |
|
|
749
|
+
|-------------|-------------|------------------|
|
|
750
|
+
|**204** | the operation succeeded | - |
|
|
751
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
752
|
+
|
|
753
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
754
|
+
|
|
755
|
+
# **removeAllSolutionParameterGroups**
|
|
756
|
+
> removeAllSolutionParameterGroups()
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
### Example
|
|
760
|
+
|
|
761
|
+
```typescript
|
|
762
|
+
import {
|
|
763
|
+
SolutionApi,
|
|
764
|
+
Configuration
|
|
765
|
+
} from '@cosmotech/api-ts';
|
|
766
|
+
|
|
767
|
+
const configuration = new Configuration();
|
|
768
|
+
const apiInstance = new SolutionApi(configuration);
|
|
769
|
+
|
|
770
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
771
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
772
|
+
|
|
773
|
+
const { status, data } = await apiInstance.removeAllSolutionParameterGroups(
|
|
774
|
+
organizationId,
|
|
775
|
+
solutionId
|
|
776
|
+
);
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
|Name | Type | Description | Notes|
|
|
782
|
+
|------------- | ------------- | ------------- | -------------|
|
|
783
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
784
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
### Return type
|
|
788
|
+
|
|
789
|
+
void (empty response body)
|
|
790
|
+
|
|
791
|
+
### Authorization
|
|
792
|
+
|
|
793
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: Not defined
|
|
798
|
+
- **Accept**: Not defined
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
### HTTP response details
|
|
802
|
+
| Status code | Description | Response headers |
|
|
803
|
+
|-------------|-------------|------------------|
|
|
804
|
+
|**204** | the operation succeeded | - |
|
|
805
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
806
|
+
|
|
807
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
808
|
+
|
|
809
|
+
# **removeAllSolutionParameters**
|
|
810
|
+
> removeAllSolutionParameters()
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### Example
|
|
814
|
+
|
|
815
|
+
```typescript
|
|
816
|
+
import {
|
|
817
|
+
SolutionApi,
|
|
818
|
+
Configuration
|
|
819
|
+
} from '@cosmotech/api-ts';
|
|
820
|
+
|
|
821
|
+
const configuration = new Configuration();
|
|
822
|
+
const apiInstance = new SolutionApi(configuration);
|
|
823
|
+
|
|
824
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
825
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
826
|
+
|
|
827
|
+
const { status, data } = await apiInstance.removeAllSolutionParameters(
|
|
828
|
+
organizationId,
|
|
829
|
+
solutionId
|
|
830
|
+
);
|
|
831
|
+
```
|
|
832
|
+
|
|
833
|
+
### Parameters
|
|
834
|
+
|
|
835
|
+
|Name | Type | Description | Notes|
|
|
836
|
+
|------------- | ------------- | ------------- | -------------|
|
|
837
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
838
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
### Return type
|
|
842
|
+
|
|
843
|
+
void (empty response body)
|
|
844
|
+
|
|
845
|
+
### Authorization
|
|
846
|
+
|
|
847
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
848
|
+
|
|
849
|
+
### HTTP request headers
|
|
850
|
+
|
|
851
|
+
- **Content-Type**: Not defined
|
|
852
|
+
- **Accept**: Not defined
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
### HTTP response details
|
|
856
|
+
| Status code | Description | Response headers |
|
|
857
|
+
|-------------|-------------|------------------|
|
|
858
|
+
|**204** | the operation succeeded | - |
|
|
859
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
860
|
+
|
|
861
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
862
|
+
|
|
863
|
+
# **removeSolutionAccessControl**
|
|
864
|
+
> removeSolutionAccessControl()
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
### Example
|
|
868
|
+
|
|
869
|
+
```typescript
|
|
870
|
+
import {
|
|
871
|
+
SolutionApi,
|
|
872
|
+
Configuration
|
|
873
|
+
} from '@cosmotech/api-ts';
|
|
874
|
+
|
|
875
|
+
const configuration = new Configuration();
|
|
876
|
+
const apiInstance = new SolutionApi(configuration);
|
|
877
|
+
|
|
878
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
879
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
880
|
+
let identityId: string; //the User identifier (default to undefined)
|
|
881
|
+
|
|
882
|
+
const { status, data } = await apiInstance.removeSolutionAccessControl(
|
|
883
|
+
organizationId,
|
|
884
|
+
solutionId,
|
|
885
|
+
identityId
|
|
886
|
+
);
|
|
887
|
+
```
|
|
888
|
+
|
|
889
|
+
### Parameters
|
|
890
|
+
|
|
891
|
+
|Name | Type | Description | Notes|
|
|
892
|
+
|------------- | ------------- | ------------- | -------------|
|
|
893
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
894
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
895
|
+
| **identityId** | [**string**] | the User identifier | defaults to undefined|
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
### Return type
|
|
899
|
+
|
|
900
|
+
void (empty response body)
|
|
901
|
+
|
|
902
|
+
### Authorization
|
|
903
|
+
|
|
904
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
905
|
+
|
|
906
|
+
### HTTP request headers
|
|
907
|
+
|
|
908
|
+
- **Content-Type**: Not defined
|
|
909
|
+
- **Accept**: Not defined
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
### HTTP response details
|
|
913
|
+
| Status code | Description | Response headers |
|
|
914
|
+
|-------------|-------------|------------------|
|
|
915
|
+
|**204** | Request succeeded | - |
|
|
916
|
+
|**404** | The Solution or the user specified is unknown or you don\'t have access to them | - |
|
|
917
|
+
|
|
918
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
919
|
+
|
|
920
|
+
# **setSolutionDefaultSecurity**
|
|
921
|
+
> SolutionSecurity setSolutionDefaultSecurity(solutionRole)
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
### Example
|
|
925
|
+
|
|
926
|
+
```typescript
|
|
927
|
+
import {
|
|
928
|
+
SolutionApi,
|
|
929
|
+
Configuration,
|
|
930
|
+
SolutionRole
|
|
931
|
+
} from '@cosmotech/api-ts';
|
|
932
|
+
|
|
933
|
+
const configuration = new Configuration();
|
|
934
|
+
const apiInstance = new SolutionApi(configuration);
|
|
935
|
+
|
|
936
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
937
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
938
|
+
let solutionRole: SolutionRole; //This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution.
|
|
939
|
+
|
|
940
|
+
const { status, data } = await apiInstance.setSolutionDefaultSecurity(
|
|
941
|
+
organizationId,
|
|
942
|
+
solutionId,
|
|
943
|
+
solutionRole
|
|
944
|
+
);
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
### Parameters
|
|
948
|
+
|
|
949
|
+
|Name | Type | Description | Notes|
|
|
950
|
+
|------------- | ------------- | ------------- | -------------|
|
|
951
|
+
| **solutionRole** | **SolutionRole**| This change the solution default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the solution. | |
|
|
952
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
953
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
### Return type
|
|
957
|
+
|
|
958
|
+
**SolutionSecurity**
|
|
959
|
+
|
|
960
|
+
### Authorization
|
|
961
|
+
|
|
962
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
963
|
+
|
|
964
|
+
### HTTP request headers
|
|
965
|
+
|
|
966
|
+
- **Content-Type**: application/json, application/yaml
|
|
967
|
+
- **Accept**: application/json
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
### HTTP response details
|
|
971
|
+
| Status code | Description | Response headers |
|
|
972
|
+
|-------------|-------------|------------------|
|
|
973
|
+
|**201** | The Solution default visibility | - |
|
|
974
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
975
|
+
|
|
976
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
977
|
+
|
|
978
|
+
# **updateSolution**
|
|
979
|
+
> Solution updateSolution(solution)
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
### Example
|
|
983
|
+
|
|
984
|
+
```typescript
|
|
985
|
+
import {
|
|
986
|
+
SolutionApi,
|
|
987
|
+
Configuration,
|
|
988
|
+
Solution
|
|
989
|
+
} from '@cosmotech/api-ts';
|
|
990
|
+
|
|
991
|
+
const configuration = new Configuration();
|
|
992
|
+
const apiInstance = new SolutionApi(configuration);
|
|
993
|
+
|
|
994
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
995
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
996
|
+
let solution: Solution; //the new Solution details. This endpoint can\'t be used to update security
|
|
997
|
+
|
|
998
|
+
const { status, data } = await apiInstance.updateSolution(
|
|
999
|
+
organizationId,
|
|
1000
|
+
solutionId,
|
|
1001
|
+
solution
|
|
1002
|
+
);
|
|
1003
|
+
```
|
|
1004
|
+
|
|
1005
|
+
### Parameters
|
|
1006
|
+
|
|
1007
|
+
|Name | Type | Description | Notes|
|
|
1008
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1009
|
+
| **solution** | **Solution**| the new Solution details. This endpoint can\'t be used to update security | |
|
|
1010
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
1011
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
### Return type
|
|
1015
|
+
|
|
1016
|
+
**Solution**
|
|
1017
|
+
|
|
1018
|
+
### Authorization
|
|
1019
|
+
|
|
1020
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
1021
|
+
|
|
1022
|
+
### HTTP request headers
|
|
1023
|
+
|
|
1024
|
+
- **Content-Type**: application/json, application/yaml
|
|
1025
|
+
- **Accept**: application/json
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
### HTTP response details
|
|
1029
|
+
| Status code | Description | Response headers |
|
|
1030
|
+
|-------------|-------------|------------------|
|
|
1031
|
+
|**200** | the solution details | - |
|
|
1032
|
+
|**400** | Bad request | - |
|
|
1033
|
+
|**404** | the Solution specified is unknown or you don\'t have access to it | - |
|
|
1034
|
+
|
|
1035
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1036
|
+
|
|
1037
|
+
# **updateSolutionAccessControl**
|
|
1038
|
+
> SolutionAccessControl updateSolutionAccessControl(solutionRole)
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
### Example
|
|
1042
|
+
|
|
1043
|
+
```typescript
|
|
1044
|
+
import {
|
|
1045
|
+
SolutionApi,
|
|
1046
|
+
Configuration,
|
|
1047
|
+
SolutionRole
|
|
1048
|
+
} from '@cosmotech/api-ts';
|
|
1049
|
+
|
|
1050
|
+
const configuration = new Configuration();
|
|
1051
|
+
const apiInstance = new SolutionApi(configuration);
|
|
1052
|
+
|
|
1053
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
1054
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
1055
|
+
let identityId: string; //the User identifier (default to undefined)
|
|
1056
|
+
let solutionRole: SolutionRole; //The new Solution Access Control
|
|
1057
|
+
|
|
1058
|
+
const { status, data } = await apiInstance.updateSolutionAccessControl(
|
|
1059
|
+
organizationId,
|
|
1060
|
+
solutionId,
|
|
1061
|
+
identityId,
|
|
1062
|
+
solutionRole
|
|
1063
|
+
);
|
|
1064
|
+
```
|
|
1065
|
+
|
|
1066
|
+
### Parameters
|
|
1067
|
+
|
|
1068
|
+
|Name | Type | Description | Notes|
|
|
1069
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1070
|
+
| **solutionRole** | **SolutionRole**| The new Solution Access Control | |
|
|
1071
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
1072
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
1073
|
+
| **identityId** | [**string**] | the User identifier | defaults to undefined|
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
### Return type
|
|
1077
|
+
|
|
1078
|
+
**SolutionAccessControl**
|
|
1079
|
+
|
|
1080
|
+
### Authorization
|
|
1081
|
+
|
|
1082
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
1083
|
+
|
|
1084
|
+
### HTTP request headers
|
|
1085
|
+
|
|
1086
|
+
- **Content-Type**: application/json
|
|
1087
|
+
- **Accept**: application/json
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
### HTTP response details
|
|
1091
|
+
| Status code | Description | Response headers |
|
|
1092
|
+
|-------------|-------------|------------------|
|
|
1093
|
+
|**200** | The Solution access | - |
|
|
1094
|
+
|**404** | The Solution specified is unknown or you don\'t have access to it | - |
|
|
1095
|
+
|
|
1096
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1097
|
+
|
|
1098
|
+
# **updateSolutionRunTemplate**
|
|
1099
|
+
> Array<RunTemplate> updateSolutionRunTemplate(runTemplate)
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
### Example
|
|
1103
|
+
|
|
1104
|
+
```typescript
|
|
1105
|
+
import {
|
|
1106
|
+
SolutionApi,
|
|
1107
|
+
Configuration,
|
|
1108
|
+
RunTemplate
|
|
1109
|
+
} from '@cosmotech/api-ts';
|
|
1110
|
+
|
|
1111
|
+
const configuration = new Configuration();
|
|
1112
|
+
const apiInstance = new SolutionApi(configuration);
|
|
1113
|
+
|
|
1114
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
1115
|
+
let solutionId: string; //the Solution identifier (default to undefined)
|
|
1116
|
+
let runTemplateId: string; //the Run Template identifier (default to undefined)
|
|
1117
|
+
let runTemplate: RunTemplate; //the Run Templates
|
|
1118
|
+
|
|
1119
|
+
const { status, data } = await apiInstance.updateSolutionRunTemplate(
|
|
1120
|
+
organizationId,
|
|
1121
|
+
solutionId,
|
|
1122
|
+
runTemplateId,
|
|
1123
|
+
runTemplate
|
|
1124
|
+
);
|
|
1125
|
+
```
|
|
1126
|
+
|
|
1127
|
+
### Parameters
|
|
1128
|
+
|
|
1129
|
+
|Name | Type | Description | Notes|
|
|
1130
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1131
|
+
| **runTemplate** | **RunTemplate**| the Run Templates | |
|
|
1132
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
1133
|
+
| **solutionId** | [**string**] | the Solution identifier | defaults to undefined|
|
|
1134
|
+
| **runTemplateId** | [**string**] | the Run Template identifier | defaults to undefined|
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
### Return type
|
|
1138
|
+
|
|
1139
|
+
**Array<RunTemplate>**
|
|
1140
|
+
|
|
1141
|
+
### Authorization
|
|
1142
|
+
|
|
1143
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
1144
|
+
|
|
1145
|
+
### HTTP request headers
|
|
1146
|
+
|
|
1147
|
+
- **Content-Type**: application/json, application/yaml
|
|
1148
|
+
- **Accept**: application/json
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
### HTTP response details
|
|
1152
|
+
| Status code | Description | Response headers |
|
|
1153
|
+
|-------------|-------------|------------------|
|
|
1154
|
+
|**200** | the Parameters | - |
|
|
1155
|
+
|**400** | Bad request | - |
|
|
1156
|
+
|**404** | the Solution or Run Template specified is unknown or you don\'t have access to it | - |
|
|
1157
|
+
|
|
1158
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1159
|
+
|