-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathspec_jobcontrol.json
408 lines (408 loc) · 12.2 KB
/
spec_jobcontrol.json
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
{
"openapi": "3.1.0",
"x-stoplight": {
"id": "wh6tzb3gstrbw"
},
"info": {
"title": "Saviynt Job Control API",
"version": "1.0",
"description": "Saviynt Job Control API Spec",
"contact": {
"name": "Saviynt Developers Team",
"email": "https://github.com/saviynt"
}
},
"servers": [
{
"url": "http://localhost:3000"
}
],
"tags": [
{
"name": "Job Control"
}
],
"paths": {
"/ECM/api/v5/createUpdateTrigger": {
"post": {
"summary": "Create and Update Trigger",
"operationId": "createUpdateTrigger",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK"
}
},
"description": "This API call can be used to create and update a trigger for a particular `jobgroup` in Saviynt.\n\nStarting with Release v24.7, a new `analysistypes` parameter has been introduced for the **Recommendations** job. To execute an analysis type using this API, you can use the `analysistypes` parameter and specify the following values in its request:\n\n* 0 – Run All Steps\n* 1 – Run Attribute Discovery\n* 2 – Generate Correlation Rules\n* 3 – Rule Consolidation for Access\n* 4 – Rule Consolidation for Apps\n* 5 – Compute Access Confidence\n* 6 – Compute Model Performance Statistics\n* 7 – Incremental Rule Creation"
}
},
"/ECM/api/v5/checkJobStatus": {
"post": {
"summary": "Check Job Status",
"operationId": "checkJobStatus",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckJobStatusResponse"
}
}
}
}
},
"description": "This API is used to fetch the status of any job other than Data Import Job.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CheckJobStatusRequest"
}
}
},
"description": ""
}
}
},
"/ECM/api/v5/deleteTrigger": {
"post": {
"summary": "Delete Trigger",
"operationId": "deleteTrigger",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK"
}
},
"description": "This API call can be used to delete a trigger for a particular \"jobgroup\" in Saviynt."
}
},
"/ECM/api/v5/runJobTrigger": {
"post": {
"summary": "Run Job Trigger",
"operationId": "runJobTrigger",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK"
}
},
"description": "This API call can be used to run a job trigger in Saviynt.\n\nThe following cases illustrate different scenarios on the usage of the `analyticsAdvanceQuery` parameter in the API:\n\n* Case 1: When you configure the `analyticsAdvanceQuery` within the payload, set the `defaultActionForAnalytics` as `\"true\"`, and then execute the control from the API, it overrides the default action and the advanced query configuration within the job trigger.\n* Case 2: When you configure the `analyticsAdvanceQuery` within the payload, set the `defaultActionForAnalytics` as `\"false\"`, and then execute the control from the API without performing the default actions configured in the control, it overrides the default action and the advanced query configuration within the job trigger.\n* Case 3: When you do not configure both the `analyticsAdvanceQuery` and the `defaultActionForAnalytics`x, the default action will depend on the configuration provided in the analytics job trigger.\n\nThe following cases illustrate different scenarios on the usage of the `analyticsCategories` parameter in the API:\n\n* Case 1: When you set the \"defaultActionForAnalytics\" as \"true\" to perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger.\n* Case 2: When you set the \"defaultActionForAnalytics\" as \"false\" to not perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger.\n* Case 3: When the defaultActionForAnalytics parameter is not set in the payload, the default action will depend on the configuration provided in the analytics job trigger."
}
},
"/ECM/api/v5/fetchJobMetadata": {
"post": {
"summary": "Fetch Job Metadata",
"operationId": "fetchJobMetadata",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchJobMetadataResponse"
}
}
}
}
},
"description": "This API call return job metadata for the last run of a job in Saviynt.\n\nNote: The structure of the result param in response can change based upon the Job History saved in Saviynt",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchJobMetadataRequest"
}
}
}
}
}
},
"/ECM/api/v5/createTriggers": {
"post": {
"summary": "Create Triggers",
"operationId": "createTriggers",
"description": "This API is used to create job triggers.",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/ECM/api/v5/resumePauseJobs": {
"post": {
"summary": "Resume Pause Jobs",
"operationId": "resumePauseJobs",
"tags": [
"Job Control"
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"Successful Pause": {
"value": "Job(s) Paused successfully"
},
"Successful Resume": {
"value": "Job(s) Resumed successfully"
},
"Error on No Triggers": {
"value": "No triggers found"
}
}
}
}
},
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
},
"description": "Starting with Release v23.10, the `resumePauseJobs` API enables you to pause jobs based on their job type and job name.\n\nWhen a job is paused, its status is displayed as Paused on the Job Control Panel page.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResumePauseJobsRequest"
}
}
}
}
}
}
},
"components": {
"schemas": {
"CheckJobStatusRequest": {
"title": "CheckJobStatusRequest",
"x-stoplight": {
"id": "sgskilxuqx1ng"
},
"type": "object",
"properties": {
"jobgroup": {
"type": "string",
"x-stoplight": {
"id": "8ypc6y1fo4t4n"
}
},
"jobname": {
"type": "string",
"x-stoplight": {
"id": "afvzbom2l6dmo"
}
}
},
"required": [
"jobgroup",
"jobname"
]
},
"CheckJobStatusResponse": {
"title": "CheckJobStatusResponse",
"x-stoplight": {
"id": "2gqodxah1rk0u"
},
"type": "object",
"properties": {
"msg": {
"type": "string",
"x-stoplight": {
"id": "8f07qxf5fpmnu"
}
},
"errorCode": {
"type": "string",
"x-stoplight": {
"id": "vywsiuk8okt0v"
}
}
}
},
"DeleteTriggerRequest": {
"title": "DeleteTriggerRequest",
"x-stoplight": {
"id": "c2oolhf2vbnmh"
},
"type": "object",
"properties": {
"jobname": {
"type": "string",
"x-stoplight": {
"id": "s5k92socxnck0"
}
},
"triggername": {
"type": "string",
"x-stoplight": {
"id": "f5egb9c3qcldo"
}
},
"jobgroup": {
"type": "string",
"x-stoplight": {
"id": "ze7cut4s3g2r0"
}
}
},
"required": [
"jobname"
]
},
"FetchJobMetadataRequest": {
"title": "FetchJobMetadataRequest",
"x-stoplight": {
"id": "t7fzs0it0fdhv"
},
"type": "object",
"properties": {
"jobname": {
"type": "string",
"x-stoplight": {
"id": "debkp5wftr5l6"
}
},
"triggername": {
"type": "string",
"x-stoplight": {
"id": "qt5w1qws7s64s"
}
},
"jobgroup": {
"type": "string",
"x-stoplight": {
"id": "eg0od7k6qppj3"
}
}
},
"required": [
"jobname"
],
"description": ""
},
"FetchJobMetadataResponse": {
"title": "FetchJobMetadataResponse",
"x-stoplight": {
"id": "r6jctqk6z8npb"
},
"type": "object",
"properties": {
"msg": {
"type": "string",
"x-stoplight": {
"id": "s5h1a3wf6stjx"
}
},
"errorCode": {
"type": "integer",
"x-stoplight": {
"id": "5cjzjtra4phal"
}
},
"result": {
"type": "object",
"additionalProperties": true,
"x-stoplight": {
"id": "t99p2zgl9t1al"
}
}
}
},
"DeleteTriggerResponse": {
"title": "DeleteTriggerResponse",
"x-stoplight": {
"id": "5hebwug4olh4h"
},
"type": "object",
"properties": {
"msg": {
"type": "string",
"x-stoplight": {
"id": "1kzo52rrekugx"
}
},
"errorCode": {
"type": "string",
"x-stoplight": {
"id": "f755k6c3mpnec"
}
}
}
},
"ResumePauseJobsRequest": {
"title": "ResumePauseJobsRequest",
"x-stoplight": {
"id": "ru7xvuen9hqhr"
},
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"PAUSE",
"RESUME"
],
"x-stoplight": {
"id": "527d2rxyp6gw3"
}
},
"triggername": {
"type": "string",
"x-stoplight": {
"id": "cmbimxzyk4and"
}
},
"jobname": {
"type": "string",
"x-stoplight": {
"id": "979nwfj8yobyy"
}
}
},
"required": [
"action"
]
},
"ResumePauseJobsResponse": {
"title": "ResumePauseJobsResponse",
"x-stoplight": {
"id": "jq15kv6uajh6e"
},
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}
}