orvanta-api 4.1.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

# \DataMigrationApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**archive_data_migration_by_path**](DataMigrationApi.md#archive_data_migration_by_path) | **POST** /w/{workspace}/data_migration/definitions/archive/{path} | archive or unarchive a data-migration definition
[**create_data_migration**](DataMigrationApi.md#create_data_migration) | **POST** /w/{workspace}/data_migration/definitions/create | create a data-migration definition
[**data_migration_dry_run**](DataMigrationApi.md#data_migration_dry_run) | **POST** /w/{workspace}/data_migration/dry_run | dry-run a source->target data migration (preview only, no writes)
[**data_migration_get_run**](DataMigrationApi.md#data_migration_get_run) | **GET** /w/{workspace}/data_migration/runs/{id} | get one data-migration run, with its mapping and error text
[**data_migration_list_runs**](DataMigrationApi.md#data_migration_list_runs) | **GET** /w/{workspace}/data_migration/runs | list this workspace's data-migration runs, newest first
[**data_migration_run**](DataMigrationApi.md#data_migration_run) | **POST** /w/{workspace}/data_migration/run | queue a source->target data migration
[**delete_data_migration_by_path**](DataMigrationApi.md#delete_data_migration_by_path) | **DELETE** /w/{workspace}/data_migration/definitions/delete/{path} | delete a data-migration definition
[**exists_data_migration_by_path**](DataMigrationApi.md#exists_data_migration_by_path) | **GET** /w/{workspace}/data_migration/definitions/exists/{path} | does a data-migration definition exist at this path
[**get_data_migration_by_path**](DataMigrationApi.md#get_data_migration_by_path) | **GET** /w/{workspace}/data_migration/definitions/get/{path} | get a data-migration definition by path
[**list_data_migrations**](DataMigrationApi.md#list_data_migrations) | **GET** /w/{workspace}/data_migration/definitions/list | list saved data-migration definitions
[**update_data_migration**](DataMigrationApi.md#update_data_migration) | **POST** /w/{workspace}/data_migration/definitions/update/{path} | update a data-migration definition



## archive_data_migration_by_path

> String archive_data_migration_by_path(workspace, path, archive_flow_by_path_request)
archive or unarchive a data-migration definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**archive_flow_by_path_request** | [**ArchiveFlowByPathRequest**](ArchiveFlowByPathRequest.md) | archive a data-migration definition | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[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)


## create_data_migration

> String create_data_migration(workspace, new_data_migration)
create a data-migration definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_data_migration** | [**NewDataMigration**](NewDataMigration.md) | data-migration definition to create | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[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)


## data_migration_dry_run

> models::DryRunReport data_migration_dry_run(workspace, data_migration_request)
dry-run a source->target data migration (preview only, no writes)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**data_migration_request** | [**DataMigrationRequest**](DataMigrationRequest.md) | source/target resources, tables, and column mapping to preview | [required] |

### Return type

[**models::DryRunReport**](DryRunReport.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, text/plain

[[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)


## data_migration_get_run

> models::DataMigrationRunDetail data_migration_get_run(workspace, id)
get one data-migration run, with its mapping and error text

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **i64** | `data_migration_run.id` | [required] |

### Return type

[**models::DataMigrationRunDetail**](DataMigrationRunDetail.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[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)


## data_migration_list_runs

> Vec<models::DataMigrationRunSummary> data_migration_list_runs(workspace, page, per_page, status)
list this workspace's data-migration runs, newest first

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**status** | Option<**String**> | exact `status` match -- `running`, `completed`, `failed` or `cancelled`. Any other value simply matches nothing. |  |

### Return type

[**Vec<models::DataMigrationRunSummary>**](DataMigrationRunSummary.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[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)


## data_migration_run

> models::QueuedDataMigrationRun data_migration_run(workspace, data_migration_request)
queue a source->target data migration

Pushes the migration onto the job queue and returns the job id immediately (#1212). It does **not** wait for the copy: the run's progress, logs, result and cancel control are reached through the ordinary job endpoints under that id -- `/jobs_u/get/{id}`, `/jobs/get_progress/{id}` (a `progress_perc` percentage, updated after each committed batch), `/jobs_u/queue/cancel/{id}` and the job SSE stream.  **Cancelling is not a rollback.** The engine has no cross-batch transaction and no checkpoint (#1216), so cancelling an in-flight run stops it at the next batch boundary and **leaves every batch that already committed in the target**. The job's error message names how many rows were written. A client must not present this operation as atomic.  The dry-run operation stays synchronous -- it is bounded by a sample row limit and is what an interactive mapping UI calls. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**data_migration_request** | [**DataMigrationRequest**](DataMigrationRequest.md) | source/target resources, tables, and column mapping to migrate | [required] |

### Return type

[**models::QueuedDataMigrationRun**](QueuedDataMigrationRun.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, text/plain

[[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)


## delete_data_migration_by_path

> String delete_data_migration_by_path(workspace, path)
delete a data-migration definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[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)


## exists_data_migration_by_path

> bool exists_data_migration_by_path(workspace, path)
does a data-migration definition exist at this path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[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)


## get_data_migration_by_path

> models::DataMigrationDefinition get_data_migration_by_path(workspace, path)
get a data-migration definition by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

[**models::DataMigrationDefinition**](DataMigrationDefinition.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[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)


## list_data_migrations

> Vec<models::ListableDataMigration> list_data_migrations(workspace, page, per_page, order_desc, path_start, path_exact, show_archived, label, edited_by, without_description)
list saved data-migration definitions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**order_desc** | Option<**bool**> | order by desc order (default true) |  |
**path_start** | Option<**String**> | mask to filter matching starting path |  |
**path_exact** | Option<**String**> | mask to filter exact matching path |  |
**show_archived** | Option<**bool**> |  |  |
**label** | Option<**String**> | Filter by label |  |
**edited_by** | Option<**String**> | Filter by the user who last edited the definition |  |
**without_description** | Option<**bool**> | Return NULL for description to reduce payload size |  |

### Return type

[**Vec<models::ListableDataMigration>**](ListableDataMigration.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

[[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)


## update_data_migration

> String update_data_migration(workspace, path, new_data_migration)
update a data-migration definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**new_data_migration** | [**NewDataMigration**](NewDataMigration.md) | data-migration definition to update | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[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)