@cosmotech/api-ts 5.0.0-beta4 → 5.0.0-beta5
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 +3 -4
- package/.github/workflows/track_dependencies.yml +28 -0
- package/.openapi-generator/FILES +1 -1
- package/README.md +4 -8
- package/api.ts +153 -476
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +203 -333
- package/dist/api.js +178 -596
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- 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/DatasetApi.md +83 -16
- package/docs/DatasetCompatibility.md +25 -0
- package/docs/DatasetConnector.md +27 -0
- package/docs/DatasetCopyParameters.md +25 -0
- package/docs/DatasetPartTypeEnum.md +1 -1
- package/docs/DatasetSearch.md +21 -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/DeleteHistoricalData.md +25 -0
- package/docs/FileUploadMetadata.md +22 -0
- package/docs/FileUploadValidation.md +23 -0
- package/docs/GraphProperties.md +28 -0
- package/docs/IngestionStatusEnum.md +15 -0
- package/docs/IoTypesEnum.md +11 -0
- package/docs/RunLogs.md +23 -0
- package/docs/RunLogsEntry.md +21 -0
- package/docs/RunTemplateOrchestrator.md +11 -0
- package/docs/RunTemplateStepSource.md +15 -0
- package/docs/Runner.md +2 -2
- package/docs/RunnerApi.md +4 -4
- package/docs/RunnerCreateRequest.md +4 -4
- package/docs/RunnerDatasets.md +24 -0
- package/docs/RunnerRunTemplateParameterValue.md +1 -1
- package/docs/RunnerUpdateRequest.md +2 -2
- package/docs/SolutionApi.md +0 -290
- 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/WorkspaceSolution.md +4 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.
|
|
5
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.
|
|
8
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.
|
|
5
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.
|
|
8
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.
|
|
5
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.
|
|
8
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.0.
|
|
5
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.0.
|
|
8
|
+
* The version of the OpenAPI document: 5.0.1-SNAPSHOT
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Connector
|
|
2
|
+
|
|
3
|
+
a version of a Connector
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the Connector version unique identifier | [optional] [readonly] [default to undefined]
|
|
10
|
+
**key** | **string** | the Connector key which group Connector versions | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | the Connector name | [optional] [default to undefined]
|
|
12
|
+
**description** | **string** | the Connector description | [optional] [default to undefined]
|
|
13
|
+
**repository** | **string** | the registry repository containing the image | [optional] [default to undefined]
|
|
14
|
+
**version** | **string** | the Connector version MAJOR.MINOR.PATCH. Must be aligned with an existing repository tag | [optional] [default to undefined]
|
|
15
|
+
**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
|
|
16
|
+
**ownerId** | **string** | the user id which own this connector version | [optional] [readonly] [default to undefined]
|
|
17
|
+
**url** | **string** | an optional URL link to connector page | [optional] [default to undefined]
|
|
18
|
+
**ioTypes** | [**Array<IoTypesEnum>**](IoTypesEnum.md) | | [optional] [default to undefined]
|
|
19
|
+
**parameterGroups** | [**Array<ConnectorParameterGroup>**](ConnectorParameterGroup.md) | the list of connector parameters groups | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { Connector } from '@cosmotech/api-ts';
|
|
25
|
+
|
|
26
|
+
const instance: Connector = {
|
|
27
|
+
id,
|
|
28
|
+
key,
|
|
29
|
+
name,
|
|
30
|
+
description,
|
|
31
|
+
repository,
|
|
32
|
+
version,
|
|
33
|
+
tags,
|
|
34
|
+
ownerId,
|
|
35
|
+
url,
|
|
36
|
+
ioTypes,
|
|
37
|
+
parameterGroups,
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
# ConnectorApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**findAllConnectors**](#findallconnectors) | **GET** /connectors | List all Connectors|
|
|
8
|
+
|[**findConnectorById**](#findconnectorbyid) | **GET** /connectors/{connector_id} | Get the details of a connector|
|
|
9
|
+
|[**registerConnector**](#registerconnector) | **POST** /connectors | Register a new connector|
|
|
10
|
+
|[**unregisterConnector**](#unregisterconnector) | **DELETE** /connectors/{connector_id} | Unregister a connector|
|
|
11
|
+
|
|
12
|
+
# **findAllConnectors**
|
|
13
|
+
> Array<Connector> findAllConnectors()
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
ConnectorApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@cosmotech/api-ts';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new ConnectorApi(configuration);
|
|
26
|
+
|
|
27
|
+
let page: number; //page number to query (first page is at index 0) (optional) (default to undefined)
|
|
28
|
+
let size: number; //amount of result by page (optional) (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.findAllConnectors(
|
|
31
|
+
page,
|
|
32
|
+
size
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **page** | [**number**] | page number to query (first page is at index 0) | (optional) defaults to undefined|
|
|
41
|
+
| **size** | [**number**] | amount of result by page | (optional) defaults to undefined|
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**Array<Connector>**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
51
|
+
|
|
52
|
+
### HTTP request headers
|
|
53
|
+
|
|
54
|
+
- **Content-Type**: Not defined
|
|
55
|
+
- **Accept**: application/json
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### HTTP response details
|
|
59
|
+
| Status code | Description | Response headers |
|
|
60
|
+
|-------------|-------------|------------------|
|
|
61
|
+
|**200** | the list of Connectors | - |
|
|
62
|
+
|
|
63
|
+
[[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)
|
|
64
|
+
|
|
65
|
+
# **findConnectorById**
|
|
66
|
+
> Connector findConnectorById()
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import {
|
|
73
|
+
ConnectorApi,
|
|
74
|
+
Configuration
|
|
75
|
+
} from '@cosmotech/api-ts';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new ConnectorApi(configuration);
|
|
79
|
+
|
|
80
|
+
let connectorId: string; //the Connector identifier (default to undefined)
|
|
81
|
+
|
|
82
|
+
const { status, data } = await apiInstance.findConnectorById(
|
|
83
|
+
connectorId
|
|
84
|
+
);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **connectorId** | [**string**] | the Connector identifier | defaults to undefined|
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### Return type
|
|
95
|
+
|
|
96
|
+
**Connector**
|
|
97
|
+
|
|
98
|
+
### Authorization
|
|
99
|
+
|
|
100
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
101
|
+
|
|
102
|
+
### HTTP request headers
|
|
103
|
+
|
|
104
|
+
- **Content-Type**: Not defined
|
|
105
|
+
- **Accept**: application/json
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### HTTP response details
|
|
109
|
+
| Status code | Description | Response headers |
|
|
110
|
+
|-------------|-------------|------------------|
|
|
111
|
+
|**200** | the Connector details | - |
|
|
112
|
+
|**404** | the Connector specified is unknown or you don\'t have access to it | - |
|
|
113
|
+
|
|
114
|
+
[[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)
|
|
115
|
+
|
|
116
|
+
# **registerConnector**
|
|
117
|
+
> Connector registerConnector(connector)
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
import {
|
|
124
|
+
ConnectorApi,
|
|
125
|
+
Configuration,
|
|
126
|
+
Connector
|
|
127
|
+
} from '@cosmotech/api-ts';
|
|
128
|
+
|
|
129
|
+
const configuration = new Configuration();
|
|
130
|
+
const apiInstance = new ConnectorApi(configuration);
|
|
131
|
+
|
|
132
|
+
let connector: Connector; //the Connector to register
|
|
133
|
+
|
|
134
|
+
const { status, data } = await apiInstance.registerConnector(
|
|
135
|
+
connector
|
|
136
|
+
);
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
|Name | Type | Description | Notes|
|
|
142
|
+
|------------- | ------------- | ------------- | -------------|
|
|
143
|
+
| **connector** | **Connector**| the Connector to register | |
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### Return type
|
|
147
|
+
|
|
148
|
+
**Connector**
|
|
149
|
+
|
|
150
|
+
### Authorization
|
|
151
|
+
|
|
152
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: application/json, application/yaml
|
|
157
|
+
- **Accept**: application/json
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### HTTP response details
|
|
161
|
+
| Status code | Description | Response headers |
|
|
162
|
+
|-------------|-------------|------------------|
|
|
163
|
+
|**201** | the connector details | - |
|
|
164
|
+
|**400** | Bad request | - |
|
|
165
|
+
|
|
166
|
+
[[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)
|
|
167
|
+
|
|
168
|
+
# **unregisterConnector**
|
|
169
|
+
> unregisterConnector()
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import {
|
|
176
|
+
ConnectorApi,
|
|
177
|
+
Configuration
|
|
178
|
+
} from '@cosmotech/api-ts';
|
|
179
|
+
|
|
180
|
+
const configuration = new Configuration();
|
|
181
|
+
const apiInstance = new ConnectorApi(configuration);
|
|
182
|
+
|
|
183
|
+
let connectorId: string; //the Connector identifier (default to undefined)
|
|
184
|
+
|
|
185
|
+
const { status, data } = await apiInstance.unregisterConnector(
|
|
186
|
+
connectorId
|
|
187
|
+
);
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Parameters
|
|
191
|
+
|
|
192
|
+
|Name | Type | Description | Notes|
|
|
193
|
+
|------------- | ------------- | ------------- | -------------|
|
|
194
|
+
| **connectorId** | [**string**] | the Connector identifier | defaults to undefined|
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
### Return type
|
|
198
|
+
|
|
199
|
+
void (empty response body)
|
|
200
|
+
|
|
201
|
+
### Authorization
|
|
202
|
+
|
|
203
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
204
|
+
|
|
205
|
+
### HTTP request headers
|
|
206
|
+
|
|
207
|
+
- **Content-Type**: Not defined
|
|
208
|
+
- **Accept**: Not defined
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
### HTTP response details
|
|
212
|
+
| Status code | Description | Response headers |
|
|
213
|
+
|-------------|-------------|------------------|
|
|
214
|
+
|**204** | Request successful | - |
|
|
215
|
+
|**404** | the Connector specified is unknown or you don\'t have access to it | - |
|
|
216
|
+
|
|
217
|
+
[[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)
|
|
218
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# ConnectorParameter
|
|
2
|
+
|
|
3
|
+
a connector parameter
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the connector parameter id | [default to undefined]
|
|
10
|
+
**label** | **string** | the list of translated parameter group labels | [default to undefined]
|
|
11
|
+
**valueType** | **string** | the parameter value type | [optional] [default to undefined]
|
|
12
|
+
**_options** | **Array<string>** | the list of available and valid values for the parameter | [optional] [default to undefined]
|
|
13
|
+
**_default** | **string** | the default value | [optional] [default to undefined]
|
|
14
|
+
**envVar** | **string** | associated environment variable in connector image | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { ConnectorParameter } from '@cosmotech/api-ts';
|
|
20
|
+
|
|
21
|
+
const instance: ConnectorParameter = {
|
|
22
|
+
id,
|
|
23
|
+
label,
|
|
24
|
+
valueType,
|
|
25
|
+
_options,
|
|
26
|
+
_default,
|
|
27
|
+
envVar,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ConnectorParameterGroup
|
|
2
|
+
|
|
3
|
+
a connector parameters group
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the connector parameter group id | [default to undefined]
|
|
10
|
+
**label** | **string** | the list of translated parameter group labels | [default to undefined]
|
|
11
|
+
**parameters** | [**Array<ConnectorParameter>**](ConnectorParameter.md) | the list of parameters | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ConnectorParameterGroup } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: ConnectorParameterGroup = {
|
|
19
|
+
id,
|
|
20
|
+
label,
|
|
21
|
+
parameters,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/DatasetApi.md
CHANGED
|
@@ -24,6 +24,7 @@ All URIs are relative to *http://localhost:8080*
|
|
|
24
24
|
|[**updateDataset**](#updatedataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a Dataset|
|
|
25
25
|
|[**updateDatasetAccessControl**](#updatedatasetaccesscontrol) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Update the specified access to User for a Dataset|
|
|
26
26
|
|[**updateDatasetDefaultSecurity**](#updatedatasetdefaultsecurity) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/default | Set the Dataset default security|
|
|
27
|
+
|[**updateDatasetPart**](#updatedatasetpart) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Update existing dataset parts information of a Dataset|
|
|
27
28
|
|
|
28
29
|
# **createDataset**
|
|
29
30
|
> Dataset createDataset()
|
|
@@ -83,8 +84,8 @@ const { status, data } = await apiInstance.createDataset(
|
|
|
83
84
|
|-------------|-------------|------------------|
|
|
84
85
|
|**201** | Dataset successfully created | - |
|
|
85
86
|
|**400** | Bad request | - |
|
|
86
|
-
|**403** | Insufficient permissions on organization
|
|
87
|
-
|**404** | Organization
|
|
87
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
88
|
+
|**404** | Organization, workspace specified is not found | - |
|
|
88
89
|
|
|
89
90
|
[[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)
|
|
90
91
|
|
|
@@ -210,7 +211,7 @@ const { status, data } = await apiInstance.createDatasetPart(
|
|
|
210
211
|
|-------------|-------------|------------------|
|
|
211
212
|
|**201** | Dataset part successfully created | - |
|
|
212
213
|
|**400** | Bad request - Dataset part cannot be created | - |
|
|
213
|
-
|**403** | Insufficient permissions on organization
|
|
214
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
214
215
|
|**404** | Dataset specified is not found | - |
|
|
215
216
|
|
|
216
217
|
[[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)
|
|
@@ -269,7 +270,7 @@ void (empty response body)
|
|
|
269
270
|
| Status code | Description | Response headers |
|
|
270
271
|
|-------------|-------------|------------------|
|
|
271
272
|
|**204** | Dataset successfully deleted | - |
|
|
272
|
-
|**403** | Insufficient permissions on organization
|
|
273
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
273
274
|
|**404** | Organization or workspace or dataset specified is not found | - |
|
|
274
275
|
|
|
275
276
|
[[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)
|
|
@@ -391,7 +392,7 @@ void (empty response body)
|
|
|
391
392
|
| Status code | Description | Response headers |
|
|
392
393
|
|-------------|-------------|------------------|
|
|
393
394
|
|**204** | Dataset part successfully deleted | - |
|
|
394
|
-
|**403** | Insufficient permissions on organization
|
|
395
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
395
396
|
|**404** | Dataset part specified is not found | - |
|
|
396
397
|
|
|
397
398
|
[[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)
|
|
@@ -452,7 +453,7 @@ const { status, data } = await apiInstance.downloadDatasetPart(
|
|
|
452
453
|
| Status code | Description | Response headers |
|
|
453
454
|
|-------------|-------------|------------------|
|
|
454
455
|
|**200** | Dataset part successfully downloaded | - |
|
|
455
|
-
|**403** | Insufficient permissions on organization
|
|
456
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
456
457
|
|**404** | Dataset part specified is not found | - |
|
|
457
458
|
|
|
458
459
|
[[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)
|
|
@@ -511,8 +512,8 @@ const { status, data } = await apiInstance.getDataset(
|
|
|
511
512
|
| Status code | Description | Response headers |
|
|
512
513
|
|-------------|-------------|------------------|
|
|
513
514
|
|**200** | Dataset successfully retrieved | - |
|
|
514
|
-
|**403** | Insufficient permissions on organization
|
|
515
|
-
|**404** | Organization
|
|
515
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
516
|
+
|**404** | Organization, workspace or dataset specified is not found | - |
|
|
516
517
|
|
|
517
518
|
[[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)
|
|
518
519
|
|
|
@@ -632,7 +633,7 @@ const { status, data } = await apiInstance.getDatasetPart(
|
|
|
632
633
|
| Status code | Description | Response headers |
|
|
633
634
|
|-------------|-------------|------------------|
|
|
634
635
|
|**200** | Dataset part successfully retrieved | - |
|
|
635
|
-
|**403** | Insufficient permissions on organization
|
|
636
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
636
637
|
|**404** | Dataset part specified is not found | - |
|
|
637
638
|
|
|
638
639
|
[[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)
|
|
@@ -696,7 +697,7 @@ const { status, data } = await apiInstance.listDatasetParts(
|
|
|
696
697
|
| Status code | Description | Response headers |
|
|
697
698
|
|-------------|-------------|------------------|
|
|
698
699
|
|**200** | List of dataset parts | - |
|
|
699
|
-
|**403** | Insufficient permissions on organization
|
|
700
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
700
701
|
|**404** | Dataset specified is not found | - |
|
|
701
702
|
|**422** | Targeted dataset do not support requests | - |
|
|
702
703
|
|
|
@@ -816,8 +817,8 @@ const { status, data } = await apiInstance.listDatasets(
|
|
|
816
817
|
| Status code | Description | Response headers |
|
|
817
818
|
|-------------|-------------|------------------|
|
|
818
819
|
|**200** | Datasets successfully retrieved | - |
|
|
819
|
-
|**403** | Insufficient permissions on organization
|
|
820
|
-
|**404** | Organization
|
|
820
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
821
|
+
|**404** | Organization, workspace or dataset specified is not found | - |
|
|
821
822
|
|
|
822
823
|
[[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)
|
|
823
824
|
|
|
@@ -893,7 +894,7 @@ const { status, data } = await apiInstance.queryData(
|
|
|
893
894
|
|-------------|-------------|------------------|
|
|
894
895
|
|**200** | Data related to provided information | - |
|
|
895
896
|
|**400** | Bad request - Data cannot be retrieved from provided information | - |
|
|
896
|
-
|**403** | Insufficient permissions on organization
|
|
897
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
897
898
|
|**404** | Dataset specified is not found or you don\'t have access to it | - |
|
|
898
899
|
|**422** | Targeted dataset do not support requests | - |
|
|
899
900
|
|
|
@@ -962,7 +963,7 @@ const { status, data } = await apiInstance.replaceDatasetPart(
|
|
|
962
963
|
| Status code | Description | Response headers |
|
|
963
964
|
|-------------|-------------|------------------|
|
|
964
965
|
|**200** | Dataset part successfully replaced | - |
|
|
965
|
-
|**403** | Insufficient permissions on organization
|
|
966
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
966
967
|
|**404** | Dataset part specified is not found | - |
|
|
967
968
|
|**422** | Targeted dataset do not support requests | - |
|
|
968
969
|
|
|
@@ -1157,8 +1158,8 @@ const { status, data } = await apiInstance.updateDataset(
|
|
|
1157
1158
|
|-------------|-------------|------------------|
|
|
1158
1159
|
|**200** | Dataset successfully updated | - |
|
|
1159
1160
|
|**400** | Bad request | - |
|
|
1160
|
-
|**403** | Insufficient permissions on organization
|
|
1161
|
-
|**404** | Organization
|
|
1161
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
1162
|
+
|**404** | Organization, workspace or dataset specified is not found | - |
|
|
1162
1163
|
|
|
1163
1164
|
[[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)
|
|
1164
1165
|
|
|
@@ -1287,3 +1288,69 @@ const { status, data } = await apiInstance.updateDatasetDefaultSecurity(
|
|
|
1287
1288
|
|
|
1288
1289
|
[[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)
|
|
1289
1290
|
|
|
1291
|
+
# **updateDatasetPart**
|
|
1292
|
+
> DatasetPart updateDatasetPart(datasetPartUpdateRequest)
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
### Example
|
|
1296
|
+
|
|
1297
|
+
```typescript
|
|
1298
|
+
import {
|
|
1299
|
+
DatasetApi,
|
|
1300
|
+
Configuration,
|
|
1301
|
+
DatasetPartUpdateRequest
|
|
1302
|
+
} from '@cosmotech/api-ts';
|
|
1303
|
+
|
|
1304
|
+
const configuration = new Configuration();
|
|
1305
|
+
const apiInstance = new DatasetApi(configuration);
|
|
1306
|
+
|
|
1307
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
1308
|
+
let workspaceId: string; //the Workspace identifier (default to undefined)
|
|
1309
|
+
let datasetId: string; //the Dataset identifier (default to undefined)
|
|
1310
|
+
let datasetPartId: string; //the Dataset part identifier (default to undefined)
|
|
1311
|
+
let datasetPartUpdateRequest: DatasetPartUpdateRequest; //Dataset part information to update
|
|
1312
|
+
|
|
1313
|
+
const { status, data } = await apiInstance.updateDatasetPart(
|
|
1314
|
+
organizationId,
|
|
1315
|
+
workspaceId,
|
|
1316
|
+
datasetId,
|
|
1317
|
+
datasetPartId,
|
|
1318
|
+
datasetPartUpdateRequest
|
|
1319
|
+
);
|
|
1320
|
+
```
|
|
1321
|
+
|
|
1322
|
+
### Parameters
|
|
1323
|
+
|
|
1324
|
+
|Name | Type | Description | Notes|
|
|
1325
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1326
|
+
| **datasetPartUpdateRequest** | **DatasetPartUpdateRequest**| Dataset part information to update | |
|
|
1327
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
1328
|
+
| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
|
|
1329
|
+
| **datasetId** | [**string**] | the Dataset identifier | defaults to undefined|
|
|
1330
|
+
| **datasetPartId** | [**string**] | the Dataset part identifier | defaults to undefined|
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
### Return type
|
|
1334
|
+
|
|
1335
|
+
**DatasetPart**
|
|
1336
|
+
|
|
1337
|
+
### Authorization
|
|
1338
|
+
|
|
1339
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
1340
|
+
|
|
1341
|
+
### HTTP request headers
|
|
1342
|
+
|
|
1343
|
+
- **Content-Type**: application/json, application/yaml
|
|
1344
|
+
- **Accept**: application/json, application/yaml
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
### HTTP response details
|
|
1348
|
+
| Status code | Description | Response headers |
|
|
1349
|
+
|-------------|-------------|------------------|
|
|
1350
|
+
|**200** | Dataset part information successfully updated | - |
|
|
1351
|
+
|**403** | Insufficient permissions on organization, workspace or dataset | - |
|
|
1352
|
+
|**404** | Dataset part specified is not found | - |
|
|
1353
|
+
|**422** | Targeted dataset do not support requests | - |
|
|
1354
|
+
|
|
1355
|
+
[[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)
|
|
1356
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DatasetCompatibility
|
|
2
|
+
|
|
3
|
+
a Dataset compatibility constraint to a Solution version open range
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**solutionKey** | **string** | the Solution key which group Solution versions | [default to undefined]
|
|
10
|
+
**minimumVersion** | **string** | the Solution minimum version compatibility (version included) | [optional] [default to undefined]
|
|
11
|
+
**maximumVersion** | **string** | the Solution maximum version compatibility (version included) | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DatasetCompatibility } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: DatasetCompatibility = {
|
|
19
|
+
solutionKey,
|
|
20
|
+
minimumVersion,
|
|
21
|
+
maximumVersion,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# DatasetConnector
|
|
2
|
+
|
|
3
|
+
the Connector setup bound to a Dataset
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | the Connector id | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | the Connector name | [optional] [default to undefined]
|
|
11
|
+
**version** | **string** | the Connector version | [optional] [default to undefined]
|
|
12
|
+
**parametersValues** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { DatasetConnector } from '@cosmotech/api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: DatasetConnector = {
|
|
20
|
+
id,
|
|
21
|
+
name,
|
|
22
|
+
version,
|
|
23
|
+
parametersValues,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DatasetCopyParameters
|
|
2
|
+
|
|
3
|
+
the Dataset Copy Parameters
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sourceId** | **string** | the source Dataset id | [optional] [default to undefined]
|
|
10
|
+
**targetId** | **string** | the target Dataset id | [optional] [default to undefined]
|
|
11
|
+
**_options** | **{ [key: string]: any; }** | freeform options to path to connectors | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DatasetCopyParameters } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: DatasetCopyParameters = {
|
|
19
|
+
sourceId,
|
|
20
|
+
targetId,
|
|
21
|
+
_options,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,6 +6,6 @@ The dataset part Type
|
|
|
6
6
|
|
|
7
7
|
* `File` (value: `'File'`)
|
|
8
8
|
|
|
9
|
-
* `
|
|
9
|
+
* `Db` (value: `'DB'`)
|
|
10
10
|
|
|
11
11
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|