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

# \BpmnDelegateApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_bpmn_delegate_binding**](BpmnDelegateApi.md#create_bpmn_delegate_binding) | **POST** /w/{workspace}/bpmn_delegates/create | create a BPMN delegate binding
[**delete_bpmn_delegate_binding**](BpmnDelegateApi.md#delete_bpmn_delegate_binding) | **DELETE** /w/{workspace}/bpmn_delegates/delete/{path} | delete a BPMN delegate binding
[**get_bpmn_delegate_binding**](BpmnDelegateApi.md#get_bpmn_delegate_binding) | **GET** /w/{workspace}/bpmn_delegates/get/{path} | get a BPMN delegate binding by path
[**import_bpmn_delegate_bindings**](BpmnDelegateApi.md#import_bpmn_delegate_bindings) | **POST** /w/{workspace}/bpmn_delegates/import | create or update many BPMN delegate bindings in one call
[**list_bpmn_delegate_bindings**](BpmnDelegateApi.md#list_bpmn_delegate_bindings) | **GET** /w/{workspace}/bpmn_delegates/list | list BPMN delegate bindings
[**list_unbound_bpmn_delegates**](BpmnDelegateApi.md#list_unbound_bpmn_delegates) | **GET** /w/{workspace}/bpmn_delegates/unbound | the unbound-delegate checklist -- every delegate key referenced somewhere in the workspace's deployed and draft BPMN definitions that has no binding yet
[**update_bpmn_delegate_binding**](BpmnDelegateApi.md#update_bpmn_delegate_binding) | **POST** /w/{workspace}/bpmn_delegates/update/{path} | update a BPMN delegate binding



## create_bpmn_delegate_binding

> String create_bpmn_delegate_binding(workspace, new_bpmn_delegate_binding)
create a BPMN delegate binding

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_bpmn_delegate_binding** | [**NewBpmnDelegateBinding**](NewBpmnDelegateBinding.md) |  | [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)


## delete_bpmn_delegate_binding

> String delete_bpmn_delegate_binding(workspace, path)
delete a BPMN delegate binding

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


## get_bpmn_delegate_binding

> models::BpmnDelegateBinding get_bpmn_delegate_binding(workspace, path)
get a BPMN delegate binding by path

### Parameters


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

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: 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)


## import_bpmn_delegate_bindings

> models::ImportDelegateBindingsResult import_bpmn_delegate_bindings(workspace, new_bpmn_delegate_binding)
create or update many BPMN delegate bindings in one call

`bpmn delegates import`'s write side (#926). Upserts by `(key_kind, delegate_key)`, not by `path` -- a key that is already bound keeps its existing path and is updated in place, so importing the same file twice is idempotent rather than duplicate-accumulating. Requires admin, in addition to the same per-row authorization `create`/`update` apply: a whole-file import decides what an entire estate's delegates execute, not one element's.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_bpmn_delegate_binding** | [**Vec<models::NewBpmnDelegateBinding>**](NewBpmnDelegateBinding.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: 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)


## list_bpmn_delegate_bindings

> Vec<models::ListedBpmnDelegateBinding> list_bpmn_delegate_bindings(workspace, page, per_page)
list BPMN delegate bindings

### 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::ListedBpmnDelegateBinding>**](ListedBpmnDelegateBinding.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: 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)


## list_unbound_bpmn_delegates

> Vec<models::UnboundDelegateChecklistEntry> list_unbound_bpmn_delegates(workspace)
the unbound-delegate checklist -- every delegate key referenced somewhere in the workspace's deployed and draft BPMN definitions that has no binding yet

`bpmn delegates export`'s deliverable (#926). RLS-scoped like every other operation here: what a caller sees is exactly the set of bindings they would need to add for their own deploy to stop failing, not a workspace-wide list of everyone's models.

### Parameters


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

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: 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)


## update_bpmn_delegate_binding

> String update_bpmn_delegate_binding(workspace, path, new_bpmn_delegate_binding)
update a BPMN delegate binding

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**new_bpmn_delegate_binding** | [**NewBpmnDelegateBinding**](NewBpmnDelegateBinding.md) |  | [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)