forked from nitram509/lib-bpmn-engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
338 lines (332 loc) · 8.26 KB
/
api.yaml
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
openapi: 3.0.0
info:
title: BPMN Engine OpenAPI
description: REST API for lib-bpmn-engine
version: 0.1.0
servers:
- url: http://localhost:8080
tags:
- name: process-definitions
- name: process-instances
paths:
/process-definitions:
post:
operationId: createProcessDefinition
summary: Deploy a new process definition
tags:
- process-definitions
requestBody:
required: true
content:
application/xml:
schema:
type: string
format: xml
responses:
200:
description: Process definition deployed
content:
application/json:
schema:
type: object
properties:
processDefinitionKey:
type: string
get:
operationId: getProcessDefinitions
summary: Get list of process definitions
tags:
- process-definitions
responses:
200:
description: List of process definitions
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessDefinitionsPage"
/process-definitions/{processDefinitionKey}:
get:
operationId: getProcessDefinition
summary: Get process definition
tags:
- process-definitions
parameters:
- name: processDefinitionKey
required: true
in: path
schema:
type: integer
format: int64
responses:
200:
description: Process definition
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessDefinitionDetail"
/process-instances:
post:
operationId: createProcessInstance
summary: Create a new process instance
tags:
- process-instances
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- processDefinitionKey
properties:
processDefinitionKey:
type: string
variables:
type: object
responses:
200:
description: Process instance created
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessInstance"
/process-instances/:
get:
summary: Get list of running process instances
operationId: getProcessInstances
tags:
- process-instances
parameters:
- name: processDefinitionKey
in: query
schema:
type: integer
format: int64
- name: offset
in: query
schema:
type: integer
default: 0
- name: size
in: query
schema:
type: integer
default: 10
responses:
200:
description: List of running process instances
content:
application/json:
schema:
type: object
properties:
total:
type: integer
processInstances:
type: array
items:
$ref: "#/components/schemas/ProcessInstancePage"
/process-instances/{processInstanceKey}:
get:
operationId: getProcessInstance
tags:
- process-instances
summary: Get state of a process instance selected by processInstanceId
parameters:
- name: processInstanceKey
in: path
required: true
schema:
type: integer
format: int64
responses:
200:
description: State of a process instance
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessInstance"
/process-instances/{processInstanceKey}/jobs:
get:
operationId: getJobs
tags:
- process-instances
summary: Get list of jobs for a process instance
parameters:
- name: processInstanceKey
in: path
required: true
schema:
type: integer
format: int64
responses:
200:
description: List of jobs
content:
application/json:
schema:
$ref: "#/components/schemas/JobPage"
/process-instances/{processInstanceKey}/activities:
get:
operationId: getActivities
tags:
- process-instances
summary: Get list of activities for a process instance
parameters:
- name: processInstanceKey
in: path
required: true
schema:
type: integer
format: int64
responses:
200:
description: List of activities
content:
application/json:
schema:
$ref: "#/components/schemas/ActivityPage"
/jobs:
post:
operationId: completeJob
tags:
- jobs
summary: Complete a job
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jobKey
properties:
jobKey:
type: string
responses:
201:
description: Job completed
components:
schemas:
PageMetadata:
type: object
properties:
offset:
type: integer
size:
type: integer
count:
type: integer
ProcessDefinitionsPage:
type: object
allOf:
- type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/ProcessDefinitionSimple"
- $ref: "#/components/schemas/PageMetadata"
ProcessDefinitionSimple:
type: object
properties:
key:
type: string
version:
type: integer
bpmnProcessId:
type: string
ProcessDefinitionDetail:
type: object
allOf:
- $ref: "#/components/schemas/ProcessDefinitionSimple"
- type: object
properties:
bpmnData:
type: string
ProcessInstancePage:
type: object
allOf:
- type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/ProcessInstance"
- $ref: "#/components/schemas/PageMetadata"
ProcessInstance:
type: object
properties:
key:
type: string
processDefinitionKey:
type: string
createdAt:
type: string
format: date-time
state:
type: string
enum:
- active
- completed
- terminated
variableHolder:
type: string
caughtEvents:
type: string
activities:
type: string
JobPage:
type: object
allOf:
- type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Job"
- $ref: "#/components/schemas/PageMetadata"
Job:
type: object
properties:
key:
type: string
elementId:
type: string
elementInstanceKey:
type: string
processInstanceKey:
type: string
state:
type: string
createdAt:
type: string
format: date-time
ActivityPage:
type: object
allOf:
- type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Activity"
- $ref: "#/components/schemas/PageMetadata"
Activity:
type: object
properties:
key:
type: string
processInstanceKey:
type: string
processDefinitionKey:
type: string
createdAt:
type: string
format: date-time
state:
type: string
elementId:
type: string
bpmnElementType:
type: string