orvanta-api 6.4.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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443

# \BpmnFlowApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**archive_bpmn_flow_by_path**](BpmnFlowApi.md#archive_bpmn_flow_by_path) | **POST** /w/{workspace}/bpmn_flows/archive/{path} | archive BPMN flow by path
[**create_bpmn_flow**](BpmnFlowApi.md#create_bpmn_flow) | **POST** /w/{workspace}/bpmn_flows/create | create BPMN flow
[**delete_bpmn_flow_by_path**](BpmnFlowApi.md#delete_bpmn_flow_by_path) | **DELETE** /w/{workspace}/bpmn_flows/delete/{path} | delete BPMN flow by path
[**exists_bpmn_flow_by_path**](BpmnFlowApi.md#exists_bpmn_flow_by_path) | **GET** /w/{workspace}/bpmn_flows/exists/{path} | exists BPMN flow by path
[**get_bpmn_authoring_guide**](BpmnFlowApi.md#get_bpmn_authoring_guide) | **GET** /w/{workspace}/bpmn_flows/authoring_guide | what the BPMN engine executes, refuses, and reports
[**get_bpmn_flow_by_path**](BpmnFlowApi.md#get_bpmn_flow_by_path) | **GET** /w/{workspace}/bpmn_flows/get/{path} | get BPMN flow by path
[**get_bpmn_flow_by_path_with_draft**](BpmnFlowApi.md#get_bpmn_flow_by_path_with_draft) | **GET** /w/{workspace}/bpmn_flows/get/draft/{path} | get BPMN flow by path with draft
[**get_bpmn_flow_history**](BpmnFlowApi.md#get_bpmn_flow_history) | **GET** /w/{workspace}/bpmn_flows/history/p/{path} | get BPMN flow history by path
[**get_bpmn_flow_version**](BpmnFlowApi.md#get_bpmn_flow_version) | **GET** /w/{workspace}/bpmn_flows/get/v/{version}/p/{path} | get BPMN flow version
[**list_bpmn_flows**](BpmnFlowApi.md#list_bpmn_flows) | **GET** /w/{workspace}/bpmn_flows/list | list all BPMN flows
[**list_bpmn_paths**](BpmnFlowApi.md#list_bpmn_paths) | **GET** /w/{workspace}/bpmn_flows/list_paths | list all BPMN flow paths
[**list_search_bpmn_flow**](BpmnFlowApi.md#list_search_bpmn_flow) | **GET** /w/{workspace}/bpmn_flows/list_search | list BPMN flows for search
[**update_bpmn_flow**](BpmnFlowApi.md#update_bpmn_flow) | **POST** /w/{workspace}/bpmn_flows/update/{path} | update BPMN flow
[**validate_bpmn_flow**](BpmnFlowApi.md#validate_bpmn_flow) | **POST** /w/{workspace}/bpmn_flows/validate | validate a BPMN document without saving it



## archive_bpmn_flow_by_path

> String archive_bpmn_flow_by_path(workspace, path, archive_flow_by_path_request)
archive BPMN flow by path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**archive_flow_by_path_request** | [**ArchiveFlowByPathRequest**](ArchiveFlowByPathRequest.md) | archive BPMN flow | [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_bpmn_flow

> models::BpmnDeployResult create_bpmn_flow(workspace, new_bpmn_flow)
create BPMN flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_bpmn_flow** | [**NewBpmnFlow**](NewBpmnFlow.md) | BPMN flow to create | [required] |

### Return type

[**models::BpmnDeployResult**](BpmnDeployResult.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_bpmn_flow_by_path

> String delete_bpmn_flow_by_path(workspace, path)
delete BPMN flow by path

### 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_bpmn_flow_by_path

> bool exists_bpmn_flow_by_path(workspace, path)
exists BPMN flow by 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_bpmn_authoring_guide

> models::BpmnAuthoringGuide get_bpmn_authoring_guide(workspace)
what the BPMN engine executes, refuses, and reports

Serve the engine's own support and refusal vocabulary, exported verbatim from `backend/orvanta-bpmn/element-support.json` and `validation-codes.json` (#1560). Static within a release; the response does not depend on the workspace, the caller or any row.

### Parameters


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

### Return type

[**models::BpmnAuthoringGuide**](BpmnAuthoringGuide.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)


## get_bpmn_flow_by_path

> models::BpmnFlow get_bpmn_flow_by_path(workspace, path)
get BPMN flow by path

### Parameters


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

### Return type

[**models::BpmnFlow**](BpmnFlow.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)


## get_bpmn_flow_by_path_with_draft

> models::BpmnFlowWithDraft get_bpmn_flow_by_path_with_draft(workspace, path)
get BPMN flow by path with draft

### Parameters


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

### Return type

[**models::BpmnFlowWithDraft**](BpmnFlowWithDraft.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)


## get_bpmn_flow_history

> Vec<models::BpmnFlowVersion> get_bpmn_flow_history(workspace, path)
get BPMN flow history by path

### Parameters


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

### Return type

[**Vec<models::BpmnFlowVersion>**](BpmnFlowVersion.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)


## get_bpmn_flow_version

> models::BpmnFlow get_bpmn_flow_version(workspace, version, path)
get BPMN flow version

### Parameters


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

### Return type

[**models::BpmnFlow**](BpmnFlow.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_bpmn_flows

> Vec<models::ListableBpmnFlow> list_bpmn_flows(workspace, page, per_page, order_desc, path_start, path_exact, show_archived, starred_only, include_draft_only, label, edited_by, without_description, with_bpmn_xml)
list all BPMN flows

### 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**> |  |  |
**starred_only** | Option<**bool**> | (default false) show only the starred items  |  |
**include_draft_only** | Option<**bool**> |  |  |
**label** | Option<**String**> | Filter by label |  |
**edited_by** | Option<**String**> | Filter by the user who last edited the flow |  |
**without_description** | Option<**bool**> | Return NULL for description to reduce payload size |  |
**with_bpmn_xml** | Option<**bool**> | (default false) Include each flow's deployed `bpmn_xml` on the list row, so a caller that draws every flow (a thumbnail grid, which reads the document's own `bpmndi:` geometry) does not need one `getBpmnFlowByPath` per item.  Opt-in because it is by far the largest thing in the row. Limited to `per_page` <= 100; a larger page with this flag set is refused with 400 rather than silently clamped.  |  |

### Return type

[**Vec<models::ListableBpmnFlow>**](ListableBpmnFlow.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_bpmn_paths

> Vec<String> list_bpmn_paths(workspace)
list all BPMN flow paths

### Parameters


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

### Return type

**Vec<String>**

### 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_search_bpmn_flow

> Vec<models::ListSearchBpmnFlow200ResponseInner> list_search_bpmn_flow(workspace)
list BPMN flows for search

### Parameters


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

### Return type

[**Vec<models::ListSearchBpmnFlow200ResponseInner>**](listSearchBpmnFlow_200_response_inner.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_bpmn_flow

> models::BpmnDeployResult update_bpmn_flow(workspace, path, new_bpmn_flow)
update BPMN flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**new_bpmn_flow** | [**NewBpmnFlow**](NewBpmnFlow.md) | BPMN flow to update | [required] |

### Return type

[**models::BpmnDeployResult**](BpmnDeployResult.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)


## validate_bpmn_flow

> models::BpmnValidationReport validate_bpmn_flow(workspace, bpmn_validation_request)
validate a BPMN document without saving it

Run the **deploy path's own** validation pipeline over a BPMN document and report the findings. Writes nothing: no flow, no draft, no version, no schedule, no git commit. The transaction it opens (delegate and form resolution need one) is rolled back on every path.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**bpmn_validation_request** | [**BpmnValidationRequest**](BpmnValidationRequest.md) | The BPMN document to check | [required] |

### Return type

[**models::BpmnValidationReport**](BpmnValidationReport.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)