orvanta-api 2.3.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

# \BpmnInstanceApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_bpmn_instance**](BpmnInstanceApi.md#cancel_bpmn_instance) | **POST** /w/{workspace}/bpmn/instances/cancel/{id} | cancel BPMN process instance
[**get_bpmn_instance**](BpmnInstanceApi.md#get_bpmn_instance) | **GET** /w/{workspace}/bpmn/instances/get/{id} | get BPMN process instance
[**get_bpmn_instance_status**](BpmnInstanceApi.md#get_bpmn_instance_status) | **GET** /w/{workspace}/bpmn/instances/get/{id}/status | get BPMN process instance status
[**list_bpmn_incidents**](BpmnInstanceApi.md#list_bpmn_incidents) | **GET** /w/{workspace}/bpmn/instances/{id}/incidents | list BPMN process instance incidents
[**list_bpmn_instances**](BpmnInstanceApi.md#list_bpmn_instances) | **GET** /w/{workspace}/bpmn/instances/list | list BPMN process instances
[**preview_bpmn_instance**](BpmnInstanceApi.md#preview_bpmn_instance) | **POST** /w/{workspace}/bpmn/run/preview | run BPMN process preview (undeployed diagram)
[**retry_bpmn_incident**](BpmnInstanceApi.md#retry_bpmn_incident) | **POST** /w/{workspace}/bpmn/instances/{id}/incidents/{job_id}/retry | retry a BPMN process instance incident
[**start_bpmn_instance**](BpmnInstanceApi.md#start_bpmn_instance) | **POST** /w/{workspace}/bpmn/run/p/{path} | start BPMN process instance



## cancel_bpmn_instance

> String cancel_bpmn_instance(workspace, id, cancel_bpmn_instance)
cancel BPMN process instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**cancel_bpmn_instance** | [**CancelBpmnInstance**](CancelBpmnInstance.md) | cancel reason | [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)


## get_bpmn_instance

> models::BpmnInstanceDetail get_bpmn_instance(workspace, id)
get BPMN process instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::BpmnInstanceDetail**](BpmnInstanceDetail.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_instance_status

> models::ProcessInstanceStatus get_bpmn_instance_status(workspace, id)
get BPMN process instance status

Frontend-facing projection of the process instance's live runtime state (lifecycle, per-activity status, variables, history, incidents), consumed by the live process token overlay. 404 if the instance isn't in the workspace, or if the engine has not picked it up yet (no runtime state).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::ProcessInstanceStatus**](ProcessInstanceStatus.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_incidents

> Vec<models::BpmnIncident> list_bpmn_incidents(workspace, id)
list BPMN process instance incidents

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

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

> Vec<models::BpmnInstanceSummary> list_bpmn_instances(workspace, page, per_page)
list BPMN process instances

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

### Return type

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


## preview_bpmn_instance

> String preview_bpmn_instance(workspace, preview_bpmn_instance)
run BPMN process preview (undeployed diagram)

Start a process instance from an undeployed diagram (#710 stage 3), the \"run without deploying\" counterpart to `POST /bpmn/run/p/{path}`. The submitted XML is parsed and validated exactly as a real deploy would -- nothing is written to `bpmn_flow`/`bpmn_flow_version`.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**preview_bpmn_instance** | [**PreviewBpmnInstance**](PreviewBpmnInstance.md) | inline BPMN XML plus initial process variables | [required] |

### Return type

**String**

### Authorization

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

### HTTP request headers

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

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


## retry_bpmn_incident

> String retry_bpmn_incident(workspace, id, job_id)
retry a BPMN process instance incident

Validates the ActivityFailed incident, identified by the original failed child job's id, and records a retry intent on the process instance. The execution engine does not yet act on this intent: retrying an incident is not yet functional end-to-end. This endpoint only validates ownership of the incident and records the intent for a future engine version to consume.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**job_id** | **uuid::Uuid** | the failed child job id identifying the incident to retry (Incident.job) | [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)


## start_bpmn_instance

> String start_bpmn_instance(workspace, path, start_bpmn_instance)
start BPMN process instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**start_bpmn_instance** | [**StartBpmnInstance**](StartBpmnInstance.md) | initial process variables | [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)