@5minds/processcube_engine_client 5.0.0-beta.4 → 5.0.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. package/dist/Client.d.ts +2 -0
  2. package/dist/ClientFactory.d.ts +2 -1
  3. package/dist/Clients/AnonymousSessionHttpClient.d.ts +13 -0
  4. package/dist/Clients/index.d.ts +1 -0
  5. package/dist/commonjs/Client.js +23 -1
  6. package/dist/commonjs/Client.js.map +1 -1
  7. package/dist/commonjs/ClientFactory.js +9 -6
  8. package/dist/commonjs/ClientFactory.js.map +1 -1
  9. package/dist/commonjs/Clients/AnonymousSessionHttpClient.js +35 -0
  10. package/dist/commonjs/Clients/AnonymousSessionHttpClient.js.map +1 -0
  11. package/dist/commonjs/Clients/BaseClient.js +11 -9
  12. package/dist/commonjs/Clients/BaseClient.js.map +1 -1
  13. package/dist/commonjs/Clients/CorrelationHttpClient.js +7 -7
  14. package/dist/commonjs/Clients/CorrelationHttpClient.js.map +1 -1
  15. package/dist/commonjs/Clients/CronjobHttpClient.js +2 -2
  16. package/dist/commonjs/Clients/CronjobHttpClient.js.map +1 -1
  17. package/dist/commonjs/Clients/DataObjectInstanceHttpClient.js +2 -2
  18. package/dist/commonjs/Clients/DataObjectInstanceHttpClient.js.map +1 -1
  19. package/dist/commonjs/Clients/EventHttpClient.js +19 -19
  20. package/dist/commonjs/Clients/EventHttpClient.js.map +1 -1
  21. package/dist/commonjs/Clients/ExternalTaskApiHttpClient.js +1 -1
  22. package/dist/commonjs/Clients/ExternalTaskApiHttpClient.js.map +1 -1
  23. package/dist/commonjs/Clients/ExternalTaskHttpClient.js +2 -0
  24. package/dist/commonjs/Clients/ExternalTaskHttpClient.js.map +1 -1
  25. package/dist/commonjs/Clients/FlowNodeInstanceHttpClient.js +10 -10
  26. package/dist/commonjs/Clients/FlowNodeInstanceHttpClient.js.map +1 -1
  27. package/dist/commonjs/Clients/Lib/SocketIoManager.js +28 -4
  28. package/dist/commonjs/Clients/Lib/SocketIoManager.js.map +1 -1
  29. package/dist/commonjs/Clients/ManualTaskHttpClient.js +4 -4
  30. package/dist/commonjs/Clients/ManualTaskHttpClient.js.map +1 -1
  31. package/dist/commonjs/Clients/NotificationHttpClient.js +50 -50
  32. package/dist/commonjs/Clients/NotificationHttpClient.js.map +1 -1
  33. package/dist/commonjs/Clients/ProcessDefinitionHttpClient.js +5 -5
  34. package/dist/commonjs/Clients/ProcessDefinitionHttpClient.js.map +1 -1
  35. package/dist/commonjs/Clients/ProcessDefinitionHttpClientNode.js +24 -1
  36. package/dist/commonjs/Clients/ProcessDefinitionHttpClientNode.js.map +1 -1
  37. package/dist/commonjs/Clients/ProcessInstanceHttpClient.js +10 -12
  38. package/dist/commonjs/Clients/ProcessInstanceHttpClient.js.map +1 -1
  39. package/dist/commonjs/Clients/ProcessModelHttpClient.js +8 -8
  40. package/dist/commonjs/Clients/ProcessModelHttpClient.js.map +1 -1
  41. package/dist/commonjs/Clients/UntypedTaskHttpClient.js +8 -8
  42. package/dist/commonjs/Clients/UntypedTaskHttpClient.js.map +1 -1
  43. package/dist/commonjs/Clients/UserTaskHttpClient.js +6 -6
  44. package/dist/commonjs/Clients/UserTaskHttpClient.js.map +1 -1
  45. package/dist/commonjs/Clients/index.js +1 -0
  46. package/dist/commonjs/Clients/index.js.map +1 -1
  47. package/dist/commonjs/ExternalTaskWorker.js +42 -11
  48. package/dist/commonjs/ExternalTaskWorker.js.map +1 -1
  49. package/dist/commonjs/HttpClient.js +10 -7
  50. package/dist/commonjs/HttpClient.js.map +1 -1
  51. package/dist/commonjs/Types/index.js +13 -1
  52. package/dist/commonjs/Types/index.js.map +1 -1
  53. package/package.json +3 -5
  54. package/dist/amd/Client.js +0 -94
  55. package/dist/amd/Client.js.map +0 -1
  56. package/dist/amd/ClientFactory.js +0 -52
  57. package/dist/amd/ClientFactory.js.map +0 -1
  58. package/dist/amd/Clients/ApplicationInfoHttpClient.js +0 -30
  59. package/dist/amd/Clients/ApplicationInfoHttpClient.js.map +0 -1
  60. package/dist/amd/Clients/BaseClient.js +0 -128
  61. package/dist/amd/Clients/BaseClient.js.map +0 -1
  62. package/dist/amd/Clients/CorrelationHttpClient.js +0 -29
  63. package/dist/amd/Clients/CorrelationHttpClient.js.map +0 -1
  64. package/dist/amd/Clients/CronjobHttpClient.js +0 -29
  65. package/dist/amd/Clients/CronjobHttpClient.js.map +0 -1
  66. package/dist/amd/Clients/DataObjectInstanceHttpClient.js +0 -19
  67. package/dist/amd/Clients/DataObjectInstanceHttpClient.js.map +0 -1
  68. package/dist/amd/Clients/EventHttpClient.js +0 -71
  69. package/dist/amd/Clients/EventHttpClient.js.map +0 -1
  70. package/dist/amd/Clients/ExternalTaskApiHttpClient.js +0 -60
  71. package/dist/amd/Clients/ExternalTaskApiHttpClient.js.map +0 -1
  72. package/dist/amd/Clients/ExternalTaskHttpClient.js +0 -27
  73. package/dist/amd/Clients/ExternalTaskHttpClient.js.map +0 -1
  74. package/dist/amd/Clients/FlowNodeInstanceHttpClient.js +0 -60
  75. package/dist/amd/Clients/FlowNodeInstanceHttpClient.js.map +0 -1
  76. package/dist/amd/Clients/Lib/Mappers.js +0 -288
  77. package/dist/amd/Clients/Lib/Mappers.js.map +0 -1
  78. package/dist/amd/Clients/Lib/SocketIoManager.js +0 -112
  79. package/dist/amd/Clients/Lib/SocketIoManager.js.map +0 -1
  80. package/dist/amd/Clients/ManualTaskHttpClient.js +0 -38
  81. package/dist/amd/Clients/ManualTaskHttpClient.js.map +0 -1
  82. package/dist/amd/Clients/NotificationHttpClient.js +0 -165
  83. package/dist/amd/Clients/NotificationHttpClient.js.map +0 -1
  84. package/dist/amd/Clients/ProcessDefinitionHttpClient.js +0 -92
  85. package/dist/amd/Clients/ProcessDefinitionHttpClient.js.map +0 -1
  86. package/dist/amd/Clients/ProcessDefinitionHttpClientNode.js +0 -25
  87. package/dist/amd/Clients/ProcessDefinitionHttpClientNode.js.map +0 -1
  88. package/dist/amd/Clients/ProcessInstanceHttpClient.js +0 -91
  89. package/dist/amd/Clients/ProcessInstanceHttpClient.js.map +0 -1
  90. package/dist/amd/Clients/ProcessModelHttpClient.js +0 -93
  91. package/dist/amd/Clients/ProcessModelHttpClient.js.map +0 -1
  92. package/dist/amd/Clients/UntypedTaskHttpClient.js +0 -49
  93. package/dist/amd/Clients/UntypedTaskHttpClient.js.map +0 -1
  94. package/dist/amd/Clients/UserTaskHttpClient.js +0 -56
  95. package/dist/amd/Clients/UserTaskHttpClient.js.map +0 -1
  96. package/dist/amd/Clients/index.js +0 -35
  97. package/dist/amd/Clients/index.js.map +0 -1
  98. package/dist/amd/ExternalTaskWorker.js +0 -141
  99. package/dist/amd/ExternalTaskWorker.js.map +0 -1
  100. package/dist/amd/HttpClient.js +0 -128
  101. package/dist/amd/HttpClient.js.map +0 -1
  102. package/dist/amd/Types/CallbackTypes.js +0 -5
  103. package/dist/amd/Types/CallbackTypes.js.map +0 -1
  104. package/dist/amd/Types/IExternalTaskWorker.js +0 -5
  105. package/dist/amd/Types/IExternalTaskWorker.js.map +0 -1
  106. package/dist/amd/Types/RestSettings.js +0 -702
  107. package/dist/amd/Types/RestSettings.js.map +0 -1
  108. package/dist/amd/Types/SocketSettings.js +0 -77
  109. package/dist/amd/Types/SocketSettings.js.map +0 -1
  110. package/dist/amd/Types/index.js +0 -30
  111. package/dist/amd/Types/index.js.map +0 -1
  112. package/dist/amd/index.js +0 -29
  113. package/dist/amd/index.js.map +0 -1
