@camunda8/sdk 8.5.0 → 8.5.1-alpha.2
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.
- package/CHANGELOG.md +14 -0
- package/QUICKSTART.md +357 -0
- package/README.md +3 -7
- package/dist/admin/lib/AdminApiClient.d.ts +21 -2
- package/dist/admin/lib/AdminApiClient.js +27 -14
- package/dist/admin/lib/AdminApiClient.js.map +1 -1
- package/dist/c8/index.d.ts +2 -2
- package/dist/c8/index.js +4 -4
- package/dist/c8/index.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js.map +1 -1
- package/dist/lib/GotErrors.d.ts +6 -0
- package/dist/lib/GotErrors.js +37 -0
- package/dist/lib/GotErrors.js.map +1 -0
- package/dist/lib/GotHooks.d.ts +23 -0
- package/dist/lib/GotHooks.js +51 -0
- package/dist/lib/GotHooks.js.map +1 -0
- package/dist/lib/index.d.ts +2 -0
- package/dist/lib/index.js +2 -0
- package/dist/lib/index.js.map +1 -1
- package/dist/modeler/lib/ModelerAPIClient.d.ts +58 -7
- package/dist/modeler/lib/ModelerAPIClient.js +79 -36
- package/dist/modeler/lib/ModelerAPIClient.js.map +1 -1
- package/dist/oauth/lib/OAuthProvider.d.ts +1 -1
- package/dist/oauth/lib/OAuthProvider.js +10 -8
- package/dist/oauth/lib/OAuthProvider.js.map +1 -1
- package/dist/operate/lib/OperateApiClient.d.ts +41 -2
- package/dist/operate/lib/OperateApiClient.js +50 -16
- package/dist/operate/lib/OperateApiClient.js.map +1 -1
- package/dist/optimize/lib/OptimizeApiClient.d.ts +13 -5
- package/dist/optimize/lib/OptimizeApiClient.js +20 -20
- package/dist/optimize/lib/OptimizeApiClient.js.map +1 -1
- package/dist/tasklist/lib/TasklistApiClient.d.ts +7 -2
- package/dist/tasklist/lib/TasklistApiClient.js +12 -14
- package/dist/tasklist/lib/TasklistApiClient.js.map +1 -1
- package/dist/zeebe/zb/ZeebeGrpcClient.js +12 -3
- package/dist/zeebe/zb/ZeebeGrpcClient.js.map +1 -1
- package/img/process-model.png +0 -0
- package/package.json +3 -1
|
@@ -4,13 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.OperateApiClient = void 0;
|
|
7
|
-
const debug_1 = require("debug");
|
|
8
7
|
const got_1 = __importDefault(require("got"));
|
|
9
8
|
const lib_1 = require("../../lib");
|
|
10
9
|
const OperateDto_1 = require("./OperateDto");
|
|
11
10
|
const parseSearchResults_1 = require("./parseSearchResults");
|
|
12
11
|
const OPERATE_API_VERSION = 'v1';
|
|
13
|
-
const debug = (0, debug_1.debug)('camunda:operate');
|
|
14
12
|
/**
|
|
15
13
|
* @description The high-level client for Operate.
|
|
16
14
|
* @example
|
|
@@ -33,6 +31,7 @@ class OperateApiClient {
|
|
|
33
31
|
* ```
|
|
34
32
|
* const operate = new OperateApiClient()
|
|
35
33
|
* ```
|
|
34
|
+
* @throws {RESTError} An error that may occur during API operations.
|
|
36
35
|
*/
|
|
37
36
|
constructor(options) {
|
|
38
37
|
const config = lib_1.CamundaEnvironmentConfigurator.mergeConfigWithEnvironment(options?.config ?? {});
|
|
@@ -44,23 +43,16 @@ class OperateApiClient {
|
|
|
44
43
|
const prefixUrl = `${baseUrl}/${OPERATE_API_VERSION}`;
|
|
45
44
|
this.rest = got_1.default.extend({
|
|
46
45
|
prefixUrl,
|
|
46
|
+
retry: lib_1.GotRetryConfig,
|
|
47
47
|
https: {
|
|
48
48
|
certificateAuthority,
|
|
49
49
|
},
|
|
50
|
+
handlers: [lib_1.gotErrorHandler],
|
|
50
51
|
hooks: {
|
|
51
|
-
|
|
52
|
-
(
|
|
53
|
-
const { request } = error;
|
|
54
|
-
if (request) {
|
|
55
|
-
debug(`Error in request to ${request.options.url.href}`);
|
|
56
|
-
debug(`Request headers: ${JSON.stringify(request.options.headers)}`);
|
|
57
|
-
debug(`Error: ${error.code} - ${error.message}`);
|
|
58
|
-
// Attach more contextual information to the error object
|
|
59
|
-
error.message += ` (request to ${request.options.url.href})`;
|
|
60
|
-
}
|
|
61
|
-
return error;
|
|
62
|
-
},
|
|
52
|
+
beforeRetry: [
|
|
53
|
+
(0, lib_1.makeBeforeRetryHandlerFor401TokenRetry)(this.getHeaders.bind(this)),
|
|
63
54
|
],
|
|
55
|
+
beforeError: [lib_1.gotBeforeErrorHook],
|
|
64
56
|
},
|
|
65
57
|
});
|
|
66
58
|
this.tenantId = config.CAMUNDA_TENANT_ID;
|
|
@@ -95,6 +87,7 @@ class OperateApiClient {
|
|
|
95
87
|
* @description Search and retrieve process definitions.
|
|
96
88
|
*
|
|
97
89
|
* [Camunda 8 Documentation](https://docs.camunda.io/docs/apis-clients/operate-api/#process-definition)
|
|
90
|
+
* @throws {RESTError}
|
|
98
91
|
* @example
|
|
99
92
|
* ```
|
|
100
93
|
* const query: Query<ProcessDefinition> = {
|
|
@@ -125,7 +118,7 @@ class OperateApiClient {
|
|
|
125
118
|
/**
|
|
126
119
|
*
|
|
127
120
|
* @description Retrieve the metadata for a specific process definition, by key.
|
|
128
|
-
*
|
|
121
|
+
* @throws {RESTError}
|
|
129
122
|
* [Camunda 8 Documentation](https://docs.camunda.io/docs/apis-clients/operate-api/#process-definition)
|
|
130
123
|
* @example
|
|
131
124
|
* ```
|
|
@@ -137,6 +130,7 @@ class OperateApiClient {
|
|
|
137
130
|
const headers = await this.getHeaders();
|
|
138
131
|
return this.rest(`process-definitions/${processDefinitionKey}`, {
|
|
139
132
|
headers,
|
|
133
|
+
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.ProcessDefinition),
|
|
140
134
|
}).json();
|
|
141
135
|
}
|
|
142
136
|
async getProcessDefinitionXML(processDefinitionKey) {
|
|
@@ -145,6 +139,10 @@ class OperateApiClient {
|
|
|
145
139
|
headers,
|
|
146
140
|
}).text();
|
|
147
141
|
}
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @throws {RESTError}
|
|
145
|
+
*/
|
|
148
146
|
async searchDecisionDefinitions(query) {
|
|
149
147
|
const headers = await this.getHeaders();
|
|
150
148
|
const json = this.addTenantIdToFilter(query);
|
|
@@ -154,6 +152,9 @@ class OperateApiClient {
|
|
|
154
152
|
json,
|
|
155
153
|
}).json();
|
|
156
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* @throws {RESTError}
|
|
157
|
+
*/
|
|
157
158
|
async getDecisionDefinition(decisionDefinitionKey) {
|
|
158
159
|
const headers = await this.getHeaders();
|
|
159
160
|
return this.rest(`decision-definitions/${decisionDefinitionKey}`, {
|
|
@@ -161,6 +162,9 @@ class OperateApiClient {
|
|
|
161
162
|
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.DecisionDefinition),
|
|
162
163
|
}).json();
|
|
163
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* @throws {RESTError}
|
|
167
|
+
*/
|
|
164
168
|
async searchDecisionInstances(query) {
|
|
165
169
|
const headers = await this.getHeaders();
|
|
166
170
|
const json = this.addTenantIdToFilter(query);
|
|
@@ -170,6 +174,9 @@ class OperateApiClient {
|
|
|
170
174
|
json,
|
|
171
175
|
}).json();
|
|
172
176
|
}
|
|
177
|
+
/**
|
|
178
|
+
* @throws {RESTError}
|
|
179
|
+
*/
|
|
173
180
|
async getDecisionInstance(decisionInstanceKey) {
|
|
174
181
|
const headers = await this.getHeaders();
|
|
175
182
|
return this.rest(`decision-instances/${decisionInstanceKey}`, {
|
|
@@ -179,6 +186,7 @@ class OperateApiClient {
|
|
|
179
186
|
}
|
|
180
187
|
/**
|
|
181
188
|
* @description Search and retrieve process instances.
|
|
189
|
+
* @throws {RESTError}
|
|
182
190
|
* @example
|
|
183
191
|
* ```
|
|
184
192
|
* const operate = new OperateApiClient()
|
|
@@ -216,6 +224,7 @@ class OperateApiClient {
|
|
|
216
224
|
/**
|
|
217
225
|
*
|
|
218
226
|
* @description Retrieve a specific process instance by id.
|
|
227
|
+
* @throws {RESTError}
|
|
219
228
|
* @example
|
|
220
229
|
* ```
|
|
221
230
|
* const operate = new OperateApiClient()
|
|
@@ -226,10 +235,12 @@ class OperateApiClient {
|
|
|
226
235
|
const headers = await this.getHeaders();
|
|
227
236
|
return this.rest(`process-instances/${processInstanceKey}`, {
|
|
228
237
|
headers,
|
|
238
|
+
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.ProcessInstance),
|
|
229
239
|
}).json();
|
|
230
240
|
}
|
|
231
241
|
/**
|
|
232
242
|
* @description Delete a specific process instance by key.
|
|
243
|
+
* @throws {RESTError}
|
|
233
244
|
* @example
|
|
234
245
|
* ```
|
|
235
246
|
* const operate = new OperateApiClient()
|
|
@@ -242,6 +253,7 @@ class OperateApiClient {
|
|
|
242
253
|
const res = this.rest.delete(`process-instances/${processInstanceKey}`, {
|
|
243
254
|
headers,
|
|
244
255
|
throwHttpErrors: false,
|
|
256
|
+
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.ChangeStatus),
|
|
245
257
|
});
|
|
246
258
|
res.catch((e) => console.log(e));
|
|
247
259
|
return res.json();
|
|
@@ -252,6 +264,7 @@ class OperateApiClient {
|
|
|
252
264
|
}
|
|
253
265
|
/**
|
|
254
266
|
* @description Get the statistics for a process instance, grouped by flow nodes
|
|
267
|
+
* @throws {RESTError}
|
|
255
268
|
*/
|
|
256
269
|
async getProcessInstanceStatistics(processInstanceKey) {
|
|
257
270
|
const headers = await this.getHeaders();
|
|
@@ -262,6 +275,7 @@ class OperateApiClient {
|
|
|
262
275
|
}
|
|
263
276
|
/**
|
|
264
277
|
* @description Get sequence flows of process instance by key
|
|
278
|
+
* @throws {RESTError}
|
|
265
279
|
*/
|
|
266
280
|
async getProcessInstanceSequenceFlows(processInstanceKey) {
|
|
267
281
|
const headers = await this.getHeaders();
|
|
@@ -272,6 +286,7 @@ class OperateApiClient {
|
|
|
272
286
|
/**
|
|
273
287
|
*
|
|
274
288
|
* @description Search and retrieve incidents.
|
|
289
|
+
* @throws {RESTError}
|
|
275
290
|
* @example
|
|
276
291
|
* ```
|
|
277
292
|
* const operate = new OperateApiClient()
|
|
@@ -304,6 +319,7 @@ class OperateApiClient {
|
|
|
304
319
|
/**
|
|
305
320
|
*
|
|
306
321
|
* @description Retrieve an incident by incident key.
|
|
322
|
+
* @throws {RESTError}
|
|
307
323
|
* @example
|
|
308
324
|
* ```
|
|
309
325
|
* const operate = new OperateApiClient()
|
|
@@ -318,6 +334,9 @@ class OperateApiClient {
|
|
|
318
334
|
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.Incident),
|
|
319
335
|
}).json();
|
|
320
336
|
}
|
|
337
|
+
/**
|
|
338
|
+
* @throws {RESTError}
|
|
339
|
+
*/
|
|
321
340
|
async searchFlownodeInstances(query) {
|
|
322
341
|
const headers = await this.getHeaders();
|
|
323
342
|
const json = this.addTenantIdToFilter(query);
|
|
@@ -329,6 +348,9 @@ class OperateApiClient {
|
|
|
329
348
|
})
|
|
330
349
|
.json();
|
|
331
350
|
}
|
|
351
|
+
/**
|
|
352
|
+
* @throws {RESTError}
|
|
353
|
+
*/
|
|
332
354
|
async getFlownodeInstance(key) {
|
|
333
355
|
const headers = await this.getHeaders();
|
|
334
356
|
return this.rest(`flownode-instances/${key}`, {
|
|
@@ -336,6 +358,9 @@ class OperateApiClient {
|
|
|
336
358
|
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.FlownodeInstance),
|
|
337
359
|
}).json();
|
|
338
360
|
}
|
|
361
|
+
/**
|
|
362
|
+
* @throws {RESTError}
|
|
363
|
+
*/
|
|
339
364
|
async searchVariables(query) {
|
|
340
365
|
const headers = await this.getHeaders();
|
|
341
366
|
const json = this.addTenantIdToFilter(query);
|
|
@@ -349,6 +374,7 @@ class OperateApiClient {
|
|
|
349
374
|
}
|
|
350
375
|
/**
|
|
351
376
|
* @description Retrieve the variables for a Process Instance, given its key
|
|
377
|
+
* @throws {RESTError}
|
|
352
378
|
* @param processInstanceKey
|
|
353
379
|
* @returns
|
|
354
380
|
*/
|
|
@@ -369,7 +395,7 @@ class OperateApiClient {
|
|
|
369
395
|
/**
|
|
370
396
|
* @description Retrieve the variables for a Process Instance as an object, given its key
|
|
371
397
|
* @param processInstanceKey
|
|
372
|
-
* @
|
|
398
|
+
* @throws {RESTError}
|
|
373
399
|
*/
|
|
374
400
|
async getJSONVariablesforProcess(processInstanceKey) {
|
|
375
401
|
const headers = await this.getHeaders();
|
|
@@ -403,14 +429,19 @@ class OperateApiClient {
|
|
|
403
429
|
/**
|
|
404
430
|
*
|
|
405
431
|
* @description Return a variable identified by its variable key
|
|
432
|
+
* @throws {RESTError}
|
|
406
433
|
* @returns
|
|
407
434
|
*/
|
|
408
435
|
async getVariables(variableKey) {
|
|
409
436
|
const headers = await this.getHeaders();
|
|
410
437
|
return this.rest(`variables/${variableKey}`, {
|
|
411
438
|
headers,
|
|
439
|
+
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.Variable),
|
|
412
440
|
}).json();
|
|
413
441
|
}
|
|
442
|
+
/**
|
|
443
|
+
* @throws {RESTError}
|
|
444
|
+
*/
|
|
414
445
|
async searchDecisionRequirements(query) {
|
|
415
446
|
const headers = await this.getHeaders();
|
|
416
447
|
const json = this.addTenantIdToFilter(query);
|
|
@@ -429,6 +460,9 @@ class OperateApiClient {
|
|
|
429
460
|
parseJson: (text) => (0, lib_1.losslessParse)(text, OperateDto_1.DecisionRequirements),
|
|
430
461
|
}).json();
|
|
431
462
|
}
|
|
463
|
+
/**
|
|
464
|
+
* @throws {RESTError}
|
|
465
|
+
*/
|
|
432
466
|
async getDecisionRequirementsXML(key) {
|
|
433
467
|
const headers = await this.getHeaders();
|
|
434
468
|
return this.rest(`drd/${key}/xml`, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OperateApiClient.js","sourceRoot":"","sources":["../../../src/operate/lib/OperateApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"OperateApiClient.js","sourceRoot":"","sources":["../../../src/operate/lib/OperateApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAqB;AAErB,mCAckB;AAGlB,6CAaqB;AACrB,6DAAyD;AAEzD,MAAM,mBAAmB,GAAG,IAAI,CAAA;AAWhC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,gBAAgB;IAM5B;;;;;;OAMG;IACH,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAoB,EACnC,MAAM,CAAC,wBAAwB,EAC/B,0BAA0B,CAC1B,CAAA;QAED,MAAM,oBAAoB,GAAG,IAAA,6BAAuB,EAAC,MAAM,CAAC,CAAA;QAE5D,MAAM,SAAS,GAAG,GAAG,OAAO,IAAI,mBAAmB,EAAE,CAAA;QAErD,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACtB,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClE;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;aACjC;SACD,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAA;IACzC,CAAC;IAEO,KAAK,CAAC,UAAU;QACvB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAE1D,OAAO;YACN,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;SACb,CAAA;IACF,CAAC;IAED,8DAA8D;IACpD,mBAAmB,CAC5B,KAAe,EACf,WAA+B,IAAI,CAAC,QAAQ,CAAC,wBAAwB;;QAErE,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,IAAI,KAAK,CAAC,MAAM,CAAA;QAEtE,uEAAuE;QACvE,IAAI,mBAAmB,EAAE,CAAC;YACzB,OAAO,KAA+C,CAAA;QACvD,CAAC;QAED,mDAAmD;QACnD,OAAO;YACN,GAAG,KAAK;YACR,MAAM,EAAE;gBACP,GAAG,KAAK,CAAC,MAAM;gBACf,QAAQ;aACR;SACoD,CAAA;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,wBAAwB,CACpC,QAAkC,EAAE;QAEpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,4BAA4B,EAAE;YACnC,IAAI;YACJ,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,8BAAiB,CAAC;SAChE,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,oBAAoB,CAChC,oBAAqC;QAErC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,oBAAoB,EAAE,EAAE;YAC/D,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,8BAAiB,CAAC;SAC3D,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAEM,KAAK,CAAC,uBAAuB,CACnC,oBAAqC;QAErC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,oBAAoB,MAAM,EAAE;YACnE,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,yBAAyB,CACrC,KAAgC;QAEhC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,6BAA6B,EAAE;YAC/C,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,+BAAkB,CAAC;YACjE,IAAI;SACJ,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,qBAAqB,CACjC,qBAAsC;QAEtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,wBAAwB,qBAAqB,EAAE,EAAE;YACjE,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,+BAAkB,CAAC;SAC5D,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,uBAAuB,CACnC,KAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE;YAC7C,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,6BAAgB,CAAC;YAC/D,IAAI;SACJ,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAC/B,mBAAoC;QAEpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,mBAAmB,EAAE,EAAE;YAC7D,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,6BAAgB,CAAC;SAC1D,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,sBAAsB,CAClC,QAAgC,EAAE;QAElC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QAEvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,IAAI,CAAC;YACJ,OAAO,IAAI,CAAC,IAAI;iBACd,IAAI,CAAC,0BAA0B,EAAE;gBACjC,IAAI;gBACJ,OAAO;gBACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,4BAAe,CAAC;aAC9D,CAAC;iBACD,IAAI,EAAE,CAAA;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAE,CAAW,CAAC,OAAO,CAAC,CAAA;QACtC,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,kBAAkB,CAC9B,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,kBAAkB,EAAE,EAAE;YAC3D,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,4BAAe,CAAC;SACzD,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,qBAAqB,CACjC,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,IAAI,CAAC;YACJ,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,kBAAkB,EAAE,EAAE;gBACvE,OAAO;gBACP,eAAe,EAAE,KAAK;gBACtB,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,yBAAY,CAAC;aACtD,CAAC,CAAA;YACF,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YAChC,OAAO,GAAG,CAAC,IAAI,EAAE,CAAA;QAClB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAE,CAAW,CAAC,OAAO,CAAC,CAAA;QACtC,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,4BAA4B,CACxC,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,kBAAkB,aAAa,EAAE;YACtE,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,sCAAyB,CAAC;SACnE,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,+BAA+B,CAC3C,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,qBAAqB,kBAAkB,iBAAiB,EAAE;YAC1E,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,eAAe,CAC3B,QAAyB,EAAE;QAE3B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,kBAAkB,EAAE;YACzB,IAAI;YACJ,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,qBAAQ,CAAC;SACvD,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW,CAAC,GAAoB;QAC5C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,EAAE,EAAE;YACpC,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,qBAAQ,CAAC;SAClD,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,uBAAuB,CACnC,KAA8B;QAE9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,2BAA2B,EAAE;YAClC,OAAO;YACP,IAAI;YACJ,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,6BAAgB,CAAC;SAC/D,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAC/B,GAAoB;QAEpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,GAAG,EAAE,EAAE;YAC7C,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,6BAAgB,CAAC;SAC1D,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,eAAe,CAC3B,KAAsB;QAEtB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,kBAAkB,EAAE;YACzB,OAAO;YACP,IAAI;YACJ,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,qBAAQ,CAAC;SACvD,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CAClC,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG;YACZ,MAAM,EAAE;gBACP,kBAAkB;aAClB;SACD,CAAA;QACD,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,kBAAkB,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAA,uBAAiB,EAAC,IAAI,CAAC;SAC7B,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,0BAA0B,CACtC,kBAAmC;QAEnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG;YACZ,MAAM,EAAE;gBACP,kBAAkB;aAClB;YACD,IAAI,EAAE,IAAI;SACV,CAAA;QACD,MAAM,IAAI,GAA0B,MAAM,IAAI,CAAC,IAAI;aACjD,IAAI,CAAC,kBAAkB,EAAE;YACzB,OAAO;YACP,IAAI,EAAE,IAAA,uBAAiB,EAAC,IAAI,CAAC;SAC7B,CAAC;aACD,IAAI,EAAE,CAAA;QAER,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CACvB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;YAChB,GAAG,IAAI;YACP,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;SAC3C,CAAC,EACF,EAAO,CACP,CAAA;IACF,CAAC;IAEO,aAAa,CAAC,KAAa;QAClC,IAAI,CAAC;YACJ,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACzB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAClB,OAAO,KAAK,CAAA;QACb,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,WAA4B;QACrD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,WAAW,EAAE,EAAE;YAC5C,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,qBAAQ,CAAC;SAClD,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,0BAA0B,CAAC,KAAkC;QACzE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,YAAY,EAAE;YACnB,OAAO;YACP,IAAI;YACJ,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uCAAkB,EAAC,IAAI,EAAE,iCAAoB,CAAC;SACnE,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAEM,KAAK,CAAC,uBAAuB,CACnC,GAAoB;QAEpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,EAAE;YAC9B,OAAO;YACP,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAa,EAAC,IAAI,EAAE,iCAAoB,CAAC;SAC9D,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,0BAA0B,CAAC,GAAoB;QAC3D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,EAAE;YAClC,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;CACD;AAlhBD,4CAkhBC"}
|
|
@@ -3,6 +3,7 @@ import { IOAuthProvider } from '../../oauth';
|
|
|
3
3
|
import { DashboardCollection, DashboardDefinition, EntityImportResponse, ReportCollection, ReportDataExporter, SingleProcessReport, Variable, VariableLabels } from './APIObjects';
|
|
4
4
|
/**
|
|
5
5
|
* @description The high-level API client for Optimize.
|
|
6
|
+
* @throws {RESTError} If the request fails
|
|
6
7
|
* @example
|
|
7
8
|
* ```
|
|
8
9
|
* const optimize = new OptimizeApiClient()
|
|
@@ -41,6 +42,7 @@ export declare class OptimizeApiClient {
|
|
|
41
42
|
* If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.
|
|
42
43
|
*
|
|
43
44
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/configuration/enable-sharing/)
|
|
45
|
+
* @throws {RESTError} If the request fails
|
|
44
46
|
* @example
|
|
45
47
|
* ```typescript
|
|
46
48
|
* const client = new OptimizeApiClient()
|
|
@@ -56,6 +58,7 @@ export declare class OptimizeApiClient {
|
|
|
56
58
|
* When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.
|
|
57
59
|
*
|
|
58
60
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/configuration/disable-sharing/)
|
|
61
|
+
* @throws {RESTError} If the request fails
|
|
59
62
|
* @example
|
|
60
63
|
* ```typescript
|
|
61
64
|
* const client = new OptimizeApiClient()
|
|
@@ -70,7 +73,7 @@ export declare class OptimizeApiClient {
|
|
|
70
73
|
* The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.
|
|
71
74
|
*
|
|
72
75
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/dashboard/get-dashboard-ids/)
|
|
73
|
-
*
|
|
76
|
+
* @throws {RESTError} If the request fails
|
|
74
77
|
* @param collectionId The ID of the collection for which to retrieve the dashboard IDs.
|
|
75
78
|
* @example
|
|
76
79
|
* ```
|
|
@@ -88,6 +91,7 @@ export declare class OptimizeApiClient {
|
|
|
88
91
|
*
|
|
89
92
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/dashboard/export-dashboard-definitions/)
|
|
90
93
|
*
|
|
94
|
+
* @throws {RESTError} If the request fails
|
|
91
95
|
* @param dashboardIds Array of dashboard ids
|
|
92
96
|
* @example
|
|
93
97
|
* ```
|
|
@@ -100,7 +104,7 @@ export declare class OptimizeApiClient {
|
|
|
100
104
|
* @description This API allows users to retrieve all report IDs from a given collection. The response contains a list of IDs of the reports existing in the collection with the given collection ID.
|
|
101
105
|
*
|
|
102
106
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/get-report-ids/)
|
|
103
|
-
*
|
|
107
|
+
* @throws {RESTError} If the request fails
|
|
104
108
|
* @param collectionId the id of the collection
|
|
105
109
|
* @example
|
|
106
110
|
* ```
|
|
@@ -113,7 +117,7 @@ export declare class OptimizeApiClient {
|
|
|
113
117
|
* @description The report deletion API allows you to delete reports by ID from Optimize.
|
|
114
118
|
*
|
|
115
119
|
* [Camunda 8 documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/delete-report/)
|
|
116
|
-
*
|
|
120
|
+
* @throws {RESTError} If the request fails
|
|
117
121
|
* @param reportId The ID of the report you wish to delete
|
|
118
122
|
*
|
|
119
123
|
* @example
|
|
@@ -129,7 +133,7 @@ export declare class OptimizeApiClient {
|
|
|
129
133
|
* The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.
|
|
130
134
|
*
|
|
131
135
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/export-report-definitions/)
|
|
132
|
-
*
|
|
136
|
+
* @throws {RESTError} If the request fails
|
|
133
137
|
* @param reportIds array of report IDs
|
|
134
138
|
* @example
|
|
135
139
|
* ```
|
|
@@ -143,6 +147,7 @@ export declare class OptimizeApiClient {
|
|
|
143
147
|
* @param reportId
|
|
144
148
|
* @param limit
|
|
145
149
|
* @param paginationTimeoutSec
|
|
150
|
+
* @throws {RESTError} If the request fails
|
|
146
151
|
* @example
|
|
147
152
|
* ```
|
|
148
153
|
* const client = new OptimizeApiClient()
|
|
@@ -156,6 +161,7 @@ export declare class OptimizeApiClient {
|
|
|
156
161
|
*
|
|
157
162
|
* Especially if this data changes over time, it is advisable to use this REST API to persist external variable updates to Optimize, as otherwise Optimize may not be aware of data changes in the external system.
|
|
158
163
|
* @param variables
|
|
164
|
+
* @throws {RESTError} If the request fails
|
|
159
165
|
* @example
|
|
160
166
|
* ```
|
|
161
167
|
* const variables = [
|
|
@@ -185,7 +191,7 @@ export declare class OptimizeApiClient {
|
|
|
185
191
|
* @description The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.
|
|
186
192
|
*
|
|
187
193
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/health-readiness/)
|
|
188
|
-
*
|
|
194
|
+
* @throws {RESTError} If the request fails
|
|
189
195
|
* @example
|
|
190
196
|
* ```
|
|
191
197
|
* const client = new OptimizeApiClient()
|
|
@@ -203,6 +209,7 @@ export declare class OptimizeApiClient {
|
|
|
203
209
|
*
|
|
204
210
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/import-entities/)
|
|
205
211
|
*
|
|
212
|
+
* @throws {RESTError} If the request fails
|
|
206
213
|
* @example
|
|
207
214
|
* ```
|
|
208
215
|
* const entities = [
|
|
@@ -239,6 +246,7 @@ export declare class OptimizeApiClient {
|
|
|
239
246
|
*
|
|
240
247
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/variable-labeling/)
|
|
241
248
|
*
|
|
249
|
+
* @throws {RESTError} If the request fails
|
|
242
250
|
* @example
|
|
243
251
|
* ```
|
|
244
252
|
* const variableLabels = {
|
|
@@ -4,13 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.OptimizeApiClient = void 0;
|
|
7
|
-
const debug_1 = require("debug");
|
|
8
7
|
const got_1 = __importDefault(require("got"));
|
|
9
8
|
const lib_1 = require("../../lib");
|
|
10
9
|
const ReportResults_1 = require("./ReportResults");
|
|
11
|
-
const debug = (0, debug_1.debug)('camunda:optimize');
|
|
12
10
|
/**
|
|
13
11
|
* @description The high-level API client for Optimize.
|
|
12
|
+
* @throws {RESTError} If the request fails
|
|
14
13
|
* @example
|
|
15
14
|
* ```
|
|
16
15
|
* const optimize = new OptimizeApiClient()
|
|
@@ -40,25 +39,19 @@ class OptimizeApiClient {
|
|
|
40
39
|
this.oAuthProvider =
|
|
41
40
|
options?.oAuthProvider ?? (0, lib_1.constructOAuthProvider)(config);
|
|
42
41
|
const certificateAuthority = (0, lib_1.GetCertificateAuthority)(config);
|
|
42
|
+
const prefixUrl = `${baseUrl}/api`;
|
|
43
43
|
this.rest = got_1.default.extend({
|
|
44
|
-
prefixUrl
|
|
44
|
+
prefixUrl,
|
|
45
|
+
retry: lib_1.GotRetryConfig,
|
|
45
46
|
https: {
|
|
46
47
|
certificateAuthority,
|
|
47
48
|
},
|
|
49
|
+
handlers: [lib_1.gotErrorHandler],
|
|
48
50
|
hooks: {
|
|
49
|
-
|
|
50
|
-
(
|
|
51
|
-
const { request } = error;
|
|
52
|
-
if (request) {
|
|
53
|
-
debug(`Error in request to ${request.options.url.href}`);
|
|
54
|
-
debug(`Request headers: ${JSON.stringify(request.options.headers)}`);
|
|
55
|
-
debug(`Error: ${error.code} - ${error.message}`);
|
|
56
|
-
// Attach more contextual information to the error object
|
|
57
|
-
error.message += ` (request to ${request.options.url.href})`;
|
|
58
|
-
}
|
|
59
|
-
return error;
|
|
60
|
-
},
|
|
51
|
+
beforeRetry: [
|
|
52
|
+
(0, lib_1.makeBeforeRetryHandlerFor401TokenRetry)(this.getHeaders.bind(this)),
|
|
61
53
|
],
|
|
54
|
+
beforeError: [lib_1.gotBeforeErrorHook],
|
|
62
55
|
},
|
|
63
56
|
});
|
|
64
57
|
}
|
|
@@ -84,6 +77,7 @@ class OptimizeApiClient {
|
|
|
84
77
|
* If sharing had been previously enabled and then disabled, re-enabling sharing will allow users to access previously shared URLs under the same address as before. Calling this endpoint when sharing is already enabled will have no effect.
|
|
85
78
|
*
|
|
86
79
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/configuration/enable-sharing/)
|
|
80
|
+
* @throws {RESTError} If the request fails
|
|
87
81
|
* @example
|
|
88
82
|
* ```typescript
|
|
89
83
|
* const client = new OptimizeApiClient()
|
|
@@ -105,6 +99,7 @@ class OptimizeApiClient {
|
|
|
105
99
|
* When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.
|
|
106
100
|
*
|
|
107
101
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/configuration/disable-sharing/)
|
|
102
|
+
* @throws {RESTError} If the request fails
|
|
108
103
|
* @example
|
|
109
104
|
* ```typescript
|
|
110
105
|
* const client = new OptimizeApiClient()
|
|
@@ -125,7 +120,7 @@ class OptimizeApiClient {
|
|
|
125
120
|
* The response contains a list of IDs of the dashboards existing in the collection with the given collection ID.
|
|
126
121
|
*
|
|
127
122
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/dashboard/get-dashboard-ids/)
|
|
128
|
-
*
|
|
123
|
+
* @throws {RESTError} If the request fails
|
|
129
124
|
* @param collectionId The ID of the collection for which to retrieve the dashboard IDs.
|
|
130
125
|
* @example
|
|
131
126
|
* ```
|
|
@@ -156,6 +151,7 @@ class OptimizeApiClient {
|
|
|
156
151
|
*
|
|
157
152
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/dashboard/export-dashboard-definitions/)
|
|
158
153
|
*
|
|
154
|
+
* @throws {RESTError} If the request fails
|
|
159
155
|
* @param dashboardIds Array of dashboard ids
|
|
160
156
|
* @example
|
|
161
157
|
* ```
|
|
@@ -176,7 +172,7 @@ class OptimizeApiClient {
|
|
|
176
172
|
* @description This API allows users to retrieve all report IDs from a given collection. The response contains a list of IDs of the reports existing in the collection with the given collection ID.
|
|
177
173
|
*
|
|
178
174
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/get-report-ids/)
|
|
179
|
-
*
|
|
175
|
+
* @throws {RESTError} If the request fails
|
|
180
176
|
* @param collectionId the id of the collection
|
|
181
177
|
* @example
|
|
182
178
|
* ```
|
|
@@ -194,7 +190,7 @@ class OptimizeApiClient {
|
|
|
194
190
|
* @description The report deletion API allows you to delete reports by ID from Optimize.
|
|
195
191
|
*
|
|
196
192
|
* [Camunda 8 documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/delete-report/)
|
|
197
|
-
*
|
|
193
|
+
* @throws {RESTError} If the request fails
|
|
198
194
|
* @param reportId The ID of the report you wish to delete
|
|
199
195
|
*
|
|
200
196
|
* @example
|
|
@@ -217,7 +213,7 @@ class OptimizeApiClient {
|
|
|
217
213
|
* The obtained list of entity exports can be imported into other Optimize systems either using the dedicated import API or via UI.
|
|
218
214
|
*
|
|
219
215
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/report/export-report-definitions/)
|
|
220
|
-
*
|
|
216
|
+
* @throws {RESTError} If the request fails
|
|
221
217
|
* @param reportIds array of report IDs
|
|
222
218
|
* @example
|
|
223
219
|
* ```
|
|
@@ -239,6 +235,7 @@ class OptimizeApiClient {
|
|
|
239
235
|
* @param reportId
|
|
240
236
|
* @param limit
|
|
241
237
|
* @param paginationTimeoutSec
|
|
238
|
+
* @throws {RESTError} If the request fails
|
|
242
239
|
* @example
|
|
243
240
|
* ```
|
|
244
241
|
* const client = new OptimizeApiClient()
|
|
@@ -270,6 +267,7 @@ class OptimizeApiClient {
|
|
|
270
267
|
*
|
|
271
268
|
* Especially if this data changes over time, it is advisable to use this REST API to persist external variable updates to Optimize, as otherwise Optimize may not be aware of data changes in the external system.
|
|
272
269
|
* @param variables
|
|
270
|
+
* @throws {RESTError} If the request fails
|
|
273
271
|
* @example
|
|
274
272
|
* ```
|
|
275
273
|
* const variables = [
|
|
@@ -307,7 +305,7 @@ class OptimizeApiClient {
|
|
|
307
305
|
* @description The purpose of Health-Readiness REST API is to return information indicating whether Optimize is ready to be used.
|
|
308
306
|
*
|
|
309
307
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/health-readiness/)
|
|
310
|
-
*
|
|
308
|
+
* @throws {RESTError} If the request fails
|
|
311
309
|
* @example
|
|
312
310
|
* ```
|
|
313
311
|
* const client = new OptimizeApiClient()
|
|
@@ -330,6 +328,7 @@ class OptimizeApiClient {
|
|
|
330
328
|
*
|
|
331
329
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/import-entities/)
|
|
332
330
|
*
|
|
331
|
+
* @throws {RESTError} If the request fails
|
|
333
332
|
* @example
|
|
334
333
|
* ```
|
|
335
334
|
* const entities = [
|
|
@@ -372,6 +371,7 @@ class OptimizeApiClient {
|
|
|
372
371
|
*
|
|
373
372
|
* [Camunda 8 Documentation](https://docs.camunda.io/optimize/apis-clients/optimize-api/variable-labeling/)
|
|
374
373
|
*
|
|
374
|
+
* @throws {RESTError} If the request fails
|
|
375
375
|
* @example
|
|
376
376
|
* ```
|
|
377
377
|
* const variableLabels = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OptimizeApiClient.js","sourceRoot":"","sources":["../../../src/optimize/lib/OptimizeApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"OptimizeApiClient.js","sourceRoot":"","sources":["../../../src/optimize/lib/OptimizeApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAqB;AAErB,mCAYkB;AAalB,mDAA+C;AAE/C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,iBAAiB;IAK7B;;;;;;OAMG;IACH,YAAY,OAGX;QACA,MAAM,MAAM,GAAG,oCAA8B,CAAC,0BAA0B,CACvE,OAAO,EAAE,MAAM,IAAI,EAAE,CACrB,CAAA;QACD,IAAI,CAAC,eAAe,GAAG,IAAA,2BAAqB,EAAC,MAAM,CAAC,CAAA;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAoB,EACnC,MAAM,CAAC,yBAAyB,EAChC,2BAA2B,CAC3B,CAAA;QACD,IAAI,CAAC,aAAa;YACjB,OAAO,EAAE,aAAa,IAAI,IAAA,4BAAsB,EAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,oBAAoB,GAAG,IAAA,6BAAuB,EAAC,MAAM,CAAC,CAAA;QAE5D,MAAM,SAAS,GAAG,GAAG,OAAO,MAAM,CAAA;QAClC,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACtB,SAAS;YACT,KAAK,EAAE,oBAAc;YACrB,KAAK,EAAE;gBACN,oBAAoB;aACpB;YACD,QAAQ,EAAE,CAAC,qBAAe,CAAC;YAC3B,KAAK,EAAE;gBACN,WAAW,EAAE;oBACZ,IAAA,4CAAsC,EAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAClE;gBACD,WAAW,EAAE,CAAC,wBAAkB,CAAC;aACjC;SACD,CAAC,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI;QACnC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAE1D,MAAM,UAAU,GAAsD,IAAI;YACzE,CAAC,CAAC;gBACA,aAAa,EAAE,UAAU,KAAK,EAAE;aAChC;YACF,CAAC,CAAC,EAAE,CAAA;QAEL,OAAO;YACN,cAAc,EAAE,kBAAkB;YAClC,YAAY,EAAE,IAAI,CAAC,eAAe;YAClC,MAAM,EAAE,KAAK;YACb,GAAG,UAAU;SACb,CAAA;IACF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE;YAC5C,IAAI,EAAE,EAAE;YACR,OAAO;SACP,CAAC,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,cAAc;QACnB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC7C,IAAI,EAAE,EAAE;YACR,OAAO;SACP,CAAC,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACzC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,YAAY,EAAE,EAAE;YACjE,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED,iBAAiB;IACjB,+CAA+C;IAC/C,8CAA8C;IAC9C,4DAA4D;IAC5D,mBAAmB;IACnB,6BAA6B;IAC7B,SAAS;IACT,IAAI;IAEJ;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,0BAA0B,CAC/B,YAAsB;QAEtB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,yCAAyC,EAAE;YAChD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;YAClC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAC,YAAoB;QACtC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,uBAAuB,YAAY,EAAE,EAAE;YACvD,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,YAAY,CAAC,QAAgB;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,MAAM,CAAC,iBAAiB,QAAQ,EAAE,EAAE;YACpC,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,uBAAuB,CAC5B,SAAmB;QAEnB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,yCAAyC,EAAE;YAChD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;YAC/B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,sBAAsB,CACrB,QAAgB,EAChB,KAAK,GAAG,CAAC,EACT,oBAAoB,GAAG,EAAE;QAEzB,OAAO,IAAI,6BAAa,CAAC;YACxB,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE;YACnC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK;YACL,iBAAiB,EAAE,oBAAoB;YACvC,QAAQ;SACR,CAAC,CAAA;IACH,CAAC;IAED,iBAAiB;IACjB,wDAAwD;IACxD,0CAA0C;IAC1C,8CAA8C;IAC9C,uDAAuD;IACvD,gBAAgB;IAChB,mBAAmB;IACnB,6BAA6B;IAC7B,gBAAgB;IAChB,IAAI;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,sBAAsB,CAAC,SAAqB;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI;aACd,IAAI,CAAC,oBAAoB,EAAE;YAC3B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;YAC/B,OAAO;SACP,CAAC;aACD,IAAI,EAAE,CAAA;IACT,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,YAAY;QACjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC1B,OAAO;SACP,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,cAAc,CACnB,YAAoB,EACpB,QAAiB;QAEjB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,8BAA8B,YAAY,EAAE,EAAE;YAC9D,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;SAC9B,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,cAAc,CAAC,cAA8B;QAClD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAC3C,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;SACpC,CAAC,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;CACD;AAvaD,8CAuaC"}
|
|
@@ -31,6 +31,7 @@ export declare class TasklistApiClient {
|
|
|
31
31
|
/**
|
|
32
32
|
* @description Query Tasklist for a list of tasks. See the [API documentation](https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/tasks/).
|
|
33
33
|
* @throws Status 400 - An error is returned when more than one search parameters among [`searchAfter`, `searchAfterOrEqual`, `searchBefore`, `searchBeforeOrEqual`] are present in request
|
|
34
|
+
* @throws {RESTError}
|
|
34
35
|
* @example
|
|
35
36
|
* ```
|
|
36
37
|
* const tasklist = new TasklistApiClient()
|
|
@@ -48,17 +49,18 @@ export declare class TasklistApiClient {
|
|
|
48
49
|
searchTasks(query: TaskSearchAfterRequest | TaskSearchAfterOrEqualRequest | TaskSearchBeforeRequest | TaskSearchBeforeOrEqualRequest | Partial<TaskSearchRequestBase>): Promise<TaskSearchResponse[]>;
|
|
49
50
|
/**
|
|
50
51
|
* @description Return a task by id, or throw if not found.
|
|
51
|
-
* @throws Will throw if no task of the given taskId exists
|
|
52
|
+
* @throws {RESTError} Will throw if no task of the given taskId exists
|
|
52
53
|
* @returns
|
|
53
54
|
*/
|
|
54
55
|
getTask(taskId: string): Promise<TaskResponse>;
|
|
55
56
|
/**
|
|
56
57
|
* @description Get the form details by form id and processDefinitionKey.
|
|
58
|
+
* @throws {RESTError}
|
|
57
59
|
*/
|
|
58
60
|
getForm(formId: string, processDefinitionKey: string, version?: string | number): Promise<Form>;
|
|
59
61
|
/**
|
|
60
62
|
* @description This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.
|
|
61
|
-
* @throws
|
|
63
|
+
* @throws {RESTError}
|
|
62
64
|
*/
|
|
63
65
|
getVariables({ taskId, variableNames, includeVariables, }: {
|
|
64
66
|
taskId: string;
|
|
@@ -75,6 +77,7 @@ export declare class TasklistApiClient {
|
|
|
75
77
|
getVariable(variableId: string): Promise<Variable>;
|
|
76
78
|
/**
|
|
77
79
|
* @description Assign a task with taskId to assignee or the active user.
|
|
80
|
+
* @throws {RESTError}
|
|
78
81
|
* @throws Status 400 - An error is returned when the task is not active (not in the CREATED state).
|
|
79
82
|
* Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true.
|
|
80
83
|
* Status 403 - An error is returned when user doesn't have the permission to assign another user to this task.
|
|
@@ -87,6 +90,7 @@ export declare class TasklistApiClient {
|
|
|
87
90
|
}): Promise<TaskResponse>;
|
|
88
91
|
/**
|
|
89
92
|
* @description Complete a task with taskId and optional variables
|
|
93
|
+
* @throws {RESTError}
|
|
90
94
|
* @throws Status 400 An error is returned when the task is not active (not in the CREATED state).
|
|
91
95
|
* @throws Status 400 An error is returned if the task was not claimed (assigned) before.
|
|
92
96
|
* @throws Status 400 An error is returned if the task is not assigned to the current user.
|
|
@@ -99,6 +103,7 @@ export declare class TasklistApiClient {
|
|
|
99
103
|
* @throws Status 400 An error is returned when the task is not active (not in the CREATED state).
|
|
100
104
|
* @throws Status 400 An error is returned if the task was not claimed (assigned) before.
|
|
101
105
|
* @throws Status 404 An error is returned when the task with the taskId is not found.
|
|
106
|
+
* @throws {RESTError}
|
|
102
107
|
*/
|
|
103
108
|
unassignTask(taskId: string): Promise<TaskResponse>;
|
|
104
109
|
}
|