@@ -1,702 +0,0 @@
1
- define(["require", "exports"], function (require, exports) {
2
- "use strict";
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.restSettings = void 0;
5
- const params = {
6
- // Id of a Correlation.
7
- correlationId: ':correlation_id',
8
- // Instance Id of an UntypedTask.
9
- untypedTaskInstanceId: ':untyped_task_instance_id',
10
- // Deprecated version of "untypedTaskInstanceId"
11
- emptyActivityInstanceId: ':empty_activity_instance_id',
12
- // Id of an Event.
13
- eventId: ':event_id',
14
- // Name of an Event.
15
- eventName: ':event_name',
16
- // Id of an External Task.
17
- externalTaskId: ':external_task_id',
18
- // Id of a FlowNode.
19
- flowNodeId: ':flow_node_id',
20
- // Id of a FlowNodeInstance.
21
- flowNodeInstanceId: ':flow_node_instance_id',
22
- // Id of a ManualTask.
23
- manualTaskInstanceId: ':manual_task_instance_id',
24
- // Instance Id of a Process.
25
- processInstanceId: ':process_instance_id',
26
- // Id of a ProcessModel.
27
- processDefinitionId: ':process_definition_id',
28
- // Id of a ProcessModel.
29
- processModelId: ':process_model_id',
30
- // Id of an anonymous session.
31
- sessionId: ':session_id',
32
- // Id of a user.
33
- userId: ':user_id',
34
- // Id of a UserTaskInstance.
35
- userTaskInstanceId: ':user_task_instance_id',
36
- // Key of a metadata value
37
- userMetadataKey: ':user_metadata_key',
38
- };
39
- const paths = {
40
- // ApplicationInfo
41
- /**
42
- * Gets some basic info about the host application.
43
- * @tags ApplicationInfo
44
- * @method get
45
- * @responseType ApplicationInfo
46
- */
47
- getApplicationInfo: '/info',
48
- /**
49
- * Gets the address of the authority that the host application uses for claim checks.
50
- * @tags ApplicationInfo
51
- * @method get
52
- * @responseType string
53
- */
54
- getAuthorityAddress: '/authority',
55
- // Anonymous Sessions
56
- /**
57
- * Returns the anonymous session with the given ID.
58
- * @tags AnonymousSessions
59
- * @method get
60
- * @responseType AnonymousSession
61
- */
62
- getAnonymousSessionById: `/anonymous_session/session/${params.sessionId}`,
63
- /**
64
- * Returns all anonymous sessions of the given User ID.
65
- * @tags AnonymousSessions
66
- * @method get
67
- * @responseType Array<AnonymousSession>
68
- */
69
- getAnonymousSessionsByUserId: `/anonymous_session/user/${params.userId}`,
70
- /**
71
- * Creates a new anonymous session and returns its ID.
72
- * @tags AnonymousSessions
73
- * @method post
74
- * @responseType string
75
- */
76
- createAnonymousSession: '/anonymous_session',
77
- // Correlations
78
- /**
79
- * Gets all Correlations.
80
- * @tags Correlations
81
- * @method get
82
- * @queryParams limit: number, offset: number, includeProcessInstances: boolean
83
- * @responseType CorrelationList
84
- */
85
- getCorrelations: '/correlations',
86
- /**
87
- * Gets a Correlation by its ID.
88
- * @tags Correlations
89
- * @method get
90
- * @queryParams includeProcessInstances: boolean
91
- * @responseType Correlation
92
- */
93
- getCorrelationById: `/correlations/${params.correlationId}`,
94
- // Cronjobs
95
- /**
96
- * Queries a list of deployed Cronjobs.
97
- * @tags Cronjobs
98
- * @method get
99
- * @queryParams limit: number, offset: number, processDefinitionId: string, processModelID: string, startEventId: string, crontab: string, nextExecution: string
100
- * @responseType DeployedCronjobList
101
- */
102
- getDeployedCronjobs: '/cronjobs/query',
103
- /**
104
- * Enables the given Cronjob for the given Process Model.
105
- * @tags ProcessModels
106
- * @method post
107
- */
108
- enableCronjob: `/cronjobs/process_models/${params.processModelId}/flow_node/${params.flowNodeId}/enable`,
109
- /**
110
- * Disables the given Cronjob for the given ProcessModel.
111
- * @tags ProcessModels
112
- * @method post
113
- */
114
- disableCronjob: `/cronjobs/process_models/${params.processModelId}/flow_node/${params.flowNodeId}/disable`,
115
- // DataObjects
116
- /**
117
- * Gets the DataObjectInstances that match the given query.
118
- * @tags DataObjectInstances
119
- * @method get
120
- * @queryParams limit: number, offset: number: string, dataObjectId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, flowNodeInstanceId: string, createdAt: string
121
- * @responseType DataObjectInstanceList
122
- */
123
- getDataObjects: '/data_object_instances/query',
124
- // FlowNodeInstance
125
- /**
126
- * Gets all FlowNodeInstances that match the given query.
127
- * @tags FlowNodeInstances
128
- * @method get
129
- * @queryParams limit: number, offset: number, flowNodeInstanceId: string, flowNodeId: string, flowNodeName: string, flowNodeLane: string, flowNodeType: string, eventType: string, correlationId: string, processDefinitionId: string, processModelId: string, processInstanceId: string, ownerId: string, state: string, previousFlowNodeInstanceId: string, parentProcessInstanceId: string, createdAt: string, updatedAt: string, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
130
- * @responseType FlowNodeInstanceList
131
- */
132
- queryFlowNodeInstances: '/flow_node_instances',
133
- /**
134
- * Triggers a MessageEvent by its name.
135
- * @tags Events
136
- * @queryParams processInstanceId: string
137
- * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"payload": {"type": "string"}}}
138
- * @method post
139
- */
140
- triggerMessageEvent: `/messages/${params.eventName}/trigger`,
141
- /**
142
- * Triggers a SignalEvent by its name.
143
- * @tags Events
144
- * @method post
145
- * @queryParams process_instance_id: string
146
- * @requestBody {"required": false, "bodyType": "application/json", "contentType": {}}
147
- */
148
- triggerSignalEvent: `/signals/${params.eventName}/trigger`,
149
- /**
150
- * Finishes a specific EmptyActivity by its InstanceId. Deprecated, use "finish Untyped Task" instead
151
- * @tags EmptyActivity
152
- * @deprecated
153
- * @method put
154
- */
155
- finishEmptyActivity: `/empty_activities/${params.emptyActivityInstanceId}/finish`,
156
- /**
157
- * Finishes a specific UntypedTask by its InstanceId.
158
- * @tags UntypedTask
159
- * @method put
160
- */
161
- finishUntypedTask: `/untyped_tasks/${params.untypedTaskInstanceId}/finish`,
162
- /**
163
- * Finishes a specific ManualTask by its ManualTaskInstanceId.
164
- * @tags ManualTasks
165
- * @method put
166
- */
167
- finishManualTask: `/manual_tasks/${params.manualTaskInstanceId}/finish`,
168
- /**
169
- * Finishes a specific UserTask by its UserTaskInstanceId.
170
- * @tags UserTasks
171
- * @method put
172
- */
173
- finishUserTask: `/user_tasks/${params.userTaskInstanceId}/finish`,
174
- /**
175
- * Reserves a UserTask for a specific User.
176
- * @tags UserTasks
177
- * @method put
178
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"actualOwnerId": {"type": "string", "required": true}}}
179
- */
180
- reserveUserTaskInstance: `/user_tasks/${params.userTaskInstanceId}/reserve`,
181
- /**
182
- * Cancels the reservation of the given UserTask instance.
183
- * @tags UserTasks
184
- * @method delete
185
- */
186
- cancelUserTaskInstanceReservation: `/user_tasks/${params.userTaskInstanceId}/cancel-reservation`,
187
- // External Tasks
188
- /**
189
- * Fetches a list of all ExternalTask topics from all deployed Process Models.
190
- * @tags ExternalTasks
191
- * @method get
192
- * @responseType Array<string>
193
- */
194
- getAllDeployedTopics: '/external_tasks/deployed_topics',
195
- /**
196
- * Fetches the tasks available for an ExternalTaskWorker and locks them for a defined time.
197
- * @tags ExternalTasks
198
- * @method post
199
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FetchAndLockRequestPayload", "example": "{\"workerId\": \"string\", \"topicName\": \"string | Array<string>\", \"maxTasks\": 10, \"longPollingTimeout\": 2000, \"lockDuration\": 10000, \"payloadFilter\": \"string\"}"}
200
- * @responseType Array<ExternalTask>
201
- */
202
- fetchAndLockExternalTasks: '/external_tasks/fetch_and_lock',
203
- /**
204
- * Extends the lock duration of an ExternalTask by a given amount of time.
205
- * @tags ExternalTasks
206
- * @method put
207
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ExtendLockRequestPayload"}
208
- */
209
- extendExternalTaskLock: `/external_tasks/${params.externalTaskId}/extend_lock`,
210
- /**
211
- * Finishes the given External Task with the given Error.
212
- * @tags ExternalTasks
213
- * @method put
214
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "HandleServiceErrorRequestPayload"}
215
- */
216
- finishExternalTaskWithError: `/external_tasks/${params.externalTaskId}/error`,
217
- /**
218
- * Finishes the ExternalTask with the given ID.
219
- * @tags ExternalTasks
220
- * @method put
221
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "FinishExternalTaskRequestPayload"}
222
- */
223
- finishExternalTask: `/external_tasks/${params.externalTaskId}/finish`,
224
- // ProcessDefinition
225
- /**
226
- * Creates or updates a ProcessDefinition or a list of ProcessDefinitions.
227
- * @tags ProcessDefinitions
228
- * @method post
229
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "PersistProcessDefinitionsPayload", "example": "{\"xml\": \"string | Array<string>\", \"overrideExisting\": true}"}
230
- */
231
- persistProcessDefinitions: '/process_definitions',
232
- /**
233
- * Gets all ProcessDefinitions the requesting user is allowed to see.
234
- * @tags ProcessDefinitions
235
- * @method get
236
- * @queryParams offset: number, limit: number
237
- * @responseType ProcessDefinitionList
238
- */
239
- getProcessDefinitions: '/process_definitions',
240
- /**
241
- * Gets a ProcessDefinition by its id.
242
- * @tags ProcessDefinitions
243
- * @method get
244
- * @responseType ProcessDefinition
245
- */
246
- getProcessDefinitionById: `/process_definitions/${params.processDefinitionId}`,
247
- /**
248
- * Deletes the ProcessDefinition with the given ID.
249
- * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
250
- * @tags ProcessDefinitions
251
- * @method delete
252
- * @queryParams delete_all_related_data: boolean
253
- */
254
- deleteProcessDefinition: `/process_definitions/${params.processDefinitionId}`,
255
- // ProcessModels
256
- /**
257
- * Gets all currently deployed Process Models.
258
- * @tags ProcessModels
259
- * @method get
260
- * @responseType ProcessModelList
261
- */
262
- getAllProcessModels: '/process_models',
263
- /**
264
- * Gets a deployed Process Model by its ID.
265
- * @tags ProcessModels
266
- * @method get
267
- * @responseType ProcessModel
268
- */
269
- getProcessModelById: `/process_models/${params.processModelId}/`,
270
- /**
271
- * Gets a ProcessDefinition for a given ProcessModel.
272
- * @tags ProcessModels
273
- * @method get
274
- * @responseType ProcessDefinition
275
- */
276
- getProcessDefinitionForProcessModel: `/process_models/${params.processModelId}/process_definition`,
277
- /**
278
- * Starts a new instance from the given set of parameters.
279
- * @tags ProcessModels
280
- * @method post
281
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": "ProcessStartRequest"}
282
- * @responseType ProcessStartResponse
283
- */
284
- startProcessInstance: `/process_models/${params.processModelId}/start`,
285
- /**
286
- * Deletes the ProcessDefinition that contains the Process Model with the given ID.
287
- * Per default, a Process is only flagged as deleted. To actually delete the Process and all related data, set "delete_all_related_data" to "true".
288
- * @tags ProcessModels
289
- * @method delete
290
- * @queryParams delete_all_related_data: boolean
291
- */
292
- deleteProcessDefinitionByProcessModelId: `/process_models/${params.processModelId}`,
293
- /**
294
- * Enables the given Process Model.
295
- * @tags ProcessModels
296
- * @method post
297
- */
298
- enableProcessModel: `/process_models/${params.processModelId}/enable`,
299
- /**
300
- * Disables the given Process Model.
301
- * @tags ProcessModels
302
- * @method post
303
- */
304
- disableProcessModel: `/process_models/${params.processModelId}/disable`,
305
- // ProcessInstance
306
- /**
307
- * Gets all ProcessInstances that match the given query.
308
- * @tags ProcessInstances
309
- * @method get
310
- * @queryParams offset: number, limit: number, correlationId: Array<string> | string | SearchQuery, processInstanceId: Array<string> | string | SearchQuery, processDefinitionId: Array<string> | string | SearchQuery, processModelId: Array<string> | string | SearchQuery, processModelName: Array<string> | string | SearchQuery, processModelHash: Array<string> | string | SearchQuery, ownerId: Array<string> | string | SearchQuery, state: Array<string> | string | SearchQuery, parentProcessInstanceId: Array<string> | string | SearchQuery, terminatedByUserId: Array<string> | string | SearchQuery, createdBefore: Date, createdAt: Array<Date> | Date, createdAfter: Date, updatedBefore: Date, updatedAt: Array<Date> | Date, updatedAfter: Date, finishedBefore: Date, finishedAt: Array<Date> | Date, finishedAfter: Date, triggeredByFlowNodeInstance: Array<string> | string | SearchQuery
311
- * @responseType ProcessInstanceList
312
- */
313
- queryProcessInstances: '/process_instances/query',
314
- /**
315
- * Gets the ProcessDefinition for a given ProcessInstance.
316
- * @tags ProcessInstances
317
- * @method get
318
- * @responseType ProcessDefinition
319
- */
320
- getProcessDefinitionForProcessInstance: `/process_instances/${params.processInstanceId}/process_definition`,
321
- /**
322
- * Gets the ProcessModel for a given ProcessInstance.
323
- * @tags ProcessInstances
324
- * @method get
325
- * @responseType ProcessModel
326
- */
327
- getProcessModelForProcessInstance: `/process_instances/${params.processInstanceId}/process_model`,
328
- /**
329
- * Changes the owner of the ProcessInstance with the given ID.
330
- * @tags ProcessInstances
331
- * @method post
332
- * @requestBody {"required": true, "bodyType": "application/json", "contentType": {"newOwner": {"type": "Identity"}}}
333
- */
334
- changeProcessInstanceOwner: `/process_instances/${params.processInstanceId}/change_owner`,
335
- /**
336
- * Terminates the ProcessInstance with the given ID.
337
- * @tags ProcessInstances
338
- * @method put
339
- */
340
- terminateProcessInstances: `/process_instances/${params.processInstanceId}/terminate`,
341
- /**
342
- * Retries a failed or terminated Process Instance from the original point of failure.
343
- * Alternatively, the Process Instance can be reset to a specific flow Node Instance, provided with the "flow_node_instance_id" Query parameter
344
- * @tags ProcessInstances
345
- * @method put
346
- * @queryParams flow_node_instance_id: string
347
- * @requestBody {"required": false, "bodyType": "application/json", "contentType": {"newStartToken": {"type": "object"}}}
348
- */
349
- retryProcessInstance: `/process_instances/${params.processInstanceId}/retry`,
350
- /**
351
- * Deletes the given Set of Process Instances. Multiple ProcessInstanceIds can be provided with ";" as separator.
352
- * Per default, a Process Instance is only flagged as deleted. To actually delete the Process Instances and all related data, set "delete_all_related_data" to "true".
353
- * @tags ProcessInstances
354
- * @method delete
355
- * @queryParams process_instance_ids: string | Array<string>, delete_all_related_data: boolean
356
- */
357
- deleteProcessInstances: `/process_instances`,
358
- // UserMetadataStorage
359
- /**
360
- * Queries all values by the given keys
361
- * @tags UserMetadata
362
- * @method get
363
- * @queryParams keys: string | Array<string>
364
- */
365
- queryUserMetadata: '/user_metadata/query',
366
- /**
367
- * Gets a value by the given key
368
- * @tags UserMetadata
369
- * @method get
370
- */
371
- getUserMetadata: `/user_metadata/${params.userMetadataKey}`,
372
- /**
373
- * Sets a value for the given key
374
- * @tags UserMetadata
375
- * @method post
376
- */
377
- setUserMetadata: `/user_metadata/${params.userMetadataKey}`,
378
- /**
379
- * Removes a value for the given key
380
- * @tags UserMetadata
381
- * @method delete
382
- */
383
- removeUserMetadata: `/user_metadata/${params.userMetadataKey}`,
384
- // Long Polling Notifications
385
- /**
386
- * Wait for a CronjobCreated notification and resolves with the notification's content.
387
- * @tags Notifications
388
- * @method get
389
- * @responseType CronjobEventMessage
390
- */
391
- onCronjobCreated: '/notifications/long_polling/cronjob_created',
392
- /**
393
- * Wait for a CronjobExecuted notification and resolves with the notification's content.
394
- * @tags Notifications
395
- * @method get
396
- * @responseType CronjobEventMessage
397
- */
398
- onCronjobExecuted: '/notifications/long_polling/cronjob_executed',
399
- /**
400
- * Wait for a CronjobStopped notification and resolves with the notification's content.
401
- * @tags Notifications
402
- * @method get
403
- * @responseType CronjobEventMessage
404
- */
405
- onCronjobStopped: '/notifications/long_polling/cronjob_stopped',
406
- /**
407
- * Wait for a CronjobUpdated notification and resolves with the notification's content.
408
- * @tags Notifications
409
- * @method get
410
- * @responseType CronjobEventMessage
411
- */
412
- onCronjobUpdated: '/notifications/long_polling/cronjob_updated',
413
- /**
414
- * Wait for a CronjobRemoved notification and resolves with the notification's content.
415
- * @tags Notifications
416
- * @method get
417
- * @responseType CronjobEventMessage
418
- */
419
- onCronjobRemoved: '/notifications/long_polling/cronjob_removed',
420
- /**
421
- * Wait for a ProcessDeployed notification and resolves with the notification's content.
422
- * @tags Notifications
423
- * @method get
424
- * @responseType ProcessDeploymentMessage
425
- */
426
- onProcessDeployed: '/notifications/long_polling/process_deployed',
427
- /**
428
- * Wait for a ProcessIsExecutableChanged notification and resolves with the notification's content.
429
- * @tags Notifications
430
- * @method get
431
- * @responseType ProcessIsExecutableChangedMessage
432
- */
433
- onProcessIsExecutableChanged: '/notifications/long_polling/process_is_executable_changed',
434
- /**
435
- * Wait for a CronjobEnabledChanged notification and resolves with the notification's content.
436
- * @tags Notifications
437
- * @method get
438
- * @responseType CronjobEnabledChangedMessage
439
- */
440
- onCronjobEnabledChanged: '/notifications/long_polling/cronjob_enabled_changed',
441
- /**
442
- * Wait for a ProcessUndeployed notification and resolves with the notification's content.
443
- * @tags Notifications
444
- * @method get
445
- * @responseType ProcessDeploymentMessage
446
- */
447
- onProcessUndeployed: '/notifications/long_polling/process_undeployed',
448
- /**
449
- * Wait for a ProcessStarting notification and resolves with the notification's content.
450
- * @tags Notifications
451
- * @method get
452
- * @responseType EventMessage
453
- */
454
- onProcessStarting: '/notifications/long_polling/process_starting',
455
- /**
456
- * Wait for a ProcessStarted notification and resolves with the notification's content.
457
- * @tags Notifications
458
- * @method get
459
- * @responseType EventMessage
460
- */
461
- onProcessStarted: '/notifications/long_polling/process_started',
462
- /**
463
- * Wait for a ProcessResumed notification and resolves with the notification's content.
464
- * @tags Notifications
465
- * @method get
466
- * @responseType EventMessage
467
- */
468
- onProcessResumed: '/notifications/long_polling/process_resumed',
469
- /**
470
- * Wait for a ProcessEnded notification and resolves with the notification's content.
471
- * @tags Notifications
472
- * @method get
473
- * @responseType EventMessage
474
- */
475
- onProcessEnded: '/notifications/long_polling/process_ended',
476
- /**
477
- * Wait for a ProcessOwnerChanged notification and resolves with the notification's content.
478
- * @tags Notifications
479
- * @method get
480
- * @responseType EventMessage
481
- */
482
- onProcessOwnerChanged: '/notifications/long_polling/process_owner_changed',
483
- /**
484
- * Wait for a ProcessTerminated notification and resolves with the notification's content.
485
- * @tags Notifications
486
- * @method get
487
- * @responseType EventMessage
488
- */
489
- onProcessTerminated: '/notifications/long_polling/process_terminated',
490
- /**
491
- * Wait for a ProcessError notification and resolves with the notification's content.
492
- * @tags Notifications
493
- * @method get
494
- * @responseType EventMessage
495
- */
496
- onProcessError: '/notifications/long_polling/process_error',
497
- /**
498
- * Wait for a ProcessInstancesDeleted notification and resolves with the notification's content.
499
- * @tags Notifications
500
- * @method get
501
- * @responseType EventMessage
502
- */
503
- onProcessInstancesDeleted: '/notifications/long_polling/process_instances_deleted',
504
- /**
505
- * Wait for an ExternalTaskCreated notification and resolves with the notification's content.
506
- * @tags Notifications
507
- * @method get
508
- * @responseType ExternalTaskCreatedMessage
509
- */
510
- onExternalTaskCreated: '/notifications/long_polling/external_task_created',
511
- /**
512
- * Wait for a ExternalTaskLocked notification and resolves with the notification's content.
513
- * @tags Notifications
514
- * @method get
515
- * @responseType ExternalTaskLockedMessage
516
- */
517
- onExternalTaskLocked: '/notifications/long_polling/external_task_locked',
518
- /**
519
- * Wait for a ExternalTaskUnlocked notification and resolves with the notification's content.
520
- * @tags Notifications
521
- * @method get
522
- * @responseType ExternalTaskUnlockedMessage
523
- */
524
- onExternalTaskUnlocked: '/notifications/long_polling/external_task_unlocked',
525
- /**
526
- * Wait for a ExternalTaskExpired notification and resolves with the notification's content.
527
- * @tags Notifications
528
- * @method get
529
- * @responseType ExternalTaskExpiredMessage
530
- */
531
- onExternalTaskExpired: '/notifications/long_polling/external_task_expired',
532
- /**
533
- * Wait for an ActivityReached notification and resolves with the notification's content.
534
- * @tags Notifications
535
- * @method get
536
- * @responseType EventMessage
537
- */
538
- onActivityReached: '/notifications/long_polling/activity_reached',
539
- /**
540
- * Wait for an ActivityFinished notification and resolves with the notification's content.
541
- * @tags Notifications
542
- * @method get
543
- * @responseType EventMessage
544
- */
545
- onActivityFinished: '/notifications/long_polling/activity_finished',
546
- /**
547
- * Wait for an ActivityCanceled notification and resolves with the notification's content.
548
- * @tags Notifications
549
- * @method get
550
- * @responseType EventMessage
551
- */
552
- onActivityCanceled: '/notifications/long_polling/activity_canceled',
553
- /**
554
- * Wait for an UntypedTaskWaiting notification and resolves with the notification's content.
555
- * @tags Notifications
556
- * @method get
557
- * @responseType EventMessage
558
- */
559
- onUntypedTaskWaiting: '/notifications/long_polling/empty_activity_waiting',
560
- /**
561
- * Wait for an UntypedTaskFinished notification and resolves with the notification's content.
562
- * @tags Notifications
563
- * @method get
564
- * @responseType EventMessage
565
- */
566
- onUntypedTaskFinished: '/notifications/long_polling/empty_activity_finished',
567
- /**
568
- * Wait for a ManualTaskWaiting notification and resolves with the notification's content.
569
- * @tags Notifications
570
- * @method get
571
- * @responseType EventMessage
572
- */
573
- onManualTaskWaiting: '/notifications/long_polling/manual_task_waiting',
574
- /**
575
- * Wait for a ManualTaskFinied notification and resolves with the notification's content.
576
- * @tags Notifications
577
- * @method get
578
- * @responseType EventMessage
579
- */
580
- onManualTaskFinished: '/notifications/long_polling/manual_task_finished',
581
- /**
582
- * Wait for a UserTaskWaiting notification and resolves with the notification's content.
583
- * @tags Notifications
584
- * @method get
585
- * @responseType EventMessage
586
- */
587
- onUserTaskWaiting: '/notifications/long_polling/user_task_waiting',
588
- /**
589
- * Wait for a UserTaskFinished notification and resolves with the notification's content.
590
- * @tags Notifications
591
- * @method get
592
- * @responseType EventMessage
593
- */
594
- onUserTaskFinished: '/notifications/long_polling/user_task_finished',
595
- /**
596
- * Wait for a UserTaskReserved notification and resolves with the notification's content.
597
- * @tags Notifications
598
- * @method get
599
- * @responseType EventMessage
600
- */
601
- onUserTaskReserved: '/notifications/long_polling/user_task_reserved',
602
- /**
603
- * Wait for a UserTaskReservationCanceled notification and resolves with the notification's content.
604
- * @tags Notifications
605
- * @method get
606
- * @responseType EventMessage
607
- */
608
- onUserTaskReservationCanceled: '/notifications/long_polling/user_task_reservation_canceled',
609
- /**
610
- * Wait for a BoundaryEventTriggered notification and resolves with the notification's content.
611
- * @tags Notifications
612
- * @method get
613
- * @responseType EventMessage
614
- */
615
- onBoundaryEventTriggered: '/notifications/long_polling/boundary_event_triggered',
616
- /**
617
- * Wait for a BoundaryEventFinished notification and resolves with the notification's content.
618
- * @tags Notifications
619
- * @method get
620
- * @responseType EventMessage
621
- */
622
- onBoundaryEventFinished: '/notifications/long_polling/boundary_event_finished',
623
- /**
624
- * Wait for an IntermediateThrowEventTriggered notification and resolves with the notification's content.
625
- * @tags Notifications
626
- * @method get
627
- * @responseType EventMessage
628
- */
629
- onIntermediateThrowEventTriggered: '/notifications/long_polling/intermediate_throw_event_triggered',
630
- /**
631
- * Wait for an IntermediateCatchEventReached notification and resolves with the notification's content.
632
- * @tags Notifications
633
- * @method get
634
- * @responseType EventMessage
635
- */
636
- onIntermediateCatchEventReached: '/notifications/long_polling/intermediate_catch_event_reached',
637
- /**
638
- *
639
- * Wait for a IntermediateCatchEventFinished notification and resolves with the notification's content.
640
- * @tags Notifications
641
- * @method get
642
- * @responseType EventMessage
643
- */
644
- onIntermediateCatchEventFinished: '/notifications/long_polling/intermediate_catch_event_finished',
645
- /**
646
- *
647
- * Wait for a FlowNodeEventRetrySending notification and resolves with the notification's content.
648
- * @tags Notifications
649
- * @method get
650
- * @responseType EventMessage
651
- */
652
- onFlowNodeEventRetrySending: '/notifications/long_polling/flow_node_event_retry_sending',
653
- /**
654
- * Wait for an MessageTriggered notification and resolves with the notification's content.
655
- * @tags Notifications
656
- * @method get
657
- * @responseType EventMessage
658
- */
659
- onMessageTriggered: '/notifications/long_polling/message_triggered',
660
- /**
661
- * Wait for an SignalTriggered notification and resolves with the notification's content.
662
- * @tags Notifications
663
- * @method get
664
- * @responseType EventMessage
665
- */
666
- onSignalTriggered: '/notifications/long_polling/signal_triggered',
667
- /**
668
- * Wait for an EndEventFinished notification and resolves with the notification's content.
669
- * @tags Notifications
670
- * @method get
671
- * @responseType EventMessage
672
- */
673
- onEndEventFinished: '/notifications/long_polling/end_event_finished',
674
- /**
675
- * Wait for an StartEventFinished notification and resolves with the notification's content.
676
- * @tags Notifications
677
- * @method get
678
- * @responseType EventMessage
679
- */
680
- onStartEventFinished: '/notifications/long_polling/start_event_finished',
681
- /**
682
- * Wait for a ProcessInstanceMetadataChanged notification and resolves with the notification's content.
683
- * @tags Notifications
684
- * @method get
685
- * @responseType MetadataChangedMessage
686
- */
687
- onProcessInstanceMetadataChanged: '/notifications/long_polling/process_instance_metadata_changed',
688
- /**
689
- * Wait for a CorrelationMetadataChanged notification and resolves with the notification's content.
690
- * @tags Notifications
691
- * @method get
692
- * @responseType MetadataChangedMessage
693
- */
694
- onCorrelationMetadataChanged: '/notifications/long_polling/correlation_metadata_changed',
695
- };
696
- exports.restSettings = {
697
- params: params,
698
- paths: paths,
699
- baseRoute: 'atlas_engine/api',
700
- };
701
- });
702
- //# sourceMappingURL=RestSettings.js.map