@corva/ui 3.66.0-rc.1 → 3.66.0
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/mcp-server/server.mjs +3264 -578
- package/package.json +1 -1
package/mcp-server/server.mjs
CHANGED
|
@@ -231,7 +231,7 @@ const validateDsn = (dsn) => {
|
|
|
231
231
|
|
|
232
232
|
const MCP_SERVER_VERSION = '1.3.0';
|
|
233
233
|
|
|
234
|
-
var version = "3.66.0
|
|
234
|
+
var version = "3.66.0";
|
|
235
235
|
|
|
236
236
|
const CORVA_UI_VERSION = version;
|
|
237
237
|
|
|
@@ -19675,11 +19675,22 @@ var clientsData = [
|
|
|
19675
19675
|
"enable",
|
|
19676
19676
|
"disable",
|
|
19677
19677
|
"alertdefinitions",
|
|
19678
|
-
"
|
|
19678
|
+
"subscribe",
|
|
19679
|
+
"unsubscribe",
|
|
19679
19680
|
"alert_groups",
|
|
19681
|
+
"alert_definitions",
|
|
19682
|
+
"alertgroups",
|
|
19680
19683
|
"alert_group_users",
|
|
19681
19684
|
"alert_group_assets",
|
|
19682
19685
|
"alert_group_configurations",
|
|
19686
|
+
"bulk_create",
|
|
19687
|
+
"bulk_destroy",
|
|
19688
|
+
"alertrbac",
|
|
19689
|
+
"alert_abilities",
|
|
19690
|
+
"companies",
|
|
19691
|
+
"alert_roles",
|
|
19692
|
+
"abilities",
|
|
19693
|
+
"alert_rbac",
|
|
19683
19694
|
"occurrences",
|
|
19684
19695
|
"acknowledge",
|
|
19685
19696
|
"classify",
|
|
@@ -19723,7 +19734,6 @@ var clientsData = [
|
|
|
19723
19734
|
"dashboards",
|
|
19724
19735
|
"users",
|
|
19725
19736
|
"dashboard_apps",
|
|
19726
|
-
"bulk_create",
|
|
19727
19737
|
"batch_update",
|
|
19728
19738
|
"dashboard_folders",
|
|
19729
19739
|
"dashboard_shares",
|
|
@@ -19732,6 +19742,12 @@ var clientsData = [
|
|
|
19732
19742
|
"clone",
|
|
19733
19743
|
"use_template",
|
|
19734
19744
|
"available_timezones",
|
|
19745
|
+
"well plan checklists",
|
|
19746
|
+
"well_plan_checklists",
|
|
19747
|
+
"well plans",
|
|
19748
|
+
"well_plans",
|
|
19749
|
+
"well plan tabs",
|
|
19750
|
+
"well_plan_tabs",
|
|
19735
19751
|
"well planning dashboards",
|
|
19736
19752
|
"well_planning_dashboards",
|
|
19737
19753
|
"data",
|
|
@@ -19767,9 +19783,7 @@ var clientsData = [
|
|
|
19767
19783
|
"count",
|
|
19768
19784
|
"unread",
|
|
19769
19785
|
"security_policies",
|
|
19770
|
-
"companies",
|
|
19771
19786
|
"permissions",
|
|
19772
|
-
"bulk_destroy",
|
|
19773
19787
|
"grouped",
|
|
19774
19788
|
"picklists",
|
|
19775
19789
|
"items",
|
|
@@ -19876,8 +19890,6 @@ var clientsData = [
|
|
|
19876
19890
|
"update_package",
|
|
19877
19891
|
"apperroralert",
|
|
19878
19892
|
"app_error_alerts",
|
|
19879
|
-
"subscribe",
|
|
19880
|
-
"unsubscribe",
|
|
19881
19893
|
"usage",
|
|
19882
19894
|
"summaries",
|
|
19883
19895
|
"workflows",
|
|
@@ -19959,6 +19971,8 @@ var clientsData = [
|
|
|
19959
19971
|
"test_connection",
|
|
19960
19972
|
"api_key_audits",
|
|
19961
19973
|
"typewells",
|
|
19974
|
+
"welldrilloutunitruns",
|
|
19975
|
+
"well_drillout_unit_runs",
|
|
19962
19976
|
"padfracfleets",
|
|
19963
19977
|
"pad_frac_fleets",
|
|
19964
19978
|
"fracfleetcontracts",
|
|
@@ -21068,6 +21082,13 @@ var clientsData = [
|
|
|
21068
21082
|
required: false,
|
|
21069
21083
|
description: "Filter by type (personal/company)"
|
|
21070
21084
|
},
|
|
21085
|
+
{
|
|
21086
|
+
name: "alert_group_id",
|
|
21087
|
+
"in": "query",
|
|
21088
|
+
type: "string",
|
|
21089
|
+
required: false,
|
|
21090
|
+
description: "Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"
|
|
21091
|
+
},
|
|
21071
21092
|
{
|
|
21072
21093
|
name: "search",
|
|
21073
21094
|
"in": "query",
|
|
@@ -21075,6 +21096,13 @@ var clientsData = [
|
|
|
21075
21096
|
required: false,
|
|
21076
21097
|
description: "Search by name"
|
|
21077
21098
|
},
|
|
21099
|
+
{
|
|
21100
|
+
name: "segment",
|
|
21101
|
+
"in": "query",
|
|
21102
|
+
type: "string",
|
|
21103
|
+
required: false,
|
|
21104
|
+
description: "Filter by segment: a single key or a comma-separated list (e.g. \"drilling,completion\"). Matches definitions whose segment array overlaps the given values."
|
|
21105
|
+
},
|
|
21078
21106
|
{
|
|
21079
21107
|
name: "page",
|
|
21080
21108
|
"in": "query",
|
|
@@ -21252,39 +21280,29 @@ var clientsData = [
|
|
|
21252
21280
|
}
|
|
21253
21281
|
},
|
|
21254
21282
|
{
|
|
21255
|
-
path: "/v2/
|
|
21256
|
-
method: "
|
|
21257
|
-
summary: "
|
|
21283
|
+
path: "/v2/alerts/definitions/{id}/subscribe",
|
|
21284
|
+
method: "POST",
|
|
21285
|
+
summary: "Subscribe to Alert Definition",
|
|
21258
21286
|
tags: [
|
|
21259
|
-
"
|
|
21287
|
+
"AlertDefinitions"
|
|
21260
21288
|
],
|
|
21261
21289
|
parameters: [
|
|
21262
21290
|
{
|
|
21263
|
-
name: "
|
|
21264
|
-
"in": "
|
|
21265
|
-
type: "string",
|
|
21266
|
-
required: false,
|
|
21267
|
-
description: "Search by name"
|
|
21268
|
-
},
|
|
21269
|
-
{
|
|
21270
|
-
name: "page",
|
|
21271
|
-
"in": "query",
|
|
21272
|
-
type: "integer",
|
|
21273
|
-
required: false,
|
|
21274
|
-
description: "Page number"
|
|
21275
|
-
},
|
|
21276
|
-
{
|
|
21277
|
-
name: "per_page",
|
|
21278
|
-
"in": "query",
|
|
21291
|
+
name: "id",
|
|
21292
|
+
"in": "path",
|
|
21279
21293
|
type: "integer",
|
|
21280
|
-
required:
|
|
21281
|
-
description: "
|
|
21294
|
+
required: true,
|
|
21295
|
+
description: ""
|
|
21282
21296
|
}
|
|
21283
21297
|
],
|
|
21298
|
+
requestBody: {
|
|
21299
|
+
contentType: "application/json",
|
|
21300
|
+
schema: "any",
|
|
21301
|
+
required: false
|
|
21302
|
+
},
|
|
21284
21303
|
responses: {
|
|
21285
21304
|
"200": {
|
|
21286
|
-
description: "
|
|
21287
|
-
schema: "any"
|
|
21305
|
+
description: "Subscription created; activates an inactive definition"
|
|
21288
21306
|
},
|
|
21289
21307
|
"401": {
|
|
21290
21308
|
description: "Authentication error",
|
|
@@ -21297,27 +21315,31 @@ var clientsData = [
|
|
|
21297
21315
|
"404": {
|
|
21298
21316
|
description: "Not found error",
|
|
21299
21317
|
schema: "any"
|
|
21318
|
+
},
|
|
21319
|
+
"409": {
|
|
21320
|
+
description: "Subscription already exists"
|
|
21300
21321
|
}
|
|
21301
21322
|
}
|
|
21302
21323
|
},
|
|
21303
21324
|
{
|
|
21304
|
-
path: "/v2/
|
|
21325
|
+
path: "/v2/alerts/definitions/{id}/unsubscribe",
|
|
21305
21326
|
method: "POST",
|
|
21306
|
-
summary: "
|
|
21327
|
+
summary: "Unsubscribe from Alert Definition",
|
|
21307
21328
|
tags: [
|
|
21308
|
-
"
|
|
21329
|
+
"AlertDefinitions"
|
|
21309
21330
|
],
|
|
21310
21331
|
parameters: [
|
|
21332
|
+
{
|
|
21333
|
+
name: "id",
|
|
21334
|
+
"in": "path",
|
|
21335
|
+
type: "integer",
|
|
21336
|
+
required: true,
|
|
21337
|
+
description: ""
|
|
21338
|
+
}
|
|
21311
21339
|
],
|
|
21312
|
-
requestBody: {
|
|
21313
|
-
contentType: "application/json",
|
|
21314
|
-
schema: "any",
|
|
21315
|
-
required: true
|
|
21316
|
-
},
|
|
21317
21340
|
responses: {
|
|
21318
21341
|
"200": {
|
|
21319
|
-
description: "
|
|
21320
|
-
schema: "any"
|
|
21342
|
+
description: "Unsubscribed; deactivates a personal definition left without subscriptions"
|
|
21321
21343
|
},
|
|
21322
21344
|
"401": {
|
|
21323
21345
|
description: "Authentication error",
|
|
@@ -21334,24 +21356,52 @@ var clientsData = [
|
|
|
21334
21356
|
}
|
|
21335
21357
|
},
|
|
21336
21358
|
{
|
|
21337
|
-
path: "/v2/alert_groups/{
|
|
21359
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_definitions",
|
|
21338
21360
|
method: "GET",
|
|
21339
|
-
summary: "
|
|
21361
|
+
summary: "List an Alert Group's Definitions",
|
|
21340
21362
|
tags: [
|
|
21341
|
-
"
|
|
21363
|
+
"AlertDefinitions"
|
|
21342
21364
|
],
|
|
21343
21365
|
parameters: [
|
|
21344
21366
|
{
|
|
21345
|
-
name: "
|
|
21367
|
+
name: "alert_group_id",
|
|
21346
21368
|
"in": "path",
|
|
21347
21369
|
type: "integer",
|
|
21348
21370
|
required: true,
|
|
21349
|
-
description: ""
|
|
21371
|
+
description: "Alert group ID"
|
|
21372
|
+
},
|
|
21373
|
+
{
|
|
21374
|
+
name: "type",
|
|
21375
|
+
"in": "query",
|
|
21376
|
+
type: "string",
|
|
21377
|
+
required: false,
|
|
21378
|
+
description: "Filter by type (personal/company)"
|
|
21379
|
+
},
|
|
21380
|
+
{
|
|
21381
|
+
name: "search",
|
|
21382
|
+
"in": "query",
|
|
21383
|
+
type: "string",
|
|
21384
|
+
required: false,
|
|
21385
|
+
description: "Search by name"
|
|
21386
|
+
},
|
|
21387
|
+
{
|
|
21388
|
+
name: "page",
|
|
21389
|
+
"in": "query",
|
|
21390
|
+
type: "integer",
|
|
21391
|
+
required: false,
|
|
21392
|
+
description: "Page number"
|
|
21393
|
+
},
|
|
21394
|
+
{
|
|
21395
|
+
name: "per_page",
|
|
21396
|
+
"in": "query",
|
|
21397
|
+
type: "integer",
|
|
21398
|
+
required: false,
|
|
21399
|
+
description: "Items per page"
|
|
21350
21400
|
}
|
|
21351
21401
|
],
|
|
21352
21402
|
responses: {
|
|
21353
21403
|
"200": {
|
|
21354
|
-
description: "
|
|
21404
|
+
description: "The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",
|
|
21355
21405
|
schema: "any"
|
|
21356
21406
|
},
|
|
21357
21407
|
"401": {
|
|
@@ -21369,29 +21419,38 @@ var clientsData = [
|
|
|
21369
21419
|
}
|
|
21370
21420
|
},
|
|
21371
21421
|
{
|
|
21372
|
-
path: "/v2/alert_groups
|
|
21373
|
-
method: "
|
|
21374
|
-
summary: "
|
|
21422
|
+
path: "/v2/alert_groups",
|
|
21423
|
+
method: "GET",
|
|
21424
|
+
summary: "List Alert Groups",
|
|
21375
21425
|
tags: [
|
|
21376
21426
|
"AlertGroups"
|
|
21377
21427
|
],
|
|
21378
21428
|
parameters: [
|
|
21379
21429
|
{
|
|
21380
|
-
name: "
|
|
21381
|
-
"in": "
|
|
21430
|
+
name: "search",
|
|
21431
|
+
"in": "query",
|
|
21432
|
+
type: "string",
|
|
21433
|
+
required: false,
|
|
21434
|
+
description: "Search by name"
|
|
21435
|
+
},
|
|
21436
|
+
{
|
|
21437
|
+
name: "page",
|
|
21438
|
+
"in": "query",
|
|
21382
21439
|
type: "integer",
|
|
21383
|
-
required:
|
|
21384
|
-
description: ""
|
|
21440
|
+
required: false,
|
|
21441
|
+
description: "Page number"
|
|
21442
|
+
},
|
|
21443
|
+
{
|
|
21444
|
+
name: "per_page",
|
|
21445
|
+
"in": "query",
|
|
21446
|
+
type: "integer",
|
|
21447
|
+
required: false,
|
|
21448
|
+
description: "Items per page"
|
|
21385
21449
|
}
|
|
21386
21450
|
],
|
|
21387
|
-
requestBody: {
|
|
21388
|
-
contentType: "application/json",
|
|
21389
|
-
schema: "any",
|
|
21390
|
-
required: true
|
|
21391
|
-
},
|
|
21392
21451
|
responses: {
|
|
21393
21452
|
"200": {
|
|
21394
|
-
description: "
|
|
21453
|
+
description: "List of alert groups",
|
|
21395
21454
|
schema: "any"
|
|
21396
21455
|
},
|
|
21397
21456
|
"401": {
|
|
@@ -21409,24 +21468,23 @@ var clientsData = [
|
|
|
21409
21468
|
}
|
|
21410
21469
|
},
|
|
21411
21470
|
{
|
|
21412
|
-
path: "/v2/alert_groups
|
|
21413
|
-
method: "
|
|
21414
|
-
summary: "
|
|
21471
|
+
path: "/v2/alert_groups",
|
|
21472
|
+
method: "POST",
|
|
21473
|
+
summary: "Create Alert Group",
|
|
21415
21474
|
tags: [
|
|
21416
21475
|
"AlertGroups"
|
|
21417
21476
|
],
|
|
21418
21477
|
parameters: [
|
|
21419
|
-
{
|
|
21420
|
-
name: "id",
|
|
21421
|
-
"in": "path",
|
|
21422
|
-
type: "integer",
|
|
21423
|
-
required: true,
|
|
21424
|
-
description: ""
|
|
21425
|
-
}
|
|
21426
21478
|
],
|
|
21479
|
+
requestBody: {
|
|
21480
|
+
contentType: "application/json",
|
|
21481
|
+
schema: "any",
|
|
21482
|
+
required: true
|
|
21483
|
+
},
|
|
21427
21484
|
responses: {
|
|
21428
21485
|
"200": {
|
|
21429
|
-
description: "
|
|
21486
|
+
description: "Created alert group",
|
|
21487
|
+
schema: "any"
|
|
21430
21488
|
},
|
|
21431
21489
|
"401": {
|
|
21432
21490
|
description: "Authentication error",
|
|
@@ -21443,15 +21501,15 @@ var clientsData = [
|
|
|
21443
21501
|
}
|
|
21444
21502
|
},
|
|
21445
21503
|
{
|
|
21446
|
-
path: "/v2/alert_groups/{
|
|
21504
|
+
path: "/v2/alert_groups/{id}",
|
|
21447
21505
|
method: "GET",
|
|
21448
|
-
summary: "
|
|
21506
|
+
summary: "Get Alert Group",
|
|
21449
21507
|
tags: [
|
|
21450
21508
|
"AlertGroups"
|
|
21451
21509
|
],
|
|
21452
21510
|
parameters: [
|
|
21453
21511
|
{
|
|
21454
|
-
name: "
|
|
21512
|
+
name: "id",
|
|
21455
21513
|
"in": "path",
|
|
21456
21514
|
type: "integer",
|
|
21457
21515
|
required: true,
|
|
@@ -21460,7 +21518,7 @@ var clientsData = [
|
|
|
21460
21518
|
],
|
|
21461
21519
|
responses: {
|
|
21462
21520
|
"200": {
|
|
21463
|
-
description: "
|
|
21521
|
+
description: "Alert group details",
|
|
21464
21522
|
schema: "any"
|
|
21465
21523
|
},
|
|
21466
21524
|
"401": {
|
|
@@ -21478,15 +21536,15 @@ var clientsData = [
|
|
|
21478
21536
|
}
|
|
21479
21537
|
},
|
|
21480
21538
|
{
|
|
21481
|
-
path: "/v2/alert_groups/{
|
|
21482
|
-
method: "
|
|
21483
|
-
summary: "
|
|
21539
|
+
path: "/v2/alert_groups/{id}",
|
|
21540
|
+
method: "PATCH",
|
|
21541
|
+
summary: "Update Alert Group",
|
|
21484
21542
|
tags: [
|
|
21485
21543
|
"AlertGroups"
|
|
21486
21544
|
],
|
|
21487
21545
|
parameters: [
|
|
21488
21546
|
{
|
|
21489
|
-
name: "
|
|
21547
|
+
name: "id",
|
|
21490
21548
|
"in": "path",
|
|
21491
21549
|
type: "integer",
|
|
21492
21550
|
required: true,
|
|
@@ -21500,7 +21558,7 @@ var clientsData = [
|
|
|
21500
21558
|
},
|
|
21501
21559
|
responses: {
|
|
21502
21560
|
"200": {
|
|
21503
|
-
description: "
|
|
21561
|
+
description: "Updated alert group",
|
|
21504
21562
|
schema: "any"
|
|
21505
21563
|
},
|
|
21506
21564
|
"401": {
|
|
@@ -21518,20 +21576,13 @@ var clientsData = [
|
|
|
21518
21576
|
}
|
|
21519
21577
|
},
|
|
21520
21578
|
{
|
|
21521
|
-
path: "/v2/alert_groups/{
|
|
21579
|
+
path: "/v2/alert_groups/{id}",
|
|
21522
21580
|
method: "DELETE",
|
|
21523
|
-
summary: "
|
|
21581
|
+
summary: "Delete Alert Group",
|
|
21524
21582
|
tags: [
|
|
21525
21583
|
"AlertGroups"
|
|
21526
21584
|
],
|
|
21527
21585
|
parameters: [
|
|
21528
|
-
{
|
|
21529
|
-
name: "alert_group_id",
|
|
21530
|
-
"in": "path",
|
|
21531
|
-
type: "integer",
|
|
21532
|
-
required: true,
|
|
21533
|
-
description: ""
|
|
21534
|
-
},
|
|
21535
21586
|
{
|
|
21536
21587
|
name: "id",
|
|
21537
21588
|
"in": "path",
|
|
@@ -21542,7 +21593,7 @@ var clientsData = [
|
|
|
21542
21593
|
],
|
|
21543
21594
|
responses: {
|
|
21544
21595
|
"200": {
|
|
21545
|
-
description: "
|
|
21596
|
+
description: "Deleted"
|
|
21546
21597
|
},
|
|
21547
21598
|
"401": {
|
|
21548
21599
|
description: "Authentication error",
|
|
@@ -21559,9 +21610,9 @@ var clientsData = [
|
|
|
21559
21610
|
}
|
|
21560
21611
|
},
|
|
21561
21612
|
{
|
|
21562
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21613
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
21563
21614
|
method: "GET",
|
|
21564
|
-
summary: "List Group
|
|
21615
|
+
summary: "List Group Members",
|
|
21565
21616
|
tags: [
|
|
21566
21617
|
"AlertGroups"
|
|
21567
21618
|
],
|
|
@@ -21576,7 +21627,7 @@ var clientsData = [
|
|
|
21576
21627
|
],
|
|
21577
21628
|
responses: {
|
|
21578
21629
|
"200": {
|
|
21579
|
-
description: "List of group
|
|
21630
|
+
description: "List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",
|
|
21580
21631
|
schema: "any"
|
|
21581
21632
|
},
|
|
21582
21633
|
"401": {
|
|
@@ -21594,9 +21645,9 @@ var clientsData = [
|
|
|
21594
21645
|
}
|
|
21595
21646
|
},
|
|
21596
21647
|
{
|
|
21597
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21648
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
21598
21649
|
method: "POST",
|
|
21599
|
-
summary: "Add
|
|
21650
|
+
summary: "Add Member to Group",
|
|
21600
21651
|
tags: [
|
|
21601
21652
|
"AlertGroups"
|
|
21602
21653
|
],
|
|
@@ -21616,7 +21667,7 @@ var clientsData = [
|
|
|
21616
21667
|
},
|
|
21617
21668
|
responses: {
|
|
21618
21669
|
"200": {
|
|
21619
|
-
description: "Added
|
|
21670
|
+
description: "Added member",
|
|
21620
21671
|
schema: "any"
|
|
21621
21672
|
},
|
|
21622
21673
|
"401": {
|
|
@@ -21634,9 +21685,9 @@ var clientsData = [
|
|
|
21634
21685
|
}
|
|
21635
21686
|
},
|
|
21636
21687
|
{
|
|
21637
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21688
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",
|
|
21638
21689
|
method: "DELETE",
|
|
21639
|
-
summary: "Remove
|
|
21690
|
+
summary: "Remove Member from Group",
|
|
21640
21691
|
tags: [
|
|
21641
21692
|
"AlertGroups"
|
|
21642
21693
|
],
|
|
@@ -21675,9 +21726,9 @@ var clientsData = [
|
|
|
21675
21726
|
}
|
|
21676
21727
|
},
|
|
21677
21728
|
{
|
|
21678
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21729
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
21679
21730
|
method: "GET",
|
|
21680
|
-
summary: "List Group
|
|
21731
|
+
summary: "List Group Assets",
|
|
21681
21732
|
tags: [
|
|
21682
21733
|
"AlertGroups"
|
|
21683
21734
|
],
|
|
@@ -21692,7 +21743,7 @@ var clientsData = [
|
|
|
21692
21743
|
],
|
|
21693
21744
|
responses: {
|
|
21694
21745
|
"200": {
|
|
21695
|
-
description: "List of
|
|
21746
|
+
description: "List of group assets",
|
|
21696
21747
|
schema: "any"
|
|
21697
21748
|
},
|
|
21698
21749
|
"401": {
|
|
@@ -21710,49 +21761,9 @@ var clientsData = [
|
|
|
21710
21761
|
}
|
|
21711
21762
|
},
|
|
21712
21763
|
{
|
|
21713
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21764
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
21714
21765
|
method: "POST",
|
|
21715
|
-
summary: "
|
|
21716
|
-
tags: [
|
|
21717
|
-
"AlertGroups"
|
|
21718
|
-
],
|
|
21719
|
-
parameters: [
|
|
21720
|
-
{
|
|
21721
|
-
name: "alert_group_id",
|
|
21722
|
-
"in": "path",
|
|
21723
|
-
type: "integer",
|
|
21724
|
-
required: true,
|
|
21725
|
-
description: ""
|
|
21726
|
-
}
|
|
21727
|
-
],
|
|
21728
|
-
requestBody: {
|
|
21729
|
-
contentType: "application/json",
|
|
21730
|
-
schema: "any",
|
|
21731
|
-
required: true
|
|
21732
|
-
},
|
|
21733
|
-
responses: {
|
|
21734
|
-
"200": {
|
|
21735
|
-
description: "Created configuration",
|
|
21736
|
-
schema: "any"
|
|
21737
|
-
},
|
|
21738
|
-
"401": {
|
|
21739
|
-
description: "Authentication error",
|
|
21740
|
-
schema: "any"
|
|
21741
|
-
},
|
|
21742
|
-
"403": {
|
|
21743
|
-
description: "Authorization error",
|
|
21744
|
-
schema: "any"
|
|
21745
|
-
},
|
|
21746
|
-
"404": {
|
|
21747
|
-
description: "Not found error",
|
|
21748
|
-
schema: "any"
|
|
21749
|
-
}
|
|
21750
|
-
}
|
|
21751
|
-
},
|
|
21752
|
-
{
|
|
21753
|
-
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
21754
|
-
method: "PATCH",
|
|
21755
|
-
summary: "Update Group Configuration",
|
|
21766
|
+
summary: "Add Asset to Group",
|
|
21756
21767
|
tags: [
|
|
21757
21768
|
"AlertGroups"
|
|
21758
21769
|
],
|
|
@@ -21763,13 +21774,6 @@ var clientsData = [
|
|
|
21763
21774
|
type: "integer",
|
|
21764
21775
|
required: true,
|
|
21765
21776
|
description: ""
|
|
21766
|
-
},
|
|
21767
|
-
{
|
|
21768
|
-
name: "id",
|
|
21769
|
-
"in": "path",
|
|
21770
|
-
type: "integer",
|
|
21771
|
-
required: true,
|
|
21772
|
-
description: ""
|
|
21773
21777
|
}
|
|
21774
21778
|
],
|
|
21775
21779
|
requestBody: {
|
|
@@ -21779,7 +21783,7 @@ var clientsData = [
|
|
|
21779
21783
|
},
|
|
21780
21784
|
responses: {
|
|
21781
21785
|
"200": {
|
|
21782
|
-
description: "
|
|
21786
|
+
description: "Added asset",
|
|
21783
21787
|
schema: "any"
|
|
21784
21788
|
},
|
|
21785
21789
|
"401": {
|
|
@@ -21797,9 +21801,172 @@ var clientsData = [
|
|
|
21797
21801
|
}
|
|
21798
21802
|
},
|
|
21799
21803
|
{
|
|
21800
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
21804
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/{id}",
|
|
21801
21805
|
method: "DELETE",
|
|
21802
|
-
summary: "
|
|
21806
|
+
summary: "Remove Asset from Group",
|
|
21807
|
+
tags: [
|
|
21808
|
+
"AlertGroups"
|
|
21809
|
+
],
|
|
21810
|
+
parameters: [
|
|
21811
|
+
{
|
|
21812
|
+
name: "alert_group_id",
|
|
21813
|
+
"in": "path",
|
|
21814
|
+
type: "integer",
|
|
21815
|
+
required: true,
|
|
21816
|
+
description: ""
|
|
21817
|
+
},
|
|
21818
|
+
{
|
|
21819
|
+
name: "id",
|
|
21820
|
+
"in": "path",
|
|
21821
|
+
type: "integer",
|
|
21822
|
+
required: true,
|
|
21823
|
+
description: ""
|
|
21824
|
+
}
|
|
21825
|
+
],
|
|
21826
|
+
responses: {
|
|
21827
|
+
"200": {
|
|
21828
|
+
description: "Removed"
|
|
21829
|
+
},
|
|
21830
|
+
"401": {
|
|
21831
|
+
description: "Authentication error",
|
|
21832
|
+
schema: "any"
|
|
21833
|
+
},
|
|
21834
|
+
"403": {
|
|
21835
|
+
description: "Authorization error",
|
|
21836
|
+
schema: "any"
|
|
21837
|
+
},
|
|
21838
|
+
"404": {
|
|
21839
|
+
description: "Not found error",
|
|
21840
|
+
schema: "any"
|
|
21841
|
+
}
|
|
21842
|
+
}
|
|
21843
|
+
},
|
|
21844
|
+
{
|
|
21845
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
21846
|
+
method: "GET",
|
|
21847
|
+
summary: "List Group Configurations",
|
|
21848
|
+
tags: [
|
|
21849
|
+
"AlertGroups"
|
|
21850
|
+
],
|
|
21851
|
+
parameters: [
|
|
21852
|
+
{
|
|
21853
|
+
name: "alert_group_id",
|
|
21854
|
+
"in": "path",
|
|
21855
|
+
type: "integer",
|
|
21856
|
+
required: true,
|
|
21857
|
+
description: ""
|
|
21858
|
+
}
|
|
21859
|
+
],
|
|
21860
|
+
responses: {
|
|
21861
|
+
"200": {
|
|
21862
|
+
description: "List of configurations",
|
|
21863
|
+
schema: "any"
|
|
21864
|
+
},
|
|
21865
|
+
"401": {
|
|
21866
|
+
description: "Authentication error",
|
|
21867
|
+
schema: "any"
|
|
21868
|
+
},
|
|
21869
|
+
"403": {
|
|
21870
|
+
description: "Authorization error",
|
|
21871
|
+
schema: "any"
|
|
21872
|
+
},
|
|
21873
|
+
"404": {
|
|
21874
|
+
description: "Not found error",
|
|
21875
|
+
schema: "any"
|
|
21876
|
+
}
|
|
21877
|
+
}
|
|
21878
|
+
},
|
|
21879
|
+
{
|
|
21880
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
21881
|
+
method: "POST",
|
|
21882
|
+
summary: "Create Group Configuration",
|
|
21883
|
+
tags: [
|
|
21884
|
+
"AlertGroups"
|
|
21885
|
+
],
|
|
21886
|
+
parameters: [
|
|
21887
|
+
{
|
|
21888
|
+
name: "alert_group_id",
|
|
21889
|
+
"in": "path",
|
|
21890
|
+
type: "integer",
|
|
21891
|
+
required: true,
|
|
21892
|
+
description: ""
|
|
21893
|
+
}
|
|
21894
|
+
],
|
|
21895
|
+
requestBody: {
|
|
21896
|
+
contentType: "application/json",
|
|
21897
|
+
schema: "any",
|
|
21898
|
+
required: true
|
|
21899
|
+
},
|
|
21900
|
+
responses: {
|
|
21901
|
+
"200": {
|
|
21902
|
+
description: "Created configuration",
|
|
21903
|
+
schema: "any"
|
|
21904
|
+
},
|
|
21905
|
+
"401": {
|
|
21906
|
+
description: "Authentication error",
|
|
21907
|
+
schema: "any"
|
|
21908
|
+
},
|
|
21909
|
+
"403": {
|
|
21910
|
+
description: "Authorization error",
|
|
21911
|
+
schema: "any"
|
|
21912
|
+
},
|
|
21913
|
+
"404": {
|
|
21914
|
+
description: "Not found error",
|
|
21915
|
+
schema: "any"
|
|
21916
|
+
}
|
|
21917
|
+
}
|
|
21918
|
+
},
|
|
21919
|
+
{
|
|
21920
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
21921
|
+
method: "PATCH",
|
|
21922
|
+
summary: "Update Group Configuration",
|
|
21923
|
+
tags: [
|
|
21924
|
+
"AlertGroups"
|
|
21925
|
+
],
|
|
21926
|
+
parameters: [
|
|
21927
|
+
{
|
|
21928
|
+
name: "alert_group_id",
|
|
21929
|
+
"in": "path",
|
|
21930
|
+
type: "integer",
|
|
21931
|
+
required: true,
|
|
21932
|
+
description: ""
|
|
21933
|
+
},
|
|
21934
|
+
{
|
|
21935
|
+
name: "id",
|
|
21936
|
+
"in": "path",
|
|
21937
|
+
type: "integer",
|
|
21938
|
+
required: true,
|
|
21939
|
+
description: ""
|
|
21940
|
+
}
|
|
21941
|
+
],
|
|
21942
|
+
requestBody: {
|
|
21943
|
+
contentType: "application/json",
|
|
21944
|
+
schema: "any",
|
|
21945
|
+
required: true
|
|
21946
|
+
},
|
|
21947
|
+
responses: {
|
|
21948
|
+
"200": {
|
|
21949
|
+
description: "Updated configuration",
|
|
21950
|
+
schema: "any"
|
|
21951
|
+
},
|
|
21952
|
+
"401": {
|
|
21953
|
+
description: "Authentication error",
|
|
21954
|
+
schema: "any"
|
|
21955
|
+
},
|
|
21956
|
+
"403": {
|
|
21957
|
+
description: "Authorization error",
|
|
21958
|
+
schema: "any"
|
|
21959
|
+
},
|
|
21960
|
+
"404": {
|
|
21961
|
+
description: "Not found error",
|
|
21962
|
+
schema: "any"
|
|
21963
|
+
}
|
|
21964
|
+
}
|
|
21965
|
+
},
|
|
21966
|
+
{
|
|
21967
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
21968
|
+
method: "DELETE",
|
|
21969
|
+
summary: "Delete Group Configuration",
|
|
21803
21970
|
tags: [
|
|
21804
21971
|
"AlertGroups"
|
|
21805
21972
|
],
|
|
@@ -21837,6 +22004,635 @@ var clientsData = [
|
|
|
21837
22004
|
}
|
|
21838
22005
|
}
|
|
21839
22006
|
},
|
|
22007
|
+
{
|
|
22008
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",
|
|
22009
|
+
method: "POST",
|
|
22010
|
+
summary: "Bulk Add Members to Group",
|
|
22011
|
+
tags: [
|
|
22012
|
+
"AlertGroups"
|
|
22013
|
+
],
|
|
22014
|
+
parameters: [
|
|
22015
|
+
{
|
|
22016
|
+
name: "alert_group_id",
|
|
22017
|
+
"in": "path",
|
|
22018
|
+
type: "integer",
|
|
22019
|
+
required: true,
|
|
22020
|
+
description: ""
|
|
22021
|
+
}
|
|
22022
|
+
],
|
|
22023
|
+
requestBody: {
|
|
22024
|
+
contentType: "application/json",
|
|
22025
|
+
schema: "any",
|
|
22026
|
+
required: true
|
|
22027
|
+
},
|
|
22028
|
+
responses: {
|
|
22029
|
+
"200": {
|
|
22030
|
+
description: "Members added (idempotent — users already in the group are skipped)",
|
|
22031
|
+
schema: "any"
|
|
22032
|
+
},
|
|
22033
|
+
"400": {
|
|
22034
|
+
description: "Validation error; no members were added"
|
|
22035
|
+
},
|
|
22036
|
+
"401": {
|
|
22037
|
+
description: "Authentication error",
|
|
22038
|
+
schema: "any"
|
|
22039
|
+
},
|
|
22040
|
+
"403": {
|
|
22041
|
+
description: "Authorization error",
|
|
22042
|
+
schema: "any"
|
|
22043
|
+
},
|
|
22044
|
+
"404": {
|
|
22045
|
+
description: "Not found error",
|
|
22046
|
+
schema: "any"
|
|
22047
|
+
}
|
|
22048
|
+
}
|
|
22049
|
+
},
|
|
22050
|
+
{
|
|
22051
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",
|
|
22052
|
+
method: "DELETE",
|
|
22053
|
+
summary: "Bulk Remove Members from Group",
|
|
22054
|
+
tags: [
|
|
22055
|
+
"AlertGroups"
|
|
22056
|
+
],
|
|
22057
|
+
parameters: [
|
|
22058
|
+
{
|
|
22059
|
+
name: "alert_group_id",
|
|
22060
|
+
"in": "path",
|
|
22061
|
+
type: "integer",
|
|
22062
|
+
required: true,
|
|
22063
|
+
description: ""
|
|
22064
|
+
}
|
|
22065
|
+
],
|
|
22066
|
+
requestBody: {
|
|
22067
|
+
contentType: "application/json",
|
|
22068
|
+
schema: "any",
|
|
22069
|
+
required: true
|
|
22070
|
+
},
|
|
22071
|
+
responses: {
|
|
22072
|
+
"200": {
|
|
22073
|
+
description: "Members removed",
|
|
22074
|
+
schema: "any"
|
|
22075
|
+
},
|
|
22076
|
+
"401": {
|
|
22077
|
+
description: "Authentication error",
|
|
22078
|
+
schema: "any"
|
|
22079
|
+
},
|
|
22080
|
+
"403": {
|
|
22081
|
+
description: "Authorization error",
|
|
22082
|
+
schema: "any"
|
|
22083
|
+
},
|
|
22084
|
+
"404": {
|
|
22085
|
+
description: "Not found error",
|
|
22086
|
+
schema: "any"
|
|
22087
|
+
}
|
|
22088
|
+
}
|
|
22089
|
+
},
|
|
22090
|
+
{
|
|
22091
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_create",
|
|
22092
|
+
method: "POST",
|
|
22093
|
+
summary: "Bulk Add Assets to Group",
|
|
22094
|
+
tags: [
|
|
22095
|
+
"AlertGroups"
|
|
22096
|
+
],
|
|
22097
|
+
parameters: [
|
|
22098
|
+
{
|
|
22099
|
+
name: "alert_group_id",
|
|
22100
|
+
"in": "path",
|
|
22101
|
+
type: "integer",
|
|
22102
|
+
required: true,
|
|
22103
|
+
description: ""
|
|
22104
|
+
}
|
|
22105
|
+
],
|
|
22106
|
+
requestBody: {
|
|
22107
|
+
contentType: "application/json",
|
|
22108
|
+
schema: "any",
|
|
22109
|
+
required: true
|
|
22110
|
+
},
|
|
22111
|
+
responses: {
|
|
22112
|
+
"200": {
|
|
22113
|
+
description: "Assets added (idempotent — assets already in the group are skipped)",
|
|
22114
|
+
schema: "any"
|
|
22115
|
+
},
|
|
22116
|
+
"400": {
|
|
22117
|
+
description: "Validation error; no assets were added"
|
|
22118
|
+
},
|
|
22119
|
+
"401": {
|
|
22120
|
+
description: "Authentication error",
|
|
22121
|
+
schema: "any"
|
|
22122
|
+
},
|
|
22123
|
+
"403": {
|
|
22124
|
+
description: "Authorization error",
|
|
22125
|
+
schema: "any"
|
|
22126
|
+
},
|
|
22127
|
+
"404": {
|
|
22128
|
+
description: "Not found error",
|
|
22129
|
+
schema: "any"
|
|
22130
|
+
}
|
|
22131
|
+
}
|
|
22132
|
+
},
|
|
22133
|
+
{
|
|
22134
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_destroy",
|
|
22135
|
+
method: "DELETE",
|
|
22136
|
+
summary: "Bulk Remove Assets from Group",
|
|
22137
|
+
tags: [
|
|
22138
|
+
"AlertGroups"
|
|
22139
|
+
],
|
|
22140
|
+
parameters: [
|
|
22141
|
+
{
|
|
22142
|
+
name: "alert_group_id",
|
|
22143
|
+
"in": "path",
|
|
22144
|
+
type: "integer",
|
|
22145
|
+
required: true,
|
|
22146
|
+
description: ""
|
|
22147
|
+
}
|
|
22148
|
+
],
|
|
22149
|
+
requestBody: {
|
|
22150
|
+
contentType: "application/json",
|
|
22151
|
+
schema: "any",
|
|
22152
|
+
required: true
|
|
22153
|
+
},
|
|
22154
|
+
responses: {
|
|
22155
|
+
"200": {
|
|
22156
|
+
description: "Assets removed",
|
|
22157
|
+
schema: "any"
|
|
22158
|
+
},
|
|
22159
|
+
"401": {
|
|
22160
|
+
description: "Authentication error",
|
|
22161
|
+
schema: "any"
|
|
22162
|
+
},
|
|
22163
|
+
"403": {
|
|
22164
|
+
description: "Authorization error",
|
|
22165
|
+
schema: "any"
|
|
22166
|
+
},
|
|
22167
|
+
"404": {
|
|
22168
|
+
description: "Not found error",
|
|
22169
|
+
schema: "any"
|
|
22170
|
+
}
|
|
22171
|
+
}
|
|
22172
|
+
},
|
|
22173
|
+
{
|
|
22174
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",
|
|
22175
|
+
method: "POST",
|
|
22176
|
+
summary: "Bulk Create Group Configurations",
|
|
22177
|
+
tags: [
|
|
22178
|
+
"AlertGroups"
|
|
22179
|
+
],
|
|
22180
|
+
parameters: [
|
|
22181
|
+
{
|
|
22182
|
+
name: "alert_group_id",
|
|
22183
|
+
"in": "path",
|
|
22184
|
+
type: "integer",
|
|
22185
|
+
required: true,
|
|
22186
|
+
description: ""
|
|
22187
|
+
}
|
|
22188
|
+
],
|
|
22189
|
+
requestBody: {
|
|
22190
|
+
contentType: "application/json",
|
|
22191
|
+
schema: "any",
|
|
22192
|
+
required: true
|
|
22193
|
+
},
|
|
22194
|
+
responses: {
|
|
22195
|
+
"200": {
|
|
22196
|
+
description: "Configurations created (all-or-nothing — none created if any is invalid)",
|
|
22197
|
+
schema: "any"
|
|
22198
|
+
},
|
|
22199
|
+
"400": {
|
|
22200
|
+
description: "Validation error; no configurations were created"
|
|
22201
|
+
},
|
|
22202
|
+
"401": {
|
|
22203
|
+
description: "Authentication error",
|
|
22204
|
+
schema: "any"
|
|
22205
|
+
},
|
|
22206
|
+
"403": {
|
|
22207
|
+
description: "Authorization error",
|
|
22208
|
+
schema: "any"
|
|
22209
|
+
},
|
|
22210
|
+
"404": {
|
|
22211
|
+
description: "Not found error",
|
|
22212
|
+
schema: "any"
|
|
22213
|
+
}
|
|
22214
|
+
}
|
|
22215
|
+
},
|
|
22216
|
+
{
|
|
22217
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",
|
|
22218
|
+
method: "DELETE",
|
|
22219
|
+
summary: "Bulk Delete Group Configurations",
|
|
22220
|
+
tags: [
|
|
22221
|
+
"AlertGroups"
|
|
22222
|
+
],
|
|
22223
|
+
parameters: [
|
|
22224
|
+
{
|
|
22225
|
+
name: "alert_group_id",
|
|
22226
|
+
"in": "path",
|
|
22227
|
+
type: "integer",
|
|
22228
|
+
required: true,
|
|
22229
|
+
description: ""
|
|
22230
|
+
}
|
|
22231
|
+
],
|
|
22232
|
+
requestBody: {
|
|
22233
|
+
contentType: "application/json",
|
|
22234
|
+
schema: "any",
|
|
22235
|
+
required: true
|
|
22236
|
+
},
|
|
22237
|
+
responses: {
|
|
22238
|
+
"200": {
|
|
22239
|
+
description: "Configurations removed",
|
|
22240
|
+
schema: "any"
|
|
22241
|
+
},
|
|
22242
|
+
"401": {
|
|
22243
|
+
description: "Authentication error",
|
|
22244
|
+
schema: "any"
|
|
22245
|
+
},
|
|
22246
|
+
"403": {
|
|
22247
|
+
description: "Authorization error",
|
|
22248
|
+
schema: "any"
|
|
22249
|
+
},
|
|
22250
|
+
"404": {
|
|
22251
|
+
description: "Not found error",
|
|
22252
|
+
schema: "any"
|
|
22253
|
+
}
|
|
22254
|
+
}
|
|
22255
|
+
},
|
|
22256
|
+
{
|
|
22257
|
+
path: "/v2/alert_abilities",
|
|
22258
|
+
method: "GET",
|
|
22259
|
+
summary: "List Assignable Alert Abilities",
|
|
22260
|
+
description: "Static, platform-defined catalog of every assignable alert ability with its resource class and a localized display name. Identical for every company; readable by any authenticated user. Used by the matrix UI to render the assignment grid.",
|
|
22261
|
+
tags: [
|
|
22262
|
+
"AlertRBAC"
|
|
22263
|
+
],
|
|
22264
|
+
parameters: [
|
|
22265
|
+
{
|
|
22266
|
+
name: "locale",
|
|
22267
|
+
"in": "query",
|
|
22268
|
+
type: "string",
|
|
22269
|
+
required: false,
|
|
22270
|
+
description: "Display-name language; unknown/unsupported locales fall back to English"
|
|
22271
|
+
}
|
|
22272
|
+
],
|
|
22273
|
+
responses: {
|
|
22274
|
+
"200": {
|
|
22275
|
+
description: "Ability catalog",
|
|
22276
|
+
schema: "any"
|
|
22277
|
+
},
|
|
22278
|
+
"401": {
|
|
22279
|
+
description: "Authentication error",
|
|
22280
|
+
schema: "any"
|
|
22281
|
+
},
|
|
22282
|
+
"403": {
|
|
22283
|
+
description: "Authorization error",
|
|
22284
|
+
schema: "any"
|
|
22285
|
+
},
|
|
22286
|
+
"404": {
|
|
22287
|
+
description: "Not found error",
|
|
22288
|
+
schema: "any"
|
|
22289
|
+
}
|
|
22290
|
+
}
|
|
22291
|
+
},
|
|
22292
|
+
{
|
|
22293
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
22294
|
+
method: "GET",
|
|
22295
|
+
summary: "List Alert Roles",
|
|
22296
|
+
description: "Company-defined alert roles. Gated by `update Company` (company admins only).",
|
|
22297
|
+
tags: [
|
|
22298
|
+
"AlertRBAC"
|
|
22299
|
+
],
|
|
22300
|
+
parameters: [
|
|
22301
|
+
{
|
|
22302
|
+
name: "company_id",
|
|
22303
|
+
"in": "path",
|
|
22304
|
+
type: "integer",
|
|
22305
|
+
required: true,
|
|
22306
|
+
description: "Company ID"
|
|
22307
|
+
},
|
|
22308
|
+
{
|
|
22309
|
+
name: "page",
|
|
22310
|
+
"in": "query",
|
|
22311
|
+
type: "integer",
|
|
22312
|
+
required: false,
|
|
22313
|
+
description: "Page number"
|
|
22314
|
+
},
|
|
22315
|
+
{
|
|
22316
|
+
name: "per_page",
|
|
22317
|
+
"in": "query",
|
|
22318
|
+
type: "integer",
|
|
22319
|
+
required: false,
|
|
22320
|
+
description: "Items per page"
|
|
22321
|
+
}
|
|
22322
|
+
],
|
|
22323
|
+
responses: {
|
|
22324
|
+
"200": {
|
|
22325
|
+
description: "List of alert roles",
|
|
22326
|
+
schema: "any"
|
|
22327
|
+
},
|
|
22328
|
+
"401": {
|
|
22329
|
+
description: "Authentication error",
|
|
22330
|
+
schema: "any"
|
|
22331
|
+
},
|
|
22332
|
+
"403": {
|
|
22333
|
+
description: "Caller is not a company admin"
|
|
22334
|
+
},
|
|
22335
|
+
"404": {
|
|
22336
|
+
description: "Not found error",
|
|
22337
|
+
schema: "any"
|
|
22338
|
+
}
|
|
22339
|
+
}
|
|
22340
|
+
},
|
|
22341
|
+
{
|
|
22342
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
22343
|
+
method: "POST",
|
|
22344
|
+
summary: "Create Alert Role",
|
|
22345
|
+
tags: [
|
|
22346
|
+
"AlertRBAC"
|
|
22347
|
+
],
|
|
22348
|
+
parameters: [
|
|
22349
|
+
{
|
|
22350
|
+
name: "company_id",
|
|
22351
|
+
"in": "path",
|
|
22352
|
+
type: "integer",
|
|
22353
|
+
required: true,
|
|
22354
|
+
description: "Company ID"
|
|
22355
|
+
}
|
|
22356
|
+
],
|
|
22357
|
+
requestBody: {
|
|
22358
|
+
contentType: "application/json",
|
|
22359
|
+
schema: "any",
|
|
22360
|
+
required: true
|
|
22361
|
+
},
|
|
22362
|
+
responses: {
|
|
22363
|
+
"200": {
|
|
22364
|
+
description: "Created alert role",
|
|
22365
|
+
schema: "any"
|
|
22366
|
+
},
|
|
22367
|
+
"400": {
|
|
22368
|
+
description: "Validation error (e.g. blank or duplicate name)"
|
|
22369
|
+
},
|
|
22370
|
+
"401": {
|
|
22371
|
+
description: "Authentication error",
|
|
22372
|
+
schema: "any"
|
|
22373
|
+
},
|
|
22374
|
+
"403": {
|
|
22375
|
+
description: "Caller is not a company admin"
|
|
22376
|
+
},
|
|
22377
|
+
"404": {
|
|
22378
|
+
description: "Not found error",
|
|
22379
|
+
schema: "any"
|
|
22380
|
+
}
|
|
22381
|
+
}
|
|
22382
|
+
},
|
|
22383
|
+
{
|
|
22384
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
22385
|
+
method: "GET",
|
|
22386
|
+
summary: "Get Alert Role",
|
|
22387
|
+
tags: [
|
|
22388
|
+
"AlertRBAC"
|
|
22389
|
+
],
|
|
22390
|
+
parameters: [
|
|
22391
|
+
{
|
|
22392
|
+
name: "company_id",
|
|
22393
|
+
"in": "path",
|
|
22394
|
+
type: "integer",
|
|
22395
|
+
required: true,
|
|
22396
|
+
description: "Company ID"
|
|
22397
|
+
},
|
|
22398
|
+
{
|
|
22399
|
+
name: "id",
|
|
22400
|
+
"in": "path",
|
|
22401
|
+
type: "integer",
|
|
22402
|
+
required: true,
|
|
22403
|
+
description: "Alert role ID"
|
|
22404
|
+
}
|
|
22405
|
+
],
|
|
22406
|
+
responses: {
|
|
22407
|
+
"200": {
|
|
22408
|
+
description: "Alert role details",
|
|
22409
|
+
schema: "any"
|
|
22410
|
+
},
|
|
22411
|
+
"401": {
|
|
22412
|
+
description: "Authentication error",
|
|
22413
|
+
schema: "any"
|
|
22414
|
+
},
|
|
22415
|
+
"403": {
|
|
22416
|
+
description: "Caller is not a company admin"
|
|
22417
|
+
},
|
|
22418
|
+
"404": {
|
|
22419
|
+
description: "Role not found in this company"
|
|
22420
|
+
}
|
|
22421
|
+
}
|
|
22422
|
+
},
|
|
22423
|
+
{
|
|
22424
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
22425
|
+
method: "PATCH",
|
|
22426
|
+
summary: "Update Alert Role",
|
|
22427
|
+
tags: [
|
|
22428
|
+
"AlertRBAC"
|
|
22429
|
+
],
|
|
22430
|
+
parameters: [
|
|
22431
|
+
{
|
|
22432
|
+
name: "company_id",
|
|
22433
|
+
"in": "path",
|
|
22434
|
+
type: "integer",
|
|
22435
|
+
required: true,
|
|
22436
|
+
description: "Company ID"
|
|
22437
|
+
},
|
|
22438
|
+
{
|
|
22439
|
+
name: "id",
|
|
22440
|
+
"in": "path",
|
|
22441
|
+
type: "integer",
|
|
22442
|
+
required: true,
|
|
22443
|
+
description: "Alert role ID"
|
|
22444
|
+
}
|
|
22445
|
+
],
|
|
22446
|
+
requestBody: {
|
|
22447
|
+
contentType: "application/json",
|
|
22448
|
+
schema: "any",
|
|
22449
|
+
required: true
|
|
22450
|
+
},
|
|
22451
|
+
responses: {
|
|
22452
|
+
"200": {
|
|
22453
|
+
description: "Updated alert role",
|
|
22454
|
+
schema: "any"
|
|
22455
|
+
},
|
|
22456
|
+
"400": {
|
|
22457
|
+
description: "Validation error"
|
|
22458
|
+
},
|
|
22459
|
+
"401": {
|
|
22460
|
+
description: "Authentication error",
|
|
22461
|
+
schema: "any"
|
|
22462
|
+
},
|
|
22463
|
+
"403": {
|
|
22464
|
+
description: "Caller is not a company admin"
|
|
22465
|
+
},
|
|
22466
|
+
"404": {
|
|
22467
|
+
description: "Not found error",
|
|
22468
|
+
schema: "any"
|
|
22469
|
+
}
|
|
22470
|
+
}
|
|
22471
|
+
},
|
|
22472
|
+
{
|
|
22473
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
22474
|
+
method: "DELETE",
|
|
22475
|
+
summary: "Delete Alert Role",
|
|
22476
|
+
description: "Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",
|
|
22477
|
+
tags: [
|
|
22478
|
+
"AlertRBAC"
|
|
22479
|
+
],
|
|
22480
|
+
parameters: [
|
|
22481
|
+
{
|
|
22482
|
+
name: "company_id",
|
|
22483
|
+
"in": "path",
|
|
22484
|
+
type: "integer",
|
|
22485
|
+
required: true,
|
|
22486
|
+
description: "Company ID"
|
|
22487
|
+
},
|
|
22488
|
+
{
|
|
22489
|
+
name: "id",
|
|
22490
|
+
"in": "path",
|
|
22491
|
+
type: "integer",
|
|
22492
|
+
required: true,
|
|
22493
|
+
description: "Alert role ID"
|
|
22494
|
+
}
|
|
22495
|
+
],
|
|
22496
|
+
responses: {
|
|
22497
|
+
"200": {
|
|
22498
|
+
description: "Deleted"
|
|
22499
|
+
},
|
|
22500
|
+
"401": {
|
|
22501
|
+
description: "Authentication error",
|
|
22502
|
+
schema: "any"
|
|
22503
|
+
},
|
|
22504
|
+
"403": {
|
|
22505
|
+
description: "Caller is not a company admin, or the role is still assigned to members"
|
|
22506
|
+
},
|
|
22507
|
+
"404": {
|
|
22508
|
+
description: "Not found error",
|
|
22509
|
+
schema: "any"
|
|
22510
|
+
}
|
|
22511
|
+
}
|
|
22512
|
+
},
|
|
22513
|
+
{
|
|
22514
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}/abilities",
|
|
22515
|
+
method: "PUT",
|
|
22516
|
+
summary: "Replace Alert Role Abilities",
|
|
22517
|
+
description: "Atomically replaces the full set of ability grants on the role. A single invalid entry rolls back the whole change and leaves the prior matrix intact. An explicit empty array clears every grant; a missing or malformed `abilities` key is rejected with 400.",
|
|
22518
|
+
tags: [
|
|
22519
|
+
"AlertRBAC"
|
|
22520
|
+
],
|
|
22521
|
+
parameters: [
|
|
22522
|
+
{
|
|
22523
|
+
name: "company_id",
|
|
22524
|
+
"in": "path",
|
|
22525
|
+
type: "integer",
|
|
22526
|
+
required: true,
|
|
22527
|
+
description: "Company ID"
|
|
22528
|
+
},
|
|
22529
|
+
{
|
|
22530
|
+
name: "id",
|
|
22531
|
+
"in": "path",
|
|
22532
|
+
type: "integer",
|
|
22533
|
+
required: true,
|
|
22534
|
+
description: "Alert role ID"
|
|
22535
|
+
}
|
|
22536
|
+
],
|
|
22537
|
+
requestBody: {
|
|
22538
|
+
contentType: "application/json",
|
|
22539
|
+
schema: "any",
|
|
22540
|
+
required: true
|
|
22541
|
+
},
|
|
22542
|
+
responses: {
|
|
22543
|
+
"200": {
|
|
22544
|
+
description: "Role with its updated abilities",
|
|
22545
|
+
schema: "any"
|
|
22546
|
+
},
|
|
22547
|
+
"400": {
|
|
22548
|
+
description: "Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"
|
|
22549
|
+
},
|
|
22550
|
+
"401": {
|
|
22551
|
+
description: "Authentication error",
|
|
22552
|
+
schema: "any"
|
|
22553
|
+
},
|
|
22554
|
+
"403": {
|
|
22555
|
+
description: "Caller is not a company admin"
|
|
22556
|
+
},
|
|
22557
|
+
"404": {
|
|
22558
|
+
description: "Not found error",
|
|
22559
|
+
schema: "any"
|
|
22560
|
+
}
|
|
22561
|
+
}
|
|
22562
|
+
},
|
|
22563
|
+
{
|
|
22564
|
+
path: "/v2/companies/{company_id}/alert_rbac/enable",
|
|
22565
|
+
method: "POST",
|
|
22566
|
+
summary: "Enable Alert RBAC",
|
|
22567
|
+
description: "Turns on per-company alert RBAC enforcement. Rejected with 422 unless at least one alert role exists, so a company can never lock every alert action.",
|
|
22568
|
+
tags: [
|
|
22569
|
+
"AlertRBAC"
|
|
22570
|
+
],
|
|
22571
|
+
parameters: [
|
|
22572
|
+
{
|
|
22573
|
+
name: "company_id",
|
|
22574
|
+
"in": "path",
|
|
22575
|
+
type: "integer",
|
|
22576
|
+
required: true,
|
|
22577
|
+
description: "Company ID"
|
|
22578
|
+
}
|
|
22579
|
+
],
|
|
22580
|
+
responses: {
|
|
22581
|
+
"200": {
|
|
22582
|
+
description: "RBAC enabled",
|
|
22583
|
+
schema: "any"
|
|
22584
|
+
},
|
|
22585
|
+
"401": {
|
|
22586
|
+
description: "Authentication error",
|
|
22587
|
+
schema: "any"
|
|
22588
|
+
},
|
|
22589
|
+
"403": {
|
|
22590
|
+
description: "Caller is not a company admin"
|
|
22591
|
+
},
|
|
22592
|
+
"404": {
|
|
22593
|
+
description: "Not found error",
|
|
22594
|
+
schema: "any"
|
|
22595
|
+
},
|
|
22596
|
+
"422": {
|
|
22597
|
+
description: "No alert role exists yet"
|
|
22598
|
+
}
|
|
22599
|
+
}
|
|
22600
|
+
},
|
|
22601
|
+
{
|
|
22602
|
+
path: "/v2/companies/{company_id}/alert_rbac/disable",
|
|
22603
|
+
method: "POST",
|
|
22604
|
+
summary: "Disable Alert RBAC",
|
|
22605
|
+
description: "Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",
|
|
22606
|
+
tags: [
|
|
22607
|
+
"AlertRBAC"
|
|
22608
|
+
],
|
|
22609
|
+
parameters: [
|
|
22610
|
+
{
|
|
22611
|
+
name: "company_id",
|
|
22612
|
+
"in": "path",
|
|
22613
|
+
type: "integer",
|
|
22614
|
+
required: true,
|
|
22615
|
+
description: "Company ID"
|
|
22616
|
+
}
|
|
22617
|
+
],
|
|
22618
|
+
responses: {
|
|
22619
|
+
"200": {
|
|
22620
|
+
description: "RBAC disabled",
|
|
22621
|
+
schema: "any"
|
|
22622
|
+
},
|
|
22623
|
+
"401": {
|
|
22624
|
+
description: "Authentication error",
|
|
22625
|
+
schema: "any"
|
|
22626
|
+
},
|
|
22627
|
+
"403": {
|
|
22628
|
+
description: "Caller is not a company admin"
|
|
22629
|
+
},
|
|
22630
|
+
"404": {
|
|
22631
|
+
description: "Not found error",
|
|
22632
|
+
schema: "any"
|
|
22633
|
+
}
|
|
22634
|
+
}
|
|
22635
|
+
},
|
|
21840
22636
|
{
|
|
21841
22637
|
path: "/v2/alerts/{alert_id}/occurrences",
|
|
21842
22638
|
method: "GET",
|
|
@@ -21852,12 +22648,19 @@ var clientsData = [
|
|
|
21852
22648
|
required: true,
|
|
21853
22649
|
description: "Alert ID"
|
|
21854
22650
|
},
|
|
22651
|
+
{
|
|
22652
|
+
name: "sort",
|
|
22653
|
+
"in": "query",
|
|
22654
|
+
type: "string",
|
|
22655
|
+
required: false,
|
|
22656
|
+
description: "Field to sort by: start_at (default) or severity"
|
|
22657
|
+
},
|
|
21855
22658
|
{
|
|
21856
22659
|
name: "order",
|
|
21857
22660
|
"in": "query",
|
|
21858
22661
|
type: "string",
|
|
21859
22662
|
required: false,
|
|
21860
|
-
description: "Sort
|
|
22663
|
+
description: "Sort direction: asc (default) or desc"
|
|
21861
22664
|
},
|
|
21862
22665
|
{
|
|
21863
22666
|
name: "page",
|
|
@@ -21912,6 +22715,20 @@ var clientsData = [
|
|
|
21912
22715
|
required: false,
|
|
21913
22716
|
description: "Timestamp to end alert at"
|
|
21914
22717
|
},
|
|
22718
|
+
{
|
|
22719
|
+
name: "last_alert_start",
|
|
22720
|
+
"in": "query",
|
|
22721
|
+
type: "integer",
|
|
22722
|
+
required: false,
|
|
22723
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
22724
|
+
},
|
|
22725
|
+
{
|
|
22726
|
+
name: "last_alert_end",
|
|
22727
|
+
"in": "query",
|
|
22728
|
+
type: "integer",
|
|
22729
|
+
required: false,
|
|
22730
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
22731
|
+
},
|
|
21915
22732
|
{
|
|
21916
22733
|
name: "page",
|
|
21917
22734
|
"in": "query",
|
|
@@ -22328,6 +23145,20 @@ var clientsData = [
|
|
|
22328
23145
|
required: false,
|
|
22329
23146
|
description: "Timestamp to end alert at"
|
|
22330
23147
|
},
|
|
23148
|
+
{
|
|
23149
|
+
name: "last_alert_start",
|
|
23150
|
+
"in": "query",
|
|
23151
|
+
type: "integer",
|
|
23152
|
+
required: false,
|
|
23153
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
23154
|
+
},
|
|
23155
|
+
{
|
|
23156
|
+
name: "last_alert_end",
|
|
23157
|
+
"in": "query",
|
|
23158
|
+
type: "integer",
|
|
23159
|
+
required: false,
|
|
23160
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
23161
|
+
},
|
|
22331
23162
|
{
|
|
22332
23163
|
name: "created_after",
|
|
22333
23164
|
"in": "query",
|
|
@@ -22440,6 +23271,20 @@ var clientsData = [
|
|
|
22440
23271
|
required: false,
|
|
22441
23272
|
description: "Timestamp to end alert at"
|
|
22442
23273
|
},
|
|
23274
|
+
{
|
|
23275
|
+
name: "last_alert_start",
|
|
23276
|
+
"in": "query",
|
|
23277
|
+
type: "integer",
|
|
23278
|
+
required: false,
|
|
23279
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
23280
|
+
},
|
|
23281
|
+
{
|
|
23282
|
+
name: "last_alert_end",
|
|
23283
|
+
"in": "query",
|
|
23284
|
+
type: "integer",
|
|
23285
|
+
required: false,
|
|
23286
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
23287
|
+
},
|
|
22443
23288
|
{
|
|
22444
23289
|
name: "page",
|
|
22445
23290
|
"in": "query",
|
|
@@ -28513,27 +29358,503 @@ var clientsData = [
|
|
|
28513
29358
|
}
|
|
28514
29359
|
},
|
|
28515
29360
|
{
|
|
28516
|
-
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
28517
|
-
method: "PATCH",
|
|
28518
|
-
summary: "Update a dashboard",
|
|
29361
|
+
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
29362
|
+
method: "PATCH",
|
|
29363
|
+
summary: "Update a dashboard",
|
|
29364
|
+
tags: [
|
|
29365
|
+
"Dashboards"
|
|
29366
|
+
],
|
|
29367
|
+
parameters: [
|
|
29368
|
+
{
|
|
29369
|
+
name: "user_id",
|
|
29370
|
+
"in": "path",
|
|
29371
|
+
type: "integer",
|
|
29372
|
+
required: true,
|
|
29373
|
+
description: "User ID"
|
|
29374
|
+
},
|
|
29375
|
+
{
|
|
29376
|
+
name: "id",
|
|
29377
|
+
"in": "path",
|
|
29378
|
+
type: "integer",
|
|
29379
|
+
required: true,
|
|
29380
|
+
description: "Dashboard ID"
|
|
29381
|
+
}
|
|
29382
|
+
],
|
|
29383
|
+
requestBody: {
|
|
29384
|
+
contentType: "application/json",
|
|
29385
|
+
schema: "any",
|
|
29386
|
+
required: true
|
|
29387
|
+
},
|
|
29388
|
+
responses: {
|
|
29389
|
+
"200": {
|
|
29390
|
+
description: "Updated dashboard",
|
|
29391
|
+
schema: "any"
|
|
29392
|
+
},
|
|
29393
|
+
"401": {
|
|
29394
|
+
description: "Authentication error",
|
|
29395
|
+
schema: "any"
|
|
29396
|
+
},
|
|
29397
|
+
"403": {
|
|
29398
|
+
description: "Authorization error",
|
|
29399
|
+
schema: "any"
|
|
29400
|
+
},
|
|
29401
|
+
"404": {
|
|
29402
|
+
description: "Not found error",
|
|
29403
|
+
schema: "any"
|
|
29404
|
+
}
|
|
29405
|
+
}
|
|
29406
|
+
},
|
|
29407
|
+
{
|
|
29408
|
+
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
29409
|
+
method: "DELETE",
|
|
29410
|
+
summary: "Delete a dashboard",
|
|
29411
|
+
tags: [
|
|
29412
|
+
"Dashboards"
|
|
29413
|
+
],
|
|
29414
|
+
parameters: [
|
|
29415
|
+
{
|
|
29416
|
+
name: "user_id",
|
|
29417
|
+
"in": "path",
|
|
29418
|
+
type: "integer",
|
|
29419
|
+
required: true,
|
|
29420
|
+
description: "User ID"
|
|
29421
|
+
},
|
|
29422
|
+
{
|
|
29423
|
+
name: "id",
|
|
29424
|
+
"in": "path",
|
|
29425
|
+
type: "integer",
|
|
29426
|
+
required: true,
|
|
29427
|
+
description: "Dashboard ID"
|
|
29428
|
+
}
|
|
29429
|
+
],
|
|
29430
|
+
responses: {
|
|
29431
|
+
"200": {
|
|
29432
|
+
description: "Dashboard deleted"
|
|
29433
|
+
},
|
|
29434
|
+
"401": {
|
|
29435
|
+
description: "Authentication error",
|
|
29436
|
+
schema: "any"
|
|
29437
|
+
},
|
|
29438
|
+
"403": {
|
|
29439
|
+
description: "Authorization error",
|
|
29440
|
+
schema: "any"
|
|
29441
|
+
},
|
|
29442
|
+
"404": {
|
|
29443
|
+
description: "Not found error",
|
|
29444
|
+
schema: "any"
|
|
29445
|
+
}
|
|
29446
|
+
}
|
|
29447
|
+
},
|
|
29448
|
+
{
|
|
29449
|
+
path: "/v2/users/{user_id}/dashboards/{id}/clone",
|
|
29450
|
+
method: "POST",
|
|
29451
|
+
summary: "Clone a dashboard",
|
|
29452
|
+
tags: [
|
|
29453
|
+
"Dashboards"
|
|
29454
|
+
],
|
|
29455
|
+
parameters: [
|
|
29456
|
+
{
|
|
29457
|
+
name: "user_id",
|
|
29458
|
+
"in": "path",
|
|
29459
|
+
type: "integer",
|
|
29460
|
+
required: true,
|
|
29461
|
+
description: "User ID"
|
|
29462
|
+
},
|
|
29463
|
+
{
|
|
29464
|
+
name: "id",
|
|
29465
|
+
"in": "path",
|
|
29466
|
+
type: "integer",
|
|
29467
|
+
required: true,
|
|
29468
|
+
description: "Dashboard ID"
|
|
29469
|
+
}
|
|
29470
|
+
],
|
|
29471
|
+
requestBody: {
|
|
29472
|
+
contentType: "application/json",
|
|
29473
|
+
schema: "any",
|
|
29474
|
+
required: true
|
|
29475
|
+
},
|
|
29476
|
+
responses: {
|
|
29477
|
+
"200": {
|
|
29478
|
+
description: "Cloned dashboard",
|
|
29479
|
+
schema: "any"
|
|
29480
|
+
},
|
|
29481
|
+
"401": {
|
|
29482
|
+
description: "Authentication error",
|
|
29483
|
+
schema: "any"
|
|
29484
|
+
},
|
|
29485
|
+
"403": {
|
|
29486
|
+
description: "Authorization error",
|
|
29487
|
+
schema: "any"
|
|
29488
|
+
},
|
|
29489
|
+
"404": {
|
|
29490
|
+
description: "Not found error",
|
|
29491
|
+
schema: "any"
|
|
29492
|
+
}
|
|
29493
|
+
}
|
|
29494
|
+
},
|
|
29495
|
+
{
|
|
29496
|
+
path: "/v2/dashboards/templates",
|
|
29497
|
+
method: "GET",
|
|
29498
|
+
summary: "Get template dashboards",
|
|
29499
|
+
tags: [
|
|
29500
|
+
"Dashboards"
|
|
29501
|
+
],
|
|
29502
|
+
parameters: [
|
|
29503
|
+
],
|
|
29504
|
+
responses: {
|
|
29505
|
+
"200": {
|
|
29506
|
+
description: "Template dashboards",
|
|
29507
|
+
schema: "any"
|
|
29508
|
+
},
|
|
29509
|
+
"401": {
|
|
29510
|
+
description: "Authentication error",
|
|
29511
|
+
schema: "any"
|
|
29512
|
+
},
|
|
29513
|
+
"403": {
|
|
29514
|
+
description: "Authorization error",
|
|
29515
|
+
schema: "any"
|
|
29516
|
+
},
|
|
29517
|
+
"404": {
|
|
29518
|
+
description: "Not found error",
|
|
29519
|
+
schema: "any"
|
|
29520
|
+
}
|
|
29521
|
+
}
|
|
29522
|
+
},
|
|
29523
|
+
{
|
|
29524
|
+
path: "/v2/users/{user_id}/dashboards/{id}/use_template",
|
|
29525
|
+
method: "POST",
|
|
29526
|
+
summary: "Set dashboard apps and layout from a template dashboard",
|
|
29527
|
+
tags: [
|
|
29528
|
+
"Dashboards"
|
|
29529
|
+
],
|
|
29530
|
+
parameters: [
|
|
29531
|
+
{
|
|
29532
|
+
name: "user_id",
|
|
29533
|
+
"in": "path",
|
|
29534
|
+
type: "integer",
|
|
29535
|
+
required: true,
|
|
29536
|
+
description: "User ID"
|
|
29537
|
+
},
|
|
29538
|
+
{
|
|
29539
|
+
name: "id",
|
|
29540
|
+
"in": "path",
|
|
29541
|
+
type: "integer",
|
|
29542
|
+
required: true,
|
|
29543
|
+
description: "Dashboard ID"
|
|
29544
|
+
}
|
|
29545
|
+
],
|
|
29546
|
+
requestBody: {
|
|
29547
|
+
contentType: "application/json",
|
|
29548
|
+
schema: "integer",
|
|
29549
|
+
required: true
|
|
29550
|
+
},
|
|
29551
|
+
responses: {
|
|
29552
|
+
"200": {
|
|
29553
|
+
description: "Modified dashboard",
|
|
29554
|
+
schema: "any"
|
|
29555
|
+
},
|
|
29556
|
+
"401": {
|
|
29557
|
+
description: "Authentication error",
|
|
29558
|
+
schema: "any"
|
|
29559
|
+
},
|
|
29560
|
+
"403": {
|
|
29561
|
+
description: "Authorization error",
|
|
29562
|
+
schema: "any"
|
|
29563
|
+
},
|
|
29564
|
+
"404": {
|
|
29565
|
+
description: "Not found error",
|
|
29566
|
+
schema: "any"
|
|
29567
|
+
}
|
|
29568
|
+
}
|
|
29569
|
+
},
|
|
29570
|
+
{
|
|
29571
|
+
path: "/v2/dashboards",
|
|
29572
|
+
method: "GET",
|
|
29573
|
+
summary: "List all dashboards",
|
|
29574
|
+
tags: [
|
|
29575
|
+
"Dashboards"
|
|
29576
|
+
],
|
|
29577
|
+
parameters: [
|
|
29578
|
+
{
|
|
29579
|
+
name: "visibility",
|
|
29580
|
+
"in": "query",
|
|
29581
|
+
type: "string",
|
|
29582
|
+
required: false,
|
|
29583
|
+
description: "Filter Dashboards by visibility"
|
|
29584
|
+
},
|
|
29585
|
+
{
|
|
29586
|
+
name: "type",
|
|
29587
|
+
"in": "query",
|
|
29588
|
+
type: "string",
|
|
29589
|
+
required: false,
|
|
29590
|
+
description: "Filter Dashboards by type"
|
|
29591
|
+
},
|
|
29592
|
+
{
|
|
29593
|
+
name: "viewed",
|
|
29594
|
+
"in": "query",
|
|
29595
|
+
type: "string",
|
|
29596
|
+
required: false,
|
|
29597
|
+
description: "Filter Dashboards by viewed"
|
|
29598
|
+
},
|
|
29599
|
+
{
|
|
29600
|
+
name: "segment",
|
|
29601
|
+
"in": "query",
|
|
29602
|
+
type: "string",
|
|
29603
|
+
required: false,
|
|
29604
|
+
description: "Filter Dashboards by segment"
|
|
29605
|
+
},
|
|
29606
|
+
{
|
|
29607
|
+
name: "layout",
|
|
29608
|
+
"in": "query",
|
|
29609
|
+
type: "string",
|
|
29610
|
+
required: false,
|
|
29611
|
+
description: "Filter Dashboards by layout"
|
|
29612
|
+
},
|
|
29613
|
+
{
|
|
29614
|
+
name: "category",
|
|
29615
|
+
"in": "query",
|
|
29616
|
+
type: "string",
|
|
29617
|
+
required: false,
|
|
29618
|
+
description: "Filter Dashboards by category"
|
|
29619
|
+
},
|
|
29620
|
+
{
|
|
29621
|
+
name: "exclude_shared",
|
|
29622
|
+
"in": "query",
|
|
29623
|
+
type: "boolean",
|
|
29624
|
+
required: false,
|
|
29625
|
+
description: "Filter Shared Dashboards"
|
|
29626
|
+
},
|
|
29627
|
+
{
|
|
29628
|
+
name: "can_update",
|
|
29629
|
+
"in": "query",
|
|
29630
|
+
type: "boolean",
|
|
29631
|
+
required: false,
|
|
29632
|
+
description: "Filter Dashboards by ability to update"
|
|
29633
|
+
},
|
|
29634
|
+
{
|
|
29635
|
+
name: "sort",
|
|
29636
|
+
"in": "query",
|
|
29637
|
+
type: "string",
|
|
29638
|
+
required: false,
|
|
29639
|
+
description: "Sort dashboards by order field"
|
|
29640
|
+
}
|
|
29641
|
+
],
|
|
29642
|
+
responses: {
|
|
29643
|
+
"200": {
|
|
29644
|
+
description: "Successful response",
|
|
29645
|
+
schema: "any"
|
|
29646
|
+
},
|
|
29647
|
+
"401": {
|
|
29648
|
+
description: "Authentication error",
|
|
29649
|
+
schema: "any"
|
|
29650
|
+
},
|
|
29651
|
+
"403": {
|
|
29652
|
+
description: "Authorization error",
|
|
29653
|
+
schema: "any"
|
|
29654
|
+
},
|
|
29655
|
+
"404": {
|
|
29656
|
+
description: "Not found error",
|
|
29657
|
+
schema: "any"
|
|
29658
|
+
}
|
|
29659
|
+
}
|
|
29660
|
+
},
|
|
29661
|
+
{
|
|
29662
|
+
path: "/v2/dashboards/{id}/available_timezones",
|
|
29663
|
+
method: "GET",
|
|
29664
|
+
summary: "List timezones for dashboard",
|
|
29665
|
+
tags: [
|
|
29666
|
+
"Dashboards"
|
|
29667
|
+
],
|
|
29668
|
+
parameters: [
|
|
29669
|
+
{
|
|
29670
|
+
name: "id",
|
|
29671
|
+
"in": "path",
|
|
29672
|
+
type: "integer",
|
|
29673
|
+
required: true,
|
|
29674
|
+
description: "Dashboard ID"
|
|
29675
|
+
}
|
|
29676
|
+
],
|
|
29677
|
+
responses: {
|
|
29678
|
+
"200": {
|
|
29679
|
+
description: "Successful response",
|
|
29680
|
+
schema: "any"
|
|
29681
|
+
},
|
|
29682
|
+
"401": {
|
|
29683
|
+
description: "Authentication error",
|
|
29684
|
+
schema: "any"
|
|
29685
|
+
},
|
|
29686
|
+
"403": {
|
|
29687
|
+
description: "Authorization error",
|
|
29688
|
+
schema: "any"
|
|
29689
|
+
},
|
|
29690
|
+
"404": {
|
|
29691
|
+
description: "Not found error",
|
|
29692
|
+
schema: "any"
|
|
29693
|
+
}
|
|
29694
|
+
}
|
|
29695
|
+
},
|
|
29696
|
+
{
|
|
29697
|
+
path: "/v2/well_plan_checklists",
|
|
29698
|
+
method: "GET",
|
|
29699
|
+
summary: "List well plan checklists",
|
|
29700
|
+
tags: [
|
|
29701
|
+
"Well Plan Checklists"
|
|
29702
|
+
],
|
|
29703
|
+
parameters: [
|
|
29704
|
+
{
|
|
29705
|
+
name: "company_id",
|
|
29706
|
+
"in": "query",
|
|
29707
|
+
type: "integer",
|
|
29708
|
+
required: false,
|
|
29709
|
+
description: "Filter by company ID"
|
|
29710
|
+
},
|
|
29711
|
+
{
|
|
29712
|
+
name: "per_page",
|
|
29713
|
+
"in": "query",
|
|
29714
|
+
type: "integer",
|
|
29715
|
+
required: false,
|
|
29716
|
+
description: "Number of items to list per page"
|
|
29717
|
+
},
|
|
29718
|
+
{
|
|
29719
|
+
name: "page",
|
|
29720
|
+
"in": "query",
|
|
29721
|
+
type: "integer",
|
|
29722
|
+
required: false,
|
|
29723
|
+
description: "Page number"
|
|
29724
|
+
}
|
|
29725
|
+
],
|
|
29726
|
+
responses: {
|
|
29727
|
+
"200": {
|
|
29728
|
+
description: "Successful response",
|
|
29729
|
+
schema: "any"
|
|
29730
|
+
},
|
|
29731
|
+
"401": {
|
|
29732
|
+
description: "Authentication error",
|
|
29733
|
+
schema: "any"
|
|
29734
|
+
},
|
|
29735
|
+
"403": {
|
|
29736
|
+
description: "Authorization error",
|
|
29737
|
+
schema: "any"
|
|
29738
|
+
},
|
|
29739
|
+
"404": {
|
|
29740
|
+
description: "Not found error",
|
|
29741
|
+
schema: "any"
|
|
29742
|
+
}
|
|
29743
|
+
}
|
|
29744
|
+
},
|
|
29745
|
+
{
|
|
29746
|
+
path: "/v2/well_plan_checklists/{id}",
|
|
29747
|
+
method: "GET",
|
|
29748
|
+
summary: "Show well plan checklist",
|
|
29749
|
+
tags: [
|
|
29750
|
+
"Well Plan Checklists"
|
|
29751
|
+
],
|
|
29752
|
+
parameters: [
|
|
29753
|
+
{
|
|
29754
|
+
name: "id",
|
|
29755
|
+
"in": "path",
|
|
29756
|
+
type: "integer",
|
|
29757
|
+
required: true,
|
|
29758
|
+
description: "Well Plan Checklist ID"
|
|
29759
|
+
}
|
|
29760
|
+
],
|
|
29761
|
+
responses: {
|
|
29762
|
+
"200": {
|
|
29763
|
+
description: "Successful response",
|
|
29764
|
+
schema: "any"
|
|
29765
|
+
},
|
|
29766
|
+
"401": {
|
|
29767
|
+
description: "Authentication error",
|
|
29768
|
+
schema: "any"
|
|
29769
|
+
},
|
|
29770
|
+
"403": {
|
|
29771
|
+
description: "Authorization error",
|
|
29772
|
+
schema: "any"
|
|
29773
|
+
},
|
|
29774
|
+
"404": {
|
|
29775
|
+
description: "Not found error",
|
|
29776
|
+
schema: "any"
|
|
29777
|
+
}
|
|
29778
|
+
}
|
|
29779
|
+
},
|
|
29780
|
+
{
|
|
29781
|
+
path: "/v2/well_plans",
|
|
29782
|
+
method: "GET",
|
|
29783
|
+
summary: "List well plans",
|
|
29784
|
+
tags: [
|
|
29785
|
+
"Well Plans"
|
|
29786
|
+
],
|
|
29787
|
+
parameters: [
|
|
29788
|
+
{
|
|
29789
|
+
name: "company_id",
|
|
29790
|
+
"in": "query",
|
|
29791
|
+
type: "integer",
|
|
29792
|
+
required: false,
|
|
29793
|
+
description: "Filter by company ID"
|
|
29794
|
+
},
|
|
29795
|
+
{
|
|
29796
|
+
name: "well_id",
|
|
29797
|
+
"in": "query",
|
|
29798
|
+
type: "integer",
|
|
29799
|
+
required: false,
|
|
29800
|
+
description: "Filter by well ID"
|
|
29801
|
+
},
|
|
29802
|
+
{
|
|
29803
|
+
name: "source_well_id",
|
|
29804
|
+
"in": "query",
|
|
29805
|
+
type: "integer",
|
|
29806
|
+
required: false,
|
|
29807
|
+
description: "Filter by source well ID"
|
|
29808
|
+
},
|
|
29809
|
+
{
|
|
29810
|
+
name: "status",
|
|
29811
|
+
"in": "query",
|
|
29812
|
+
type: "string",
|
|
29813
|
+
required: false,
|
|
29814
|
+
description: "Filter by status"
|
|
29815
|
+
},
|
|
29816
|
+
{
|
|
29817
|
+
name: "per_page",
|
|
29818
|
+
"in": "query",
|
|
29819
|
+
type: "integer",
|
|
29820
|
+
required: false,
|
|
29821
|
+
description: "Number of items to list per page"
|
|
29822
|
+
},
|
|
29823
|
+
{
|
|
29824
|
+
name: "page",
|
|
29825
|
+
"in": "query",
|
|
29826
|
+
type: "integer",
|
|
29827
|
+
required: false,
|
|
29828
|
+
description: "Page number"
|
|
29829
|
+
}
|
|
29830
|
+
],
|
|
29831
|
+
responses: {
|
|
29832
|
+
"200": {
|
|
29833
|
+
description: "Successful response",
|
|
29834
|
+
schema: "any"
|
|
29835
|
+
},
|
|
29836
|
+
"401": {
|
|
29837
|
+
description: "Authentication error",
|
|
29838
|
+
schema: "any"
|
|
29839
|
+
},
|
|
29840
|
+
"403": {
|
|
29841
|
+
description: "Authorization error",
|
|
29842
|
+
schema: "any"
|
|
29843
|
+
},
|
|
29844
|
+
"404": {
|
|
29845
|
+
description: "Not found error",
|
|
29846
|
+
schema: "any"
|
|
29847
|
+
}
|
|
29848
|
+
}
|
|
29849
|
+
},
|
|
29850
|
+
{
|
|
29851
|
+
path: "/v2/well_plans",
|
|
29852
|
+
method: "POST",
|
|
29853
|
+
summary: "Create a well plan",
|
|
28519
29854
|
tags: [
|
|
28520
|
-
"
|
|
29855
|
+
"Well Plans"
|
|
28521
29856
|
],
|
|
28522
29857
|
parameters: [
|
|
28523
|
-
{
|
|
28524
|
-
name: "user_id",
|
|
28525
|
-
"in": "path",
|
|
28526
|
-
type: "integer",
|
|
28527
|
-
required: true,
|
|
28528
|
-
description: "User ID"
|
|
28529
|
-
},
|
|
28530
|
-
{
|
|
28531
|
-
name: "id",
|
|
28532
|
-
"in": "path",
|
|
28533
|
-
type: "integer",
|
|
28534
|
-
required: true,
|
|
28535
|
-
description: "Dashboard ID"
|
|
28536
|
-
}
|
|
28537
29858
|
],
|
|
28538
29859
|
requestBody: {
|
|
28539
29860
|
contentType: "application/json",
|
|
@@ -28542,7 +29863,7 @@ var clientsData = [
|
|
|
28542
29863
|
},
|
|
28543
29864
|
responses: {
|
|
28544
29865
|
"200": {
|
|
28545
|
-
description: "
|
|
29866
|
+
description: "Created well plan",
|
|
28546
29867
|
schema: "any"
|
|
28547
29868
|
},
|
|
28548
29869
|
"401": {
|
|
@@ -28560,31 +29881,25 @@ var clientsData = [
|
|
|
28560
29881
|
}
|
|
28561
29882
|
},
|
|
28562
29883
|
{
|
|
28563
|
-
path: "/v2/
|
|
28564
|
-
method: "
|
|
28565
|
-
summary: "
|
|
29884
|
+
path: "/v2/well_plans/{id}",
|
|
29885
|
+
method: "GET",
|
|
29886
|
+
summary: "Show well plan",
|
|
28566
29887
|
tags: [
|
|
28567
|
-
"
|
|
29888
|
+
"Well Plans"
|
|
28568
29889
|
],
|
|
28569
29890
|
parameters: [
|
|
28570
|
-
{
|
|
28571
|
-
name: "user_id",
|
|
28572
|
-
"in": "path",
|
|
28573
|
-
type: "integer",
|
|
28574
|
-
required: true,
|
|
28575
|
-
description: "User ID"
|
|
28576
|
-
},
|
|
28577
29891
|
{
|
|
28578
29892
|
name: "id",
|
|
28579
29893
|
"in": "path",
|
|
28580
29894
|
type: "integer",
|
|
28581
29895
|
required: true,
|
|
28582
|
-
description: "
|
|
29896
|
+
description: "Well Plan ID"
|
|
28583
29897
|
}
|
|
28584
29898
|
],
|
|
28585
29899
|
responses: {
|
|
28586
29900
|
"200": {
|
|
28587
|
-
description: "
|
|
29901
|
+
description: "Successful response",
|
|
29902
|
+
schema: "any"
|
|
28588
29903
|
},
|
|
28589
29904
|
"401": {
|
|
28590
29905
|
description: "Authentication error",
|
|
@@ -28601,26 +29916,19 @@ var clientsData = [
|
|
|
28601
29916
|
}
|
|
28602
29917
|
},
|
|
28603
29918
|
{
|
|
28604
|
-
path: "/v2/
|
|
28605
|
-
method: "
|
|
28606
|
-
summary: "
|
|
29919
|
+
path: "/v2/well_plans/{id}",
|
|
29920
|
+
method: "PATCH",
|
|
29921
|
+
summary: "Update well plan",
|
|
28607
29922
|
tags: [
|
|
28608
|
-
"
|
|
29923
|
+
"Well Plans"
|
|
28609
29924
|
],
|
|
28610
29925
|
parameters: [
|
|
28611
|
-
{
|
|
28612
|
-
name: "user_id",
|
|
28613
|
-
"in": "path",
|
|
28614
|
-
type: "integer",
|
|
28615
|
-
required: true,
|
|
28616
|
-
description: "User ID"
|
|
28617
|
-
},
|
|
28618
29926
|
{
|
|
28619
29927
|
name: "id",
|
|
28620
29928
|
"in": "path",
|
|
28621
29929
|
type: "integer",
|
|
28622
29930
|
required: true,
|
|
28623
|
-
description: "
|
|
29931
|
+
description: "Well Plan ID"
|
|
28624
29932
|
}
|
|
28625
29933
|
],
|
|
28626
29934
|
requestBody: {
|
|
@@ -28630,7 +29938,7 @@ var clientsData = [
|
|
|
28630
29938
|
},
|
|
28631
29939
|
responses: {
|
|
28632
29940
|
"200": {
|
|
28633
|
-
description: "
|
|
29941
|
+
description: "Updated well plan",
|
|
28634
29942
|
schema: "any"
|
|
28635
29943
|
},
|
|
28636
29944
|
"401": {
|
|
@@ -28648,64 +29956,24 @@ var clientsData = [
|
|
|
28648
29956
|
}
|
|
28649
29957
|
},
|
|
28650
29958
|
{
|
|
28651
|
-
path: "/v2/
|
|
28652
|
-
method: "
|
|
28653
|
-
summary: "
|
|
28654
|
-
tags: [
|
|
28655
|
-
"Dashboards"
|
|
28656
|
-
],
|
|
28657
|
-
parameters: [
|
|
28658
|
-
],
|
|
28659
|
-
responses: {
|
|
28660
|
-
"200": {
|
|
28661
|
-
description: "Template dashboards",
|
|
28662
|
-
schema: "any"
|
|
28663
|
-
},
|
|
28664
|
-
"401": {
|
|
28665
|
-
description: "Authentication error",
|
|
28666
|
-
schema: "any"
|
|
28667
|
-
},
|
|
28668
|
-
"403": {
|
|
28669
|
-
description: "Authorization error",
|
|
28670
|
-
schema: "any"
|
|
28671
|
-
},
|
|
28672
|
-
"404": {
|
|
28673
|
-
description: "Not found error",
|
|
28674
|
-
schema: "any"
|
|
28675
|
-
}
|
|
28676
|
-
}
|
|
28677
|
-
},
|
|
28678
|
-
{
|
|
28679
|
-
path: "/v2/users/{user_id}/dashboards/{id}/use_template",
|
|
28680
|
-
method: "POST",
|
|
28681
|
-
summary: "Set dashboard apps and layout from a template dashboard",
|
|
29959
|
+
path: "/v2/well_plans/{id}",
|
|
29960
|
+
method: "DELETE",
|
|
29961
|
+
summary: "Delete well plan",
|
|
28682
29962
|
tags: [
|
|
28683
|
-
"
|
|
29963
|
+
"Well Plans"
|
|
28684
29964
|
],
|
|
28685
29965
|
parameters: [
|
|
28686
|
-
{
|
|
28687
|
-
name: "user_id",
|
|
28688
|
-
"in": "path",
|
|
28689
|
-
type: "integer",
|
|
28690
|
-
required: true,
|
|
28691
|
-
description: "User ID"
|
|
28692
|
-
},
|
|
28693
29966
|
{
|
|
28694
29967
|
name: "id",
|
|
28695
29968
|
"in": "path",
|
|
28696
29969
|
type: "integer",
|
|
28697
29970
|
required: true,
|
|
28698
|
-
description: "
|
|
29971
|
+
description: "Well Plan ID"
|
|
28699
29972
|
}
|
|
28700
29973
|
],
|
|
28701
|
-
requestBody: {
|
|
28702
|
-
contentType: "application/json",
|
|
28703
|
-
schema: "integer",
|
|
28704
|
-
required: true
|
|
28705
|
-
},
|
|
28706
29974
|
responses: {
|
|
28707
29975
|
"200": {
|
|
28708
|
-
description: "
|
|
29976
|
+
description: "Well plan deleted",
|
|
28709
29977
|
schema: "any"
|
|
28710
29978
|
},
|
|
28711
29979
|
"401": {
|
|
@@ -28723,75 +29991,33 @@ var clientsData = [
|
|
|
28723
29991
|
}
|
|
28724
29992
|
},
|
|
28725
29993
|
{
|
|
28726
|
-
path: "/v2/
|
|
29994
|
+
path: "/v2/well_plan_tabs",
|
|
28727
29995
|
method: "GET",
|
|
28728
|
-
summary: "List
|
|
29996
|
+
summary: "List well plan tabs",
|
|
28729
29997
|
tags: [
|
|
28730
|
-
"
|
|
29998
|
+
"Well Plan Tabs"
|
|
28731
29999
|
],
|
|
28732
30000
|
parameters: [
|
|
28733
30001
|
{
|
|
28734
|
-
name: "
|
|
28735
|
-
"in": "query",
|
|
28736
|
-
type: "string",
|
|
28737
|
-
required: false,
|
|
28738
|
-
description: "Filter Dashboards by visibility"
|
|
28739
|
-
},
|
|
28740
|
-
{
|
|
28741
|
-
name: "type",
|
|
28742
|
-
"in": "query",
|
|
28743
|
-
type: "string",
|
|
28744
|
-
required: false,
|
|
28745
|
-
description: "Filter Dashboards by type"
|
|
28746
|
-
},
|
|
28747
|
-
{
|
|
28748
|
-
name: "viewed",
|
|
28749
|
-
"in": "query",
|
|
28750
|
-
type: "string",
|
|
28751
|
-
required: false,
|
|
28752
|
-
description: "Filter Dashboards by viewed"
|
|
28753
|
-
},
|
|
28754
|
-
{
|
|
28755
|
-
name: "segment",
|
|
28756
|
-
"in": "query",
|
|
28757
|
-
type: "string",
|
|
28758
|
-
required: false,
|
|
28759
|
-
description: "Filter Dashboards by segment"
|
|
28760
|
-
},
|
|
28761
|
-
{
|
|
28762
|
-
name: "layout",
|
|
28763
|
-
"in": "query",
|
|
28764
|
-
type: "string",
|
|
28765
|
-
required: false,
|
|
28766
|
-
description: "Filter Dashboards by layout"
|
|
28767
|
-
},
|
|
28768
|
-
{
|
|
28769
|
-
name: "category",
|
|
28770
|
-
"in": "query",
|
|
28771
|
-
type: "string",
|
|
28772
|
-
required: false,
|
|
28773
|
-
description: "Filter Dashboards by category"
|
|
28774
|
-
},
|
|
28775
|
-
{
|
|
28776
|
-
name: "exclude_shared",
|
|
30002
|
+
name: "company_id",
|
|
28777
30003
|
"in": "query",
|
|
28778
|
-
type: "
|
|
30004
|
+
type: "integer",
|
|
28779
30005
|
required: false,
|
|
28780
|
-
description: "Filter
|
|
30006
|
+
description: "Filter by company ID"
|
|
28781
30007
|
},
|
|
28782
30008
|
{
|
|
28783
|
-
name: "
|
|
30009
|
+
name: "per_page",
|
|
28784
30010
|
"in": "query",
|
|
28785
|
-
type: "
|
|
30011
|
+
type: "integer",
|
|
28786
30012
|
required: false,
|
|
28787
|
-
description: "
|
|
30013
|
+
description: "Number of items to list per page"
|
|
28788
30014
|
},
|
|
28789
30015
|
{
|
|
28790
|
-
name: "
|
|
30016
|
+
name: "page",
|
|
28791
30017
|
"in": "query",
|
|
28792
|
-
type: "
|
|
30018
|
+
type: "integer",
|
|
28793
30019
|
required: false,
|
|
28794
|
-
description: "
|
|
30020
|
+
description: "Page number"
|
|
28795
30021
|
}
|
|
28796
30022
|
],
|
|
28797
30023
|
responses: {
|
|
@@ -28814,11 +30040,11 @@ var clientsData = [
|
|
|
28814
30040
|
}
|
|
28815
30041
|
},
|
|
28816
30042
|
{
|
|
28817
|
-
path: "/v2/
|
|
30043
|
+
path: "/v2/well_plan_tabs/{id}",
|
|
28818
30044
|
method: "GET",
|
|
28819
|
-
summary: "
|
|
30045
|
+
summary: "Show well plan tab",
|
|
28820
30046
|
tags: [
|
|
28821
|
-
"
|
|
30047
|
+
"Well Plan Tabs"
|
|
28822
30048
|
],
|
|
28823
30049
|
parameters: [
|
|
28824
30050
|
{
|
|
@@ -28826,7 +30052,7 @@ var clientsData = [
|
|
|
28826
30052
|
"in": "path",
|
|
28827
30053
|
type: "integer",
|
|
28828
30054
|
required: true,
|
|
28829
|
-
description: "
|
|
30055
|
+
description: "Well Plan Tab ID"
|
|
28830
30056
|
}
|
|
28831
30057
|
],
|
|
28832
30058
|
responses: {
|
|
@@ -48381,6 +49607,118 @@ var clientsData = [
|
|
|
48381
49607
|
}
|
|
48382
49608
|
}
|
|
48383
49609
|
},
|
|
49610
|
+
{
|
|
49611
|
+
path: "/v2/well_drillout_unit_runs",
|
|
49612
|
+
method: "GET",
|
|
49613
|
+
summary: "List well drillout unit runs",
|
|
49614
|
+
tags: [
|
|
49615
|
+
"WellDrilloutUnitRuns"
|
|
49616
|
+
],
|
|
49617
|
+
parameters: [
|
|
49618
|
+
{
|
|
49619
|
+
name: "company_id",
|
|
49620
|
+
"in": "query",
|
|
49621
|
+
type: "integer",
|
|
49622
|
+
required: false,
|
|
49623
|
+
description: "Filter by company ID"
|
|
49624
|
+
},
|
|
49625
|
+
{
|
|
49626
|
+
name: "well_id",
|
|
49627
|
+
"in": "query",
|
|
49628
|
+
type: "integer",
|
|
49629
|
+
required: false,
|
|
49630
|
+
description: "Filter by well ID"
|
|
49631
|
+
},
|
|
49632
|
+
{
|
|
49633
|
+
name: "drillout_unit_id",
|
|
49634
|
+
"in": "query",
|
|
49635
|
+
type: "integer",
|
|
49636
|
+
required: false,
|
|
49637
|
+
description: "Filter by drillout unit ID"
|
|
49638
|
+
},
|
|
49639
|
+
{
|
|
49640
|
+
name: "fields",
|
|
49641
|
+
"in": "query",
|
|
49642
|
+
type: "any",
|
|
49643
|
+
required: false,
|
|
49644
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
49645
|
+
},
|
|
49646
|
+
{
|
|
49647
|
+
name: "per_page",
|
|
49648
|
+
"in": "query",
|
|
49649
|
+
type: "integer",
|
|
49650
|
+
required: false,
|
|
49651
|
+
description: "Number of well drillout unit runs per page"
|
|
49652
|
+
},
|
|
49653
|
+
{
|
|
49654
|
+
name: "page",
|
|
49655
|
+
"in": "query",
|
|
49656
|
+
type: "integer",
|
|
49657
|
+
required: false,
|
|
49658
|
+
description: "Page number"
|
|
49659
|
+
}
|
|
49660
|
+
],
|
|
49661
|
+
responses: {
|
|
49662
|
+
"200": {
|
|
49663
|
+
description: "List well drillout unit runs",
|
|
49664
|
+
schema: "any"
|
|
49665
|
+
},
|
|
49666
|
+
"401": {
|
|
49667
|
+
description: "Authentication error",
|
|
49668
|
+
schema: "any"
|
|
49669
|
+
},
|
|
49670
|
+
"403": {
|
|
49671
|
+
description: "Authorization error",
|
|
49672
|
+
schema: "any"
|
|
49673
|
+
},
|
|
49674
|
+
"404": {
|
|
49675
|
+
description: "Not found error",
|
|
49676
|
+
schema: "any"
|
|
49677
|
+
}
|
|
49678
|
+
}
|
|
49679
|
+
},
|
|
49680
|
+
{
|
|
49681
|
+
path: "/v2/well_drillout_unit_runs/{id}",
|
|
49682
|
+
method: "GET",
|
|
49683
|
+
summary: "Get a single well drillout unit run",
|
|
49684
|
+
tags: [
|
|
49685
|
+
"WellDrilloutUnitRuns"
|
|
49686
|
+
],
|
|
49687
|
+
parameters: [
|
|
49688
|
+
{
|
|
49689
|
+
name: "id",
|
|
49690
|
+
"in": "path",
|
|
49691
|
+
type: "integer",
|
|
49692
|
+
required: true,
|
|
49693
|
+
description: "Well Drillout Unit Run ID"
|
|
49694
|
+
},
|
|
49695
|
+
{
|
|
49696
|
+
name: "fields",
|
|
49697
|
+
"in": "query",
|
|
49698
|
+
type: "any",
|
|
49699
|
+
required: false,
|
|
49700
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
49701
|
+
}
|
|
49702
|
+
],
|
|
49703
|
+
responses: {
|
|
49704
|
+
"200": {
|
|
49705
|
+
description: "Get well drillout unit run",
|
|
49706
|
+
schema: "any"
|
|
49707
|
+
},
|
|
49708
|
+
"401": {
|
|
49709
|
+
description: "Authentication error",
|
|
49710
|
+
schema: "any"
|
|
49711
|
+
},
|
|
49712
|
+
"403": {
|
|
49713
|
+
description: "Authorization error",
|
|
49714
|
+
schema: "any"
|
|
49715
|
+
},
|
|
49716
|
+
"404": {
|
|
49717
|
+
description: "Not found error",
|
|
49718
|
+
schema: "any"
|
|
49719
|
+
}
|
|
49720
|
+
}
|
|
49721
|
+
},
|
|
48384
49722
|
{
|
|
48385
49723
|
path: "/v2/pad_frac_fleets",
|
|
48386
49724
|
method: "GET",
|
|
@@ -49961,30 +51299,296 @@ var clientsData = [
|
|
|
49961
51299
|
description: "Not found error",
|
|
49962
51300
|
schema: "NotFoundError"
|
|
49963
51301
|
}
|
|
49964
|
-
}
|
|
49965
|
-
}
|
|
49966
|
-
],
|
|
49967
|
-
endpointsByTag: {
|
|
49968
|
-
AbilityCheck: [
|
|
51302
|
+
}
|
|
51303
|
+
}
|
|
51304
|
+
],
|
|
51305
|
+
endpointsByTag: {
|
|
51306
|
+
AbilityCheck: [
|
|
51307
|
+
{
|
|
51308
|
+
path: "v2/ability_check/check_feature",
|
|
51309
|
+
method: "GET",
|
|
51310
|
+
summary: "Check feature status for user",
|
|
51311
|
+
tags: [
|
|
51312
|
+
"AbilityCheck"
|
|
51313
|
+
],
|
|
51314
|
+
parameters: [
|
|
51315
|
+
{
|
|
51316
|
+
name: "feature_name",
|
|
51317
|
+
"in": "query",
|
|
51318
|
+
type: "string",
|
|
51319
|
+
required: true,
|
|
51320
|
+
description: "Name of Feature"
|
|
51321
|
+
}
|
|
51322
|
+
],
|
|
51323
|
+
responses: {
|
|
51324
|
+
"200": {
|
|
51325
|
+
description: "Successful response",
|
|
51326
|
+
schema: "any"
|
|
51327
|
+
},
|
|
51328
|
+
"401": {
|
|
51329
|
+
description: "Authentication error",
|
|
51330
|
+
schema: "any"
|
|
51331
|
+
},
|
|
51332
|
+
"403": {
|
|
51333
|
+
description: "Authorization error",
|
|
51334
|
+
schema: "any"
|
|
51335
|
+
},
|
|
51336
|
+
"404": {
|
|
51337
|
+
description: "Not found error",
|
|
51338
|
+
schema: "any"
|
|
51339
|
+
}
|
|
51340
|
+
}
|
|
51341
|
+
},
|
|
51342
|
+
{
|
|
51343
|
+
path: "v2/ability_check/check_permission",
|
|
51344
|
+
method: "GET",
|
|
51345
|
+
summary: "Check permission status for user",
|
|
51346
|
+
tags: [
|
|
51347
|
+
"AbilityCheck"
|
|
51348
|
+
],
|
|
51349
|
+
parameters: [
|
|
51350
|
+
{
|
|
51351
|
+
name: "ability",
|
|
51352
|
+
"in": "query",
|
|
51353
|
+
type: "string",
|
|
51354
|
+
required: true,
|
|
51355
|
+
description: "Ability to check"
|
|
51356
|
+
},
|
|
51357
|
+
{
|
|
51358
|
+
name: "resource_class",
|
|
51359
|
+
"in": "query",
|
|
51360
|
+
type: "string",
|
|
51361
|
+
required: true,
|
|
51362
|
+
description: "Class of resource"
|
|
51363
|
+
},
|
|
51364
|
+
{
|
|
51365
|
+
name: "resource_id",
|
|
51366
|
+
"in": "query",
|
|
51367
|
+
type: "integer",
|
|
51368
|
+
required: false,
|
|
51369
|
+
description: "Id of resource if checking permission for particular entity"
|
|
51370
|
+
},
|
|
51371
|
+
{
|
|
51372
|
+
name: "name",
|
|
51373
|
+
"in": "query",
|
|
51374
|
+
type: "integer",
|
|
51375
|
+
required: false,
|
|
51376
|
+
description: "Dataset name"
|
|
51377
|
+
},
|
|
51378
|
+
{
|
|
51379
|
+
name: "provider",
|
|
51380
|
+
"in": "query",
|
|
51381
|
+
type: "integer",
|
|
51382
|
+
required: false,
|
|
51383
|
+
description: "Dataset provider"
|
|
51384
|
+
}
|
|
51385
|
+
],
|
|
51386
|
+
responses: {
|
|
51387
|
+
"200": {
|
|
51388
|
+
description: "Successful response",
|
|
51389
|
+
schema: "any"
|
|
51390
|
+
},
|
|
51391
|
+
"401": {
|
|
51392
|
+
description: "Authentication error",
|
|
51393
|
+
schema: "any"
|
|
51394
|
+
},
|
|
51395
|
+
"403": {
|
|
51396
|
+
description: "Authorization error",
|
|
51397
|
+
schema: "any"
|
|
51398
|
+
},
|
|
51399
|
+
"404": {
|
|
51400
|
+
description: "Not found error",
|
|
51401
|
+
schema: "any"
|
|
51402
|
+
}
|
|
51403
|
+
}
|
|
51404
|
+
}
|
|
51405
|
+
],
|
|
51406
|
+
AlertDefinitions: [
|
|
51407
|
+
{
|
|
51408
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_definitions",
|
|
51409
|
+
method: "GET",
|
|
51410
|
+
summary: "List an Alert Group's Definitions",
|
|
51411
|
+
tags: [
|
|
51412
|
+
"AlertDefinitions"
|
|
51413
|
+
],
|
|
51414
|
+
parameters: [
|
|
51415
|
+
{
|
|
51416
|
+
name: "alert_group_id",
|
|
51417
|
+
"in": "path",
|
|
51418
|
+
type: "integer",
|
|
51419
|
+
required: true,
|
|
51420
|
+
description: "Alert group ID"
|
|
51421
|
+
},
|
|
51422
|
+
{
|
|
51423
|
+
name: "type",
|
|
51424
|
+
"in": "query",
|
|
51425
|
+
type: "string",
|
|
51426
|
+
required: false,
|
|
51427
|
+
description: "Filter by type (personal/company)"
|
|
51428
|
+
},
|
|
51429
|
+
{
|
|
51430
|
+
name: "search",
|
|
51431
|
+
"in": "query",
|
|
51432
|
+
type: "string",
|
|
51433
|
+
required: false,
|
|
51434
|
+
description: "Search by name"
|
|
51435
|
+
},
|
|
51436
|
+
{
|
|
51437
|
+
name: "page",
|
|
51438
|
+
"in": "query",
|
|
51439
|
+
type: "integer",
|
|
51440
|
+
required: false,
|
|
51441
|
+
description: "Page number"
|
|
51442
|
+
},
|
|
51443
|
+
{
|
|
51444
|
+
name: "per_page",
|
|
51445
|
+
"in": "query",
|
|
51446
|
+
type: "integer",
|
|
51447
|
+
required: false,
|
|
51448
|
+
description: "Items per page"
|
|
51449
|
+
}
|
|
51450
|
+
],
|
|
51451
|
+
responses: {
|
|
51452
|
+
"200": {
|
|
51453
|
+
description: "The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",
|
|
51454
|
+
schema: "any"
|
|
51455
|
+
},
|
|
51456
|
+
"401": {
|
|
51457
|
+
description: "Authentication error",
|
|
51458
|
+
schema: "any"
|
|
51459
|
+
},
|
|
51460
|
+
"403": {
|
|
51461
|
+
description: "Authorization error",
|
|
51462
|
+
schema: "any"
|
|
51463
|
+
},
|
|
51464
|
+
"404": {
|
|
51465
|
+
description: "Not found error",
|
|
51466
|
+
schema: "any"
|
|
51467
|
+
}
|
|
51468
|
+
}
|
|
51469
|
+
},
|
|
51470
|
+
{
|
|
51471
|
+
path: "/v2/alerts/definitions",
|
|
51472
|
+
method: "GET",
|
|
51473
|
+
summary: "List Alert Definitions",
|
|
51474
|
+
tags: [
|
|
51475
|
+
"AlertDefinitions"
|
|
51476
|
+
],
|
|
51477
|
+
parameters: [
|
|
51478
|
+
{
|
|
51479
|
+
name: "type",
|
|
51480
|
+
"in": "query",
|
|
51481
|
+
type: "string",
|
|
51482
|
+
required: false,
|
|
51483
|
+
description: "Filter by type (personal/company)"
|
|
51484
|
+
},
|
|
51485
|
+
{
|
|
51486
|
+
name: "alert_group_id",
|
|
51487
|
+
"in": "query",
|
|
51488
|
+
type: "string",
|
|
51489
|
+
required: false,
|
|
51490
|
+
description: "Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"
|
|
51491
|
+
},
|
|
51492
|
+
{
|
|
51493
|
+
name: "search",
|
|
51494
|
+
"in": "query",
|
|
51495
|
+
type: "string",
|
|
51496
|
+
required: false,
|
|
51497
|
+
description: "Search by name"
|
|
51498
|
+
},
|
|
51499
|
+
{
|
|
51500
|
+
name: "segment",
|
|
51501
|
+
"in": "query",
|
|
51502
|
+
type: "string",
|
|
51503
|
+
required: false,
|
|
51504
|
+
description: "Filter by segment: a single key or a comma-separated list (e.g. \"drilling,completion\"). Matches definitions whose segment array overlaps the given values."
|
|
51505
|
+
},
|
|
51506
|
+
{
|
|
51507
|
+
name: "page",
|
|
51508
|
+
"in": "query",
|
|
51509
|
+
type: "integer",
|
|
51510
|
+
required: false,
|
|
51511
|
+
description: "Page number"
|
|
51512
|
+
},
|
|
51513
|
+
{
|
|
51514
|
+
name: "per_page",
|
|
51515
|
+
"in": "query",
|
|
51516
|
+
type: "integer",
|
|
51517
|
+
required: false,
|
|
51518
|
+
description: "Items per page"
|
|
51519
|
+
}
|
|
51520
|
+
],
|
|
51521
|
+
responses: {
|
|
51522
|
+
"200": {
|
|
51523
|
+
description: "List of alert definitions",
|
|
51524
|
+
schema: "any"
|
|
51525
|
+
},
|
|
51526
|
+
"401": {
|
|
51527
|
+
description: "Authentication error",
|
|
51528
|
+
schema: "any"
|
|
51529
|
+
},
|
|
51530
|
+
"403": {
|
|
51531
|
+
description: "Authorization error",
|
|
51532
|
+
schema: "any"
|
|
51533
|
+
},
|
|
51534
|
+
"404": {
|
|
51535
|
+
description: "Not found error",
|
|
51536
|
+
schema: "any"
|
|
51537
|
+
}
|
|
51538
|
+
}
|
|
51539
|
+
},
|
|
51540
|
+
{
|
|
51541
|
+
path: "/v2/alerts/definitions",
|
|
51542
|
+
method: "POST",
|
|
51543
|
+
summary: "Create Alert Definition",
|
|
51544
|
+
tags: [
|
|
51545
|
+
"AlertDefinitions"
|
|
51546
|
+
],
|
|
51547
|
+
parameters: [
|
|
51548
|
+
],
|
|
51549
|
+
requestBody: {
|
|
51550
|
+
contentType: "application/json",
|
|
51551
|
+
schema: "any",
|
|
51552
|
+
required: true
|
|
51553
|
+
},
|
|
51554
|
+
responses: {
|
|
51555
|
+
"200": {
|
|
51556
|
+
description: "Created alert definition",
|
|
51557
|
+
schema: "any"
|
|
51558
|
+
},
|
|
51559
|
+
"401": {
|
|
51560
|
+
description: "Authentication error",
|
|
51561
|
+
schema: "any"
|
|
51562
|
+
},
|
|
51563
|
+
"403": {
|
|
51564
|
+
description: "Authorization error",
|
|
51565
|
+
schema: "any"
|
|
51566
|
+
},
|
|
51567
|
+
"404": {
|
|
51568
|
+
description: "Not found error",
|
|
51569
|
+
schema: "any"
|
|
51570
|
+
}
|
|
51571
|
+
}
|
|
51572
|
+
},
|
|
49969
51573
|
{
|
|
49970
|
-
path: "v2/
|
|
51574
|
+
path: "/v2/alerts/definitions/{id}",
|
|
49971
51575
|
method: "GET",
|
|
49972
|
-
summary: "
|
|
51576
|
+
summary: "Get Alert Definition",
|
|
49973
51577
|
tags: [
|
|
49974
|
-
"
|
|
51578
|
+
"AlertDefinitions"
|
|
49975
51579
|
],
|
|
49976
51580
|
parameters: [
|
|
49977
51581
|
{
|
|
49978
|
-
name: "
|
|
49979
|
-
"in": "
|
|
49980
|
-
type: "
|
|
51582
|
+
name: "id",
|
|
51583
|
+
"in": "path",
|
|
51584
|
+
type: "integer",
|
|
49981
51585
|
required: true,
|
|
49982
|
-
description: "
|
|
51586
|
+
description: ""
|
|
49983
51587
|
}
|
|
49984
51588
|
],
|
|
49985
51589
|
responses: {
|
|
49986
51590
|
"200": {
|
|
49987
|
-
description: "
|
|
51591
|
+
description: "Alert definition details",
|
|
49988
51592
|
schema: "any"
|
|
49989
51593
|
},
|
|
49990
51594
|
"401": {
|
|
@@ -50002,53 +51606,140 @@ var clientsData = [
|
|
|
50002
51606
|
}
|
|
50003
51607
|
},
|
|
50004
51608
|
{
|
|
50005
|
-
path: "v2/
|
|
50006
|
-
method: "
|
|
50007
|
-
summary: "
|
|
51609
|
+
path: "/v2/alerts/definitions/{id}",
|
|
51610
|
+
method: "PATCH",
|
|
51611
|
+
summary: "Update Alert Definition",
|
|
50008
51612
|
tags: [
|
|
50009
|
-
"
|
|
51613
|
+
"AlertDefinitions"
|
|
50010
51614
|
],
|
|
50011
51615
|
parameters: [
|
|
50012
51616
|
{
|
|
50013
|
-
name: "
|
|
50014
|
-
"in": "
|
|
50015
|
-
type: "
|
|
51617
|
+
name: "id",
|
|
51618
|
+
"in": "path",
|
|
51619
|
+
type: "integer",
|
|
50016
51620
|
required: true,
|
|
50017
|
-
description: "
|
|
51621
|
+
description: ""
|
|
51622
|
+
}
|
|
51623
|
+
],
|
|
51624
|
+
requestBody: {
|
|
51625
|
+
contentType: "application/json",
|
|
51626
|
+
schema: "any",
|
|
51627
|
+
required: true
|
|
51628
|
+
},
|
|
51629
|
+
responses: {
|
|
51630
|
+
"200": {
|
|
51631
|
+
description: "Updated alert definition",
|
|
51632
|
+
schema: "any"
|
|
50018
51633
|
},
|
|
50019
|
-
{
|
|
50020
|
-
|
|
50021
|
-
|
|
50022
|
-
|
|
50023
|
-
|
|
50024
|
-
description: "
|
|
51634
|
+
"401": {
|
|
51635
|
+
description: "Authentication error",
|
|
51636
|
+
schema: "any"
|
|
51637
|
+
},
|
|
51638
|
+
"403": {
|
|
51639
|
+
description: "Authorization error",
|
|
51640
|
+
schema: "any"
|
|
50025
51641
|
},
|
|
51642
|
+
"404": {
|
|
51643
|
+
description: "Not found error",
|
|
51644
|
+
schema: "any"
|
|
51645
|
+
}
|
|
51646
|
+
}
|
|
51647
|
+
},
|
|
51648
|
+
{
|
|
51649
|
+
path: "/v2/alerts/definitions/{id}",
|
|
51650
|
+
method: "DELETE",
|
|
51651
|
+
summary: "Delete Alert Definition",
|
|
51652
|
+
tags: [
|
|
51653
|
+
"AlertDefinitions"
|
|
51654
|
+
],
|
|
51655
|
+
parameters: [
|
|
50026
51656
|
{
|
|
50027
|
-
name: "
|
|
50028
|
-
"in": "
|
|
51657
|
+
name: "id",
|
|
51658
|
+
"in": "path",
|
|
50029
51659
|
type: "integer",
|
|
50030
|
-
required:
|
|
50031
|
-
description: "
|
|
51660
|
+
required: true,
|
|
51661
|
+
description: ""
|
|
51662
|
+
}
|
|
51663
|
+
],
|
|
51664
|
+
responses: {
|
|
51665
|
+
"200": {
|
|
51666
|
+
description: "Deleted"
|
|
51667
|
+
},
|
|
51668
|
+
"401": {
|
|
51669
|
+
description: "Authentication error",
|
|
51670
|
+
schema: "any"
|
|
50032
51671
|
},
|
|
51672
|
+
"403": {
|
|
51673
|
+
description: "Authorization error",
|
|
51674
|
+
schema: "any"
|
|
51675
|
+
},
|
|
51676
|
+
"404": {
|
|
51677
|
+
description: "Not found error",
|
|
51678
|
+
schema: "any"
|
|
51679
|
+
}
|
|
51680
|
+
}
|
|
51681
|
+
},
|
|
51682
|
+
{
|
|
51683
|
+
path: "/v2/alerts/definitions/{id}/subscribe",
|
|
51684
|
+
method: "POST",
|
|
51685
|
+
summary: "Subscribe to Alert Definition",
|
|
51686
|
+
tags: [
|
|
51687
|
+
"AlertDefinitions"
|
|
51688
|
+
],
|
|
51689
|
+
parameters: [
|
|
50033
51690
|
{
|
|
50034
|
-
name: "
|
|
50035
|
-
"in": "
|
|
51691
|
+
name: "id",
|
|
51692
|
+
"in": "path",
|
|
50036
51693
|
type: "integer",
|
|
50037
|
-
required:
|
|
50038
|
-
description: "
|
|
51694
|
+
required: true,
|
|
51695
|
+
description: ""
|
|
51696
|
+
}
|
|
51697
|
+
],
|
|
51698
|
+
requestBody: {
|
|
51699
|
+
contentType: "application/json",
|
|
51700
|
+
schema: "any",
|
|
51701
|
+
required: false
|
|
51702
|
+
},
|
|
51703
|
+
responses: {
|
|
51704
|
+
"200": {
|
|
51705
|
+
description: "Subscription created; activates an inactive definition"
|
|
51706
|
+
},
|
|
51707
|
+
"401": {
|
|
51708
|
+
description: "Authentication error",
|
|
51709
|
+
schema: "any"
|
|
51710
|
+
},
|
|
51711
|
+
"403": {
|
|
51712
|
+
description: "Authorization error",
|
|
51713
|
+
schema: "any"
|
|
51714
|
+
},
|
|
51715
|
+
"404": {
|
|
51716
|
+
description: "Not found error",
|
|
51717
|
+
schema: "any"
|
|
50039
51718
|
},
|
|
51719
|
+
"409": {
|
|
51720
|
+
description: "Subscription already exists"
|
|
51721
|
+
}
|
|
51722
|
+
}
|
|
51723
|
+
},
|
|
51724
|
+
{
|
|
51725
|
+
path: "/v2/alerts/definitions/{id}/unsubscribe",
|
|
51726
|
+
method: "POST",
|
|
51727
|
+
summary: "Unsubscribe from Alert Definition",
|
|
51728
|
+
tags: [
|
|
51729
|
+
"AlertDefinitions"
|
|
51730
|
+
],
|
|
51731
|
+
parameters: [
|
|
50040
51732
|
{
|
|
50041
|
-
name: "
|
|
50042
|
-
"in": "
|
|
51733
|
+
name: "id",
|
|
51734
|
+
"in": "path",
|
|
50043
51735
|
type: "integer",
|
|
50044
|
-
required:
|
|
50045
|
-
description: "
|
|
51736
|
+
required: true,
|
|
51737
|
+
description: ""
|
|
50046
51738
|
}
|
|
50047
51739
|
],
|
|
50048
51740
|
responses: {
|
|
50049
51741
|
"200": {
|
|
50050
|
-
description: "
|
|
50051
|
-
schema: "any"
|
|
51742
|
+
description: "Unsubscribed; deactivates a personal definition left without subscriptions"
|
|
50052
51743
|
},
|
|
50053
51744
|
"401": {
|
|
50054
51745
|
description: "Authentication error",
|
|
@@ -50065,22 +51756,15 @@ var clientsData = [
|
|
|
50065
51756
|
}
|
|
50066
51757
|
}
|
|
50067
51758
|
],
|
|
50068
|
-
|
|
51759
|
+
AlertGroups: [
|
|
50069
51760
|
{
|
|
50070
|
-
path: "/v2/
|
|
51761
|
+
path: "/v2/alert_groups",
|
|
50071
51762
|
method: "GET",
|
|
50072
|
-
summary: "List Alert
|
|
51763
|
+
summary: "List Alert Groups",
|
|
50073
51764
|
tags: [
|
|
50074
|
-
"
|
|
51765
|
+
"AlertGroups"
|
|
50075
51766
|
],
|
|
50076
51767
|
parameters: [
|
|
50077
|
-
{
|
|
50078
|
-
name: "type",
|
|
50079
|
-
"in": "query",
|
|
50080
|
-
type: "string",
|
|
50081
|
-
required: false,
|
|
50082
|
-
description: "Filter by type (personal/company)"
|
|
50083
|
-
},
|
|
50084
51768
|
{
|
|
50085
51769
|
name: "search",
|
|
50086
51770
|
"in": "query",
|
|
@@ -50105,7 +51789,7 @@ var clientsData = [
|
|
|
50105
51789
|
],
|
|
50106
51790
|
responses: {
|
|
50107
51791
|
"200": {
|
|
50108
|
-
description: "List of alert
|
|
51792
|
+
description: "List of alert groups",
|
|
50109
51793
|
schema: "any"
|
|
50110
51794
|
},
|
|
50111
51795
|
"401": {
|
|
@@ -50123,11 +51807,11 @@ var clientsData = [
|
|
|
50123
51807
|
}
|
|
50124
51808
|
},
|
|
50125
51809
|
{
|
|
50126
|
-
path: "/v2/
|
|
51810
|
+
path: "/v2/alert_groups",
|
|
50127
51811
|
method: "POST",
|
|
50128
|
-
summary: "Create Alert
|
|
51812
|
+
summary: "Create Alert Group",
|
|
50129
51813
|
tags: [
|
|
50130
|
-
"
|
|
51814
|
+
"AlertGroups"
|
|
50131
51815
|
],
|
|
50132
51816
|
parameters: [
|
|
50133
51817
|
],
|
|
@@ -50138,7 +51822,7 @@ var clientsData = [
|
|
|
50138
51822
|
},
|
|
50139
51823
|
responses: {
|
|
50140
51824
|
"200": {
|
|
50141
|
-
description: "Created alert
|
|
51825
|
+
description: "Created alert group",
|
|
50142
51826
|
schema: "any"
|
|
50143
51827
|
},
|
|
50144
51828
|
"401": {
|
|
@@ -50156,15 +51840,15 @@ var clientsData = [
|
|
|
50156
51840
|
}
|
|
50157
51841
|
},
|
|
50158
51842
|
{
|
|
50159
|
-
path: "/v2/
|
|
51843
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
50160
51844
|
method: "GET",
|
|
50161
|
-
summary: "
|
|
51845
|
+
summary: "List Group Assets",
|
|
50162
51846
|
tags: [
|
|
50163
|
-
"
|
|
51847
|
+
"AlertGroups"
|
|
50164
51848
|
],
|
|
50165
51849
|
parameters: [
|
|
50166
51850
|
{
|
|
50167
|
-
name: "
|
|
51851
|
+
name: "alert_group_id",
|
|
50168
51852
|
"in": "path",
|
|
50169
51853
|
type: "integer",
|
|
50170
51854
|
required: true,
|
|
@@ -50173,7 +51857,7 @@ var clientsData = [
|
|
|
50173
51857
|
],
|
|
50174
51858
|
responses: {
|
|
50175
51859
|
"200": {
|
|
50176
|
-
description: "
|
|
51860
|
+
description: "List of group assets",
|
|
50177
51861
|
schema: "any"
|
|
50178
51862
|
},
|
|
50179
51863
|
"401": {
|
|
@@ -50191,15 +51875,15 @@ var clientsData = [
|
|
|
50191
51875
|
}
|
|
50192
51876
|
},
|
|
50193
51877
|
{
|
|
50194
|
-
path: "/v2/
|
|
50195
|
-
method: "
|
|
50196
|
-
summary: "
|
|
51878
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
51879
|
+
method: "POST",
|
|
51880
|
+
summary: "Add Asset to Group",
|
|
50197
51881
|
tags: [
|
|
50198
|
-
"
|
|
51882
|
+
"AlertGroups"
|
|
50199
51883
|
],
|
|
50200
51884
|
parameters: [
|
|
50201
51885
|
{
|
|
50202
|
-
name: "
|
|
51886
|
+
name: "alert_group_id",
|
|
50203
51887
|
"in": "path",
|
|
50204
51888
|
type: "integer",
|
|
50205
51889
|
required: true,
|
|
@@ -50213,7 +51897,7 @@ var clientsData = [
|
|
|
50213
51897
|
},
|
|
50214
51898
|
responses: {
|
|
50215
51899
|
"200": {
|
|
50216
|
-
description: "
|
|
51900
|
+
description: "Added asset",
|
|
50217
51901
|
schema: "any"
|
|
50218
51902
|
},
|
|
50219
51903
|
"401": {
|
|
@@ -50231,13 +51915,20 @@ var clientsData = [
|
|
|
50231
51915
|
}
|
|
50232
51916
|
},
|
|
50233
51917
|
{
|
|
50234
|
-
path: "/v2/
|
|
51918
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/{id}",
|
|
50235
51919
|
method: "DELETE",
|
|
50236
|
-
summary: "
|
|
51920
|
+
summary: "Remove Asset from Group",
|
|
50237
51921
|
tags: [
|
|
50238
|
-
"
|
|
51922
|
+
"AlertGroups"
|
|
50239
51923
|
],
|
|
50240
51924
|
parameters: [
|
|
51925
|
+
{
|
|
51926
|
+
name: "alert_group_id",
|
|
51927
|
+
"in": "path",
|
|
51928
|
+
type: "integer",
|
|
51929
|
+
required: true,
|
|
51930
|
+
description: ""
|
|
51931
|
+
},
|
|
50241
51932
|
{
|
|
50242
51933
|
name: "id",
|
|
50243
51934
|
"in": "path",
|
|
@@ -50248,7 +51939,7 @@ var clientsData = [
|
|
|
50248
51939
|
],
|
|
50249
51940
|
responses: {
|
|
50250
51941
|
"200": {
|
|
50251
|
-
description: "
|
|
51942
|
+
description: "Removed"
|
|
50252
51943
|
},
|
|
50253
51944
|
"401": {
|
|
50254
51945
|
description: "Authentication error",
|
|
@@ -50263,42 +51954,196 @@ var clientsData = [
|
|
|
50263
51954
|
schema: "any"
|
|
50264
51955
|
}
|
|
50265
51956
|
}
|
|
50266
|
-
}
|
|
50267
|
-
],
|
|
50268
|
-
AlertGroups: [
|
|
51957
|
+
},
|
|
50269
51958
|
{
|
|
50270
|
-
path: "/v2/alert_groups",
|
|
51959
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_create",
|
|
51960
|
+
method: "POST",
|
|
51961
|
+
summary: "Bulk Add Assets to Group",
|
|
51962
|
+
tags: [
|
|
51963
|
+
"AlertGroups"
|
|
51964
|
+
],
|
|
51965
|
+
parameters: [
|
|
51966
|
+
{
|
|
51967
|
+
name: "alert_group_id",
|
|
51968
|
+
"in": "path",
|
|
51969
|
+
type: "integer",
|
|
51970
|
+
required: true,
|
|
51971
|
+
description: ""
|
|
51972
|
+
}
|
|
51973
|
+
],
|
|
51974
|
+
requestBody: {
|
|
51975
|
+
contentType: "application/json",
|
|
51976
|
+
schema: "any",
|
|
51977
|
+
required: true
|
|
51978
|
+
},
|
|
51979
|
+
responses: {
|
|
51980
|
+
"200": {
|
|
51981
|
+
description: "Assets added (idempotent — assets already in the group are skipped)",
|
|
51982
|
+
schema: "any"
|
|
51983
|
+
},
|
|
51984
|
+
"400": {
|
|
51985
|
+
description: "Validation error; no assets were added"
|
|
51986
|
+
},
|
|
51987
|
+
"401": {
|
|
51988
|
+
description: "Authentication error",
|
|
51989
|
+
schema: "any"
|
|
51990
|
+
},
|
|
51991
|
+
"403": {
|
|
51992
|
+
description: "Authorization error",
|
|
51993
|
+
schema: "any"
|
|
51994
|
+
},
|
|
51995
|
+
"404": {
|
|
51996
|
+
description: "Not found error",
|
|
51997
|
+
schema: "any"
|
|
51998
|
+
}
|
|
51999
|
+
}
|
|
52000
|
+
},
|
|
52001
|
+
{
|
|
52002
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_destroy",
|
|
52003
|
+
method: "DELETE",
|
|
52004
|
+
summary: "Bulk Remove Assets from Group",
|
|
52005
|
+
tags: [
|
|
52006
|
+
"AlertGroups"
|
|
52007
|
+
],
|
|
52008
|
+
parameters: [
|
|
52009
|
+
{
|
|
52010
|
+
name: "alert_group_id",
|
|
52011
|
+
"in": "path",
|
|
52012
|
+
type: "integer",
|
|
52013
|
+
required: true,
|
|
52014
|
+
description: ""
|
|
52015
|
+
}
|
|
52016
|
+
],
|
|
52017
|
+
requestBody: {
|
|
52018
|
+
contentType: "application/json",
|
|
52019
|
+
schema: "any",
|
|
52020
|
+
required: true
|
|
52021
|
+
},
|
|
52022
|
+
responses: {
|
|
52023
|
+
"200": {
|
|
52024
|
+
description: "Assets removed",
|
|
52025
|
+
schema: "any"
|
|
52026
|
+
},
|
|
52027
|
+
"401": {
|
|
52028
|
+
description: "Authentication error",
|
|
52029
|
+
schema: "any"
|
|
52030
|
+
},
|
|
52031
|
+
"403": {
|
|
52032
|
+
description: "Authorization error",
|
|
52033
|
+
schema: "any"
|
|
52034
|
+
},
|
|
52035
|
+
"404": {
|
|
52036
|
+
description: "Not found error",
|
|
52037
|
+
schema: "any"
|
|
52038
|
+
}
|
|
52039
|
+
}
|
|
52040
|
+
},
|
|
52041
|
+
{
|
|
52042
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
50271
52043
|
method: "GET",
|
|
50272
|
-
summary: "List
|
|
52044
|
+
summary: "List Group Configurations",
|
|
50273
52045
|
tags: [
|
|
50274
52046
|
"AlertGroups"
|
|
50275
52047
|
],
|
|
50276
52048
|
parameters: [
|
|
50277
52049
|
{
|
|
50278
|
-
name: "
|
|
50279
|
-
"in": "
|
|
50280
|
-
type: "
|
|
50281
|
-
required:
|
|
50282
|
-
description: "
|
|
52050
|
+
name: "alert_group_id",
|
|
52051
|
+
"in": "path",
|
|
52052
|
+
type: "integer",
|
|
52053
|
+
required: true,
|
|
52054
|
+
description: ""
|
|
52055
|
+
}
|
|
52056
|
+
],
|
|
52057
|
+
responses: {
|
|
52058
|
+
"200": {
|
|
52059
|
+
description: "List of configurations",
|
|
52060
|
+
schema: "any"
|
|
52061
|
+
},
|
|
52062
|
+
"401": {
|
|
52063
|
+
description: "Authentication error",
|
|
52064
|
+
schema: "any"
|
|
52065
|
+
},
|
|
52066
|
+
"403": {
|
|
52067
|
+
description: "Authorization error",
|
|
52068
|
+
schema: "any"
|
|
50283
52069
|
},
|
|
52070
|
+
"404": {
|
|
52071
|
+
description: "Not found error",
|
|
52072
|
+
schema: "any"
|
|
52073
|
+
}
|
|
52074
|
+
}
|
|
52075
|
+
},
|
|
52076
|
+
{
|
|
52077
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
52078
|
+
method: "POST",
|
|
52079
|
+
summary: "Create Group Configuration",
|
|
52080
|
+
tags: [
|
|
52081
|
+
"AlertGroups"
|
|
52082
|
+
],
|
|
52083
|
+
parameters: [
|
|
50284
52084
|
{
|
|
50285
|
-
name: "
|
|
50286
|
-
"in": "
|
|
52085
|
+
name: "alert_group_id",
|
|
52086
|
+
"in": "path",
|
|
50287
52087
|
type: "integer",
|
|
50288
|
-
required:
|
|
50289
|
-
description: "
|
|
52088
|
+
required: true,
|
|
52089
|
+
description: ""
|
|
52090
|
+
}
|
|
52091
|
+
],
|
|
52092
|
+
requestBody: {
|
|
52093
|
+
contentType: "application/json",
|
|
52094
|
+
schema: "any",
|
|
52095
|
+
required: true
|
|
52096
|
+
},
|
|
52097
|
+
responses: {
|
|
52098
|
+
"200": {
|
|
52099
|
+
description: "Created configuration",
|
|
52100
|
+
schema: "any"
|
|
52101
|
+
},
|
|
52102
|
+
"401": {
|
|
52103
|
+
description: "Authentication error",
|
|
52104
|
+
schema: "any"
|
|
52105
|
+
},
|
|
52106
|
+
"403": {
|
|
52107
|
+
description: "Authorization error",
|
|
52108
|
+
schema: "any"
|
|
52109
|
+
},
|
|
52110
|
+
"404": {
|
|
52111
|
+
description: "Not found error",
|
|
52112
|
+
schema: "any"
|
|
52113
|
+
}
|
|
52114
|
+
}
|
|
52115
|
+
},
|
|
52116
|
+
{
|
|
52117
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
52118
|
+
method: "PATCH",
|
|
52119
|
+
summary: "Update Group Configuration",
|
|
52120
|
+
tags: [
|
|
52121
|
+
"AlertGroups"
|
|
52122
|
+
],
|
|
52123
|
+
parameters: [
|
|
52124
|
+
{
|
|
52125
|
+
name: "alert_group_id",
|
|
52126
|
+
"in": "path",
|
|
52127
|
+
type: "integer",
|
|
52128
|
+
required: true,
|
|
52129
|
+
description: ""
|
|
50290
52130
|
},
|
|
50291
52131
|
{
|
|
50292
|
-
name: "
|
|
50293
|
-
"in": "
|
|
52132
|
+
name: "id",
|
|
52133
|
+
"in": "path",
|
|
50294
52134
|
type: "integer",
|
|
50295
|
-
required:
|
|
50296
|
-
description: "
|
|
52135
|
+
required: true,
|
|
52136
|
+
description: ""
|
|
50297
52137
|
}
|
|
50298
52138
|
],
|
|
52139
|
+
requestBody: {
|
|
52140
|
+
contentType: "application/json",
|
|
52141
|
+
schema: "any",
|
|
52142
|
+
required: true
|
|
52143
|
+
},
|
|
50299
52144
|
responses: {
|
|
50300
52145
|
"200": {
|
|
50301
|
-
description: "
|
|
52146
|
+
description: "Updated configuration",
|
|
50302
52147
|
schema: "any"
|
|
50303
52148
|
},
|
|
50304
52149
|
"401": {
|
|
@@ -50316,13 +52161,61 @@ var clientsData = [
|
|
|
50316
52161
|
}
|
|
50317
52162
|
},
|
|
50318
52163
|
{
|
|
50319
|
-
path: "/v2/alert_groups",
|
|
52164
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
52165
|
+
method: "DELETE",
|
|
52166
|
+
summary: "Delete Group Configuration",
|
|
52167
|
+
tags: [
|
|
52168
|
+
"AlertGroups"
|
|
52169
|
+
],
|
|
52170
|
+
parameters: [
|
|
52171
|
+
{
|
|
52172
|
+
name: "alert_group_id",
|
|
52173
|
+
"in": "path",
|
|
52174
|
+
type: "integer",
|
|
52175
|
+
required: true,
|
|
52176
|
+
description: ""
|
|
52177
|
+
},
|
|
52178
|
+
{
|
|
52179
|
+
name: "id",
|
|
52180
|
+
"in": "path",
|
|
52181
|
+
type: "integer",
|
|
52182
|
+
required: true,
|
|
52183
|
+
description: ""
|
|
52184
|
+
}
|
|
52185
|
+
],
|
|
52186
|
+
responses: {
|
|
52187
|
+
"200": {
|
|
52188
|
+
description: "Deleted"
|
|
52189
|
+
},
|
|
52190
|
+
"401": {
|
|
52191
|
+
description: "Authentication error",
|
|
52192
|
+
schema: "any"
|
|
52193
|
+
},
|
|
52194
|
+
"403": {
|
|
52195
|
+
description: "Authorization error",
|
|
52196
|
+
schema: "any"
|
|
52197
|
+
},
|
|
52198
|
+
"404": {
|
|
52199
|
+
description: "Not found error",
|
|
52200
|
+
schema: "any"
|
|
52201
|
+
}
|
|
52202
|
+
}
|
|
52203
|
+
},
|
|
52204
|
+
{
|
|
52205
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",
|
|
50320
52206
|
method: "POST",
|
|
50321
|
-
summary: "Create
|
|
52207
|
+
summary: "Bulk Create Group Configurations",
|
|
50322
52208
|
tags: [
|
|
50323
52209
|
"AlertGroups"
|
|
50324
52210
|
],
|
|
50325
52211
|
parameters: [
|
|
52212
|
+
{
|
|
52213
|
+
name: "alert_group_id",
|
|
52214
|
+
"in": "path",
|
|
52215
|
+
type: "integer",
|
|
52216
|
+
required: true,
|
|
52217
|
+
description: ""
|
|
52218
|
+
}
|
|
50326
52219
|
],
|
|
50327
52220
|
requestBody: {
|
|
50328
52221
|
contentType: "application/json",
|
|
@@ -50331,9 +52224,12 @@ var clientsData = [
|
|
|
50331
52224
|
},
|
|
50332
52225
|
responses: {
|
|
50333
52226
|
"200": {
|
|
50334
|
-
description: "
|
|
52227
|
+
description: "Configurations created (all-or-nothing — none created if any is invalid)",
|
|
50335
52228
|
schema: "any"
|
|
50336
52229
|
},
|
|
52230
|
+
"400": {
|
|
52231
|
+
description: "Validation error; no configurations were created"
|
|
52232
|
+
},
|
|
50337
52233
|
"401": {
|
|
50338
52234
|
description: "Authentication error",
|
|
50339
52235
|
schema: "any"
|
|
@@ -50349,9 +52245,49 @@ var clientsData = [
|
|
|
50349
52245
|
}
|
|
50350
52246
|
},
|
|
50351
52247
|
{
|
|
50352
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
52248
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",
|
|
52249
|
+
method: "DELETE",
|
|
52250
|
+
summary: "Bulk Delete Group Configurations",
|
|
52251
|
+
tags: [
|
|
52252
|
+
"AlertGroups"
|
|
52253
|
+
],
|
|
52254
|
+
parameters: [
|
|
52255
|
+
{
|
|
52256
|
+
name: "alert_group_id",
|
|
52257
|
+
"in": "path",
|
|
52258
|
+
type: "integer",
|
|
52259
|
+
required: true,
|
|
52260
|
+
description: ""
|
|
52261
|
+
}
|
|
52262
|
+
],
|
|
52263
|
+
requestBody: {
|
|
52264
|
+
contentType: "application/json",
|
|
52265
|
+
schema: "any",
|
|
52266
|
+
required: true
|
|
52267
|
+
},
|
|
52268
|
+
responses: {
|
|
52269
|
+
"200": {
|
|
52270
|
+
description: "Configurations removed",
|
|
52271
|
+
schema: "any"
|
|
52272
|
+
},
|
|
52273
|
+
"401": {
|
|
52274
|
+
description: "Authentication error",
|
|
52275
|
+
schema: "any"
|
|
52276
|
+
},
|
|
52277
|
+
"403": {
|
|
52278
|
+
description: "Authorization error",
|
|
52279
|
+
schema: "any"
|
|
52280
|
+
},
|
|
52281
|
+
"404": {
|
|
52282
|
+
description: "Not found error",
|
|
52283
|
+
schema: "any"
|
|
52284
|
+
}
|
|
52285
|
+
}
|
|
52286
|
+
},
|
|
52287
|
+
{
|
|
52288
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
50353
52289
|
method: "GET",
|
|
50354
|
-
summary: "List Group
|
|
52290
|
+
summary: "List Group Members",
|
|
50355
52291
|
tags: [
|
|
50356
52292
|
"AlertGroups"
|
|
50357
52293
|
],
|
|
@@ -50366,7 +52302,7 @@ var clientsData = [
|
|
|
50366
52302
|
],
|
|
50367
52303
|
responses: {
|
|
50368
52304
|
"200": {
|
|
50369
|
-
description: "List of group
|
|
52305
|
+
description: "List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",
|
|
50370
52306
|
schema: "any"
|
|
50371
52307
|
},
|
|
50372
52308
|
"401": {
|
|
@@ -50384,9 +52320,9 @@ var clientsData = [
|
|
|
50384
52320
|
}
|
|
50385
52321
|
},
|
|
50386
52322
|
{
|
|
50387
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
52323
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
50388
52324
|
method: "POST",
|
|
50389
|
-
summary: "Add
|
|
52325
|
+
summary: "Add Member to Group",
|
|
50390
52326
|
tags: [
|
|
50391
52327
|
"AlertGroups"
|
|
50392
52328
|
],
|
|
@@ -50406,7 +52342,7 @@ var clientsData = [
|
|
|
50406
52342
|
},
|
|
50407
52343
|
responses: {
|
|
50408
52344
|
"200": {
|
|
50409
|
-
description: "Added
|
|
52345
|
+
description: "Added member",
|
|
50410
52346
|
schema: "any"
|
|
50411
52347
|
},
|
|
50412
52348
|
"401": {
|
|
@@ -50424,9 +52360,9 @@ var clientsData = [
|
|
|
50424
52360
|
}
|
|
50425
52361
|
},
|
|
50426
52362
|
{
|
|
50427
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
52363
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",
|
|
50428
52364
|
method: "DELETE",
|
|
50429
|
-
summary: "Remove
|
|
52365
|
+
summary: "Remove Member from Group",
|
|
50430
52366
|
tags: [
|
|
50431
52367
|
"AlertGroups"
|
|
50432
52368
|
],
|
|
@@ -50465,9 +52401,9 @@ var clientsData = [
|
|
|
50465
52401
|
}
|
|
50466
52402
|
},
|
|
50467
52403
|
{
|
|
50468
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
50469
|
-
method: "
|
|
50470
|
-
summary: "
|
|
52404
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",
|
|
52405
|
+
method: "POST",
|
|
52406
|
+
summary: "Bulk Add Members to Group",
|
|
50471
52407
|
tags: [
|
|
50472
52408
|
"AlertGroups"
|
|
50473
52409
|
],
|
|
@@ -50480,11 +52416,19 @@ var clientsData = [
|
|
|
50480
52416
|
description: ""
|
|
50481
52417
|
}
|
|
50482
52418
|
],
|
|
52419
|
+
requestBody: {
|
|
52420
|
+
contentType: "application/json",
|
|
52421
|
+
schema: "any",
|
|
52422
|
+
required: true
|
|
52423
|
+
},
|
|
50483
52424
|
responses: {
|
|
50484
52425
|
"200": {
|
|
50485
|
-
description: "
|
|
52426
|
+
description: "Members added (idempotent — users already in the group are skipped)",
|
|
50486
52427
|
schema: "any"
|
|
50487
52428
|
},
|
|
52429
|
+
"400": {
|
|
52430
|
+
description: "Validation error; no members were added"
|
|
52431
|
+
},
|
|
50488
52432
|
"401": {
|
|
50489
52433
|
description: "Authentication error",
|
|
50490
52434
|
schema: "any"
|
|
@@ -50500,9 +52444,9 @@ var clientsData = [
|
|
|
50500
52444
|
}
|
|
50501
52445
|
},
|
|
50502
52446
|
{
|
|
50503
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
50504
|
-
method: "
|
|
50505
|
-
summary: "
|
|
52447
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",
|
|
52448
|
+
method: "DELETE",
|
|
52449
|
+
summary: "Bulk Remove Members from Group",
|
|
50506
52450
|
tags: [
|
|
50507
52451
|
"AlertGroups"
|
|
50508
52452
|
],
|
|
@@ -50522,7 +52466,7 @@ var clientsData = [
|
|
|
50522
52466
|
},
|
|
50523
52467
|
responses: {
|
|
50524
52468
|
"200": {
|
|
50525
|
-
description: "
|
|
52469
|
+
description: "Members removed",
|
|
50526
52470
|
schema: "any"
|
|
50527
52471
|
},
|
|
50528
52472
|
"401": {
|
|
@@ -50540,20 +52484,48 @@ var clientsData = [
|
|
|
50540
52484
|
}
|
|
50541
52485
|
},
|
|
50542
52486
|
{
|
|
50543
|
-
path: "/v2/alert_groups/{
|
|
50544
|
-
method: "
|
|
50545
|
-
summary: "
|
|
52487
|
+
path: "/v2/alert_groups/{id}",
|
|
52488
|
+
method: "GET",
|
|
52489
|
+
summary: "Get Alert Group",
|
|
50546
52490
|
tags: [
|
|
50547
52491
|
"AlertGroups"
|
|
50548
52492
|
],
|
|
50549
52493
|
parameters: [
|
|
50550
52494
|
{
|
|
50551
|
-
name: "
|
|
52495
|
+
name: "id",
|
|
50552
52496
|
"in": "path",
|
|
50553
52497
|
type: "integer",
|
|
50554
52498
|
required: true,
|
|
50555
52499
|
description: ""
|
|
52500
|
+
}
|
|
52501
|
+
],
|
|
52502
|
+
responses: {
|
|
52503
|
+
"200": {
|
|
52504
|
+
description: "Alert group details",
|
|
52505
|
+
schema: "any"
|
|
52506
|
+
},
|
|
52507
|
+
"401": {
|
|
52508
|
+
description: "Authentication error",
|
|
52509
|
+
schema: "any"
|
|
52510
|
+
},
|
|
52511
|
+
"403": {
|
|
52512
|
+
description: "Authorization error",
|
|
52513
|
+
schema: "any"
|
|
50556
52514
|
},
|
|
52515
|
+
"404": {
|
|
52516
|
+
description: "Not found error",
|
|
52517
|
+
schema: "any"
|
|
52518
|
+
}
|
|
52519
|
+
}
|
|
52520
|
+
},
|
|
52521
|
+
{
|
|
52522
|
+
path: "/v2/alert_groups/{id}",
|
|
52523
|
+
method: "PATCH",
|
|
52524
|
+
summary: "Update Alert Group",
|
|
52525
|
+
tags: [
|
|
52526
|
+
"AlertGroups"
|
|
52527
|
+
],
|
|
52528
|
+
parameters: [
|
|
50557
52529
|
{
|
|
50558
52530
|
name: "id",
|
|
50559
52531
|
"in": "path",
|
|
@@ -50569,7 +52541,7 @@ var clientsData = [
|
|
|
50569
52541
|
},
|
|
50570
52542
|
responses: {
|
|
50571
52543
|
"200": {
|
|
50572
|
-
description: "Updated
|
|
52544
|
+
description: "Updated alert group",
|
|
50573
52545
|
schema: "any"
|
|
50574
52546
|
},
|
|
50575
52547
|
"401": {
|
|
@@ -50587,20 +52559,13 @@ var clientsData = [
|
|
|
50587
52559
|
}
|
|
50588
52560
|
},
|
|
50589
52561
|
{
|
|
50590
|
-
path: "/v2/alert_groups/{
|
|
52562
|
+
path: "/v2/alert_groups/{id}",
|
|
50591
52563
|
method: "DELETE",
|
|
50592
|
-
summary: "Delete Group
|
|
52564
|
+
summary: "Delete Alert Group",
|
|
50593
52565
|
tags: [
|
|
50594
52566
|
"AlertGroups"
|
|
50595
52567
|
],
|
|
50596
52568
|
parameters: [
|
|
50597
|
-
{
|
|
50598
|
-
name: "alert_group_id",
|
|
50599
|
-
"in": "path",
|
|
50600
|
-
type: "integer",
|
|
50601
|
-
required: true,
|
|
50602
|
-
description: ""
|
|
50603
|
-
},
|
|
50604
52569
|
{
|
|
50605
52570
|
name: "id",
|
|
50606
52571
|
"in": "path",
|
|
@@ -50626,26 +52591,29 @@ var clientsData = [
|
|
|
50626
52591
|
schema: "any"
|
|
50627
52592
|
}
|
|
50628
52593
|
}
|
|
50629
|
-
}
|
|
52594
|
+
}
|
|
52595
|
+
],
|
|
52596
|
+
AlertRBAC: [
|
|
50630
52597
|
{
|
|
50631
|
-
path: "/v2/
|
|
52598
|
+
path: "/v2/alert_abilities",
|
|
50632
52599
|
method: "GET",
|
|
50633
|
-
summary: "List
|
|
52600
|
+
summary: "List Assignable Alert Abilities",
|
|
52601
|
+
description: "Static, platform-defined catalog of every assignable alert ability with its resource class and a localized display name. Identical for every company; readable by any authenticated user. Used by the matrix UI to render the assignment grid.",
|
|
50634
52602
|
tags: [
|
|
50635
|
-
"
|
|
52603
|
+
"AlertRBAC"
|
|
50636
52604
|
],
|
|
50637
52605
|
parameters: [
|
|
50638
52606
|
{
|
|
50639
|
-
name: "
|
|
50640
|
-
"in": "
|
|
50641
|
-
type: "
|
|
50642
|
-
required:
|
|
50643
|
-
description: ""
|
|
52607
|
+
name: "locale",
|
|
52608
|
+
"in": "query",
|
|
52609
|
+
type: "string",
|
|
52610
|
+
required: false,
|
|
52611
|
+
description: "Display-name language; unknown/unsupported locales fall back to English"
|
|
50644
52612
|
}
|
|
50645
52613
|
],
|
|
50646
52614
|
responses: {
|
|
50647
52615
|
"200": {
|
|
50648
|
-
description: "
|
|
52616
|
+
description: "Ability catalog",
|
|
50649
52617
|
schema: "any"
|
|
50650
52618
|
},
|
|
50651
52619
|
"401": {
|
|
@@ -50663,29 +52631,25 @@ var clientsData = [
|
|
|
50663
52631
|
}
|
|
50664
52632
|
},
|
|
50665
52633
|
{
|
|
50666
|
-
path: "/v2/
|
|
52634
|
+
path: "/v2/companies/{company_id}/alert_rbac/disable",
|
|
50667
52635
|
method: "POST",
|
|
50668
|
-
summary: "
|
|
52636
|
+
summary: "Disable Alert RBAC",
|
|
52637
|
+
description: "Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",
|
|
50669
52638
|
tags: [
|
|
50670
|
-
"
|
|
52639
|
+
"AlertRBAC"
|
|
50671
52640
|
],
|
|
50672
52641
|
parameters: [
|
|
50673
52642
|
{
|
|
50674
|
-
name: "
|
|
52643
|
+
name: "company_id",
|
|
50675
52644
|
"in": "path",
|
|
50676
52645
|
type: "integer",
|
|
50677
52646
|
required: true,
|
|
50678
|
-
description: ""
|
|
52647
|
+
description: "Company ID"
|
|
50679
52648
|
}
|
|
50680
52649
|
],
|
|
50681
|
-
requestBody: {
|
|
50682
|
-
contentType: "application/json",
|
|
50683
|
-
schema: "any",
|
|
50684
|
-
required: true
|
|
50685
|
-
},
|
|
50686
52650
|
responses: {
|
|
50687
52651
|
"200": {
|
|
50688
|
-
description: "
|
|
52652
|
+
description: "RBAC disabled",
|
|
50689
52653
|
schema: "any"
|
|
50690
52654
|
},
|
|
50691
52655
|
"401": {
|
|
@@ -50693,8 +52657,7 @@ var clientsData = [
|
|
|
50693
52657
|
schema: "any"
|
|
50694
52658
|
},
|
|
50695
52659
|
"403": {
|
|
50696
|
-
description: "
|
|
50697
|
-
schema: "any"
|
|
52660
|
+
description: "Caller is not a company admin"
|
|
50698
52661
|
},
|
|
50699
52662
|
"404": {
|
|
50700
52663
|
description: "Not found error",
|
|
@@ -50703,40 +52666,128 @@ var clientsData = [
|
|
|
50703
52666
|
}
|
|
50704
52667
|
},
|
|
50705
52668
|
{
|
|
50706
|
-
path: "/v2/
|
|
50707
|
-
method: "
|
|
50708
|
-
summary: "
|
|
52669
|
+
path: "/v2/companies/{company_id}/alert_rbac/enable",
|
|
52670
|
+
method: "POST",
|
|
52671
|
+
summary: "Enable Alert RBAC",
|
|
52672
|
+
description: "Turns on per-company alert RBAC enforcement. Rejected with 422 unless at least one alert role exists, so a company can never lock every alert action.",
|
|
50709
52673
|
tags: [
|
|
50710
|
-
"
|
|
52674
|
+
"AlertRBAC"
|
|
50711
52675
|
],
|
|
50712
52676
|
parameters: [
|
|
50713
52677
|
{
|
|
50714
|
-
name: "
|
|
52678
|
+
name: "company_id",
|
|
50715
52679
|
"in": "path",
|
|
50716
52680
|
type: "integer",
|
|
50717
52681
|
required: true,
|
|
50718
|
-
description: ""
|
|
52682
|
+
description: "Company ID"
|
|
52683
|
+
}
|
|
52684
|
+
],
|
|
52685
|
+
responses: {
|
|
52686
|
+
"200": {
|
|
52687
|
+
description: "RBAC enabled",
|
|
52688
|
+
schema: "any"
|
|
52689
|
+
},
|
|
52690
|
+
"401": {
|
|
52691
|
+
description: "Authentication error",
|
|
52692
|
+
schema: "any"
|
|
52693
|
+
},
|
|
52694
|
+
"403": {
|
|
52695
|
+
description: "Caller is not a company admin"
|
|
50719
52696
|
},
|
|
52697
|
+
"404": {
|
|
52698
|
+
description: "Not found error",
|
|
52699
|
+
schema: "any"
|
|
52700
|
+
},
|
|
52701
|
+
"422": {
|
|
52702
|
+
description: "No alert role exists yet"
|
|
52703
|
+
}
|
|
52704
|
+
}
|
|
52705
|
+
},
|
|
52706
|
+
{
|
|
52707
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
52708
|
+
method: "GET",
|
|
52709
|
+
summary: "List Alert Roles",
|
|
52710
|
+
description: "Company-defined alert roles. Gated by `update Company` (company admins only).",
|
|
52711
|
+
tags: [
|
|
52712
|
+
"AlertRBAC"
|
|
52713
|
+
],
|
|
52714
|
+
parameters: [
|
|
50720
52715
|
{
|
|
50721
|
-
name: "
|
|
52716
|
+
name: "company_id",
|
|
50722
52717
|
"in": "path",
|
|
50723
52718
|
type: "integer",
|
|
50724
52719
|
required: true,
|
|
50725
|
-
description: ""
|
|
52720
|
+
description: "Company ID"
|
|
52721
|
+
},
|
|
52722
|
+
{
|
|
52723
|
+
name: "page",
|
|
52724
|
+
"in": "query",
|
|
52725
|
+
type: "integer",
|
|
52726
|
+
required: false,
|
|
52727
|
+
description: "Page number"
|
|
52728
|
+
},
|
|
52729
|
+
{
|
|
52730
|
+
name: "per_page",
|
|
52731
|
+
"in": "query",
|
|
52732
|
+
type: "integer",
|
|
52733
|
+
required: false,
|
|
52734
|
+
description: "Items per page"
|
|
50726
52735
|
}
|
|
50727
52736
|
],
|
|
50728
52737
|
responses: {
|
|
50729
52738
|
"200": {
|
|
50730
|
-
description: "
|
|
52739
|
+
description: "List of alert roles",
|
|
52740
|
+
schema: "any"
|
|
50731
52741
|
},
|
|
50732
52742
|
"401": {
|
|
50733
52743
|
description: "Authentication error",
|
|
50734
52744
|
schema: "any"
|
|
50735
52745
|
},
|
|
50736
52746
|
"403": {
|
|
50737
|
-
description: "
|
|
52747
|
+
description: "Caller is not a company admin"
|
|
52748
|
+
},
|
|
52749
|
+
"404": {
|
|
52750
|
+
description: "Not found error",
|
|
52751
|
+
schema: "any"
|
|
52752
|
+
}
|
|
52753
|
+
}
|
|
52754
|
+
},
|
|
52755
|
+
{
|
|
52756
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
52757
|
+
method: "POST",
|
|
52758
|
+
summary: "Create Alert Role",
|
|
52759
|
+
tags: [
|
|
52760
|
+
"AlertRBAC"
|
|
52761
|
+
],
|
|
52762
|
+
parameters: [
|
|
52763
|
+
{
|
|
52764
|
+
name: "company_id",
|
|
52765
|
+
"in": "path",
|
|
52766
|
+
type: "integer",
|
|
52767
|
+
required: true,
|
|
52768
|
+
description: "Company ID"
|
|
52769
|
+
}
|
|
52770
|
+
],
|
|
52771
|
+
requestBody: {
|
|
52772
|
+
contentType: "application/json",
|
|
52773
|
+
schema: "any",
|
|
52774
|
+
required: true
|
|
52775
|
+
},
|
|
52776
|
+
responses: {
|
|
52777
|
+
"200": {
|
|
52778
|
+
description: "Created alert role",
|
|
52779
|
+
schema: "any"
|
|
52780
|
+
},
|
|
52781
|
+
"400": {
|
|
52782
|
+
description: "Validation error (e.g. blank or duplicate name)"
|
|
52783
|
+
},
|
|
52784
|
+
"401": {
|
|
52785
|
+
description: "Authentication error",
|
|
50738
52786
|
schema: "any"
|
|
50739
52787
|
},
|
|
52788
|
+
"403": {
|
|
52789
|
+
description: "Caller is not a company admin"
|
|
52790
|
+
},
|
|
50740
52791
|
"404": {
|
|
50741
52792
|
description: "Not found error",
|
|
50742
52793
|
schema: "any"
|
|
@@ -50744,24 +52795,31 @@ var clientsData = [
|
|
|
50744
52795
|
}
|
|
50745
52796
|
},
|
|
50746
52797
|
{
|
|
50747
|
-
path: "/v2/
|
|
52798
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
50748
52799
|
method: "GET",
|
|
50749
|
-
summary: "Get Alert
|
|
52800
|
+
summary: "Get Alert Role",
|
|
50750
52801
|
tags: [
|
|
50751
|
-
"
|
|
52802
|
+
"AlertRBAC"
|
|
50752
52803
|
],
|
|
50753
52804
|
parameters: [
|
|
52805
|
+
{
|
|
52806
|
+
name: "company_id",
|
|
52807
|
+
"in": "path",
|
|
52808
|
+
type: "integer",
|
|
52809
|
+
required: true,
|
|
52810
|
+
description: "Company ID"
|
|
52811
|
+
},
|
|
50754
52812
|
{
|
|
50755
52813
|
name: "id",
|
|
50756
52814
|
"in": "path",
|
|
50757
52815
|
type: "integer",
|
|
50758
52816
|
required: true,
|
|
50759
|
-
description: ""
|
|
52817
|
+
description: "Alert role ID"
|
|
50760
52818
|
}
|
|
50761
52819
|
],
|
|
50762
52820
|
responses: {
|
|
50763
52821
|
"200": {
|
|
50764
|
-
description: "Alert
|
|
52822
|
+
description: "Alert role details",
|
|
50765
52823
|
schema: "any"
|
|
50766
52824
|
},
|
|
50767
52825
|
"401": {
|
|
@@ -50769,29 +52827,34 @@ var clientsData = [
|
|
|
50769
52827
|
schema: "any"
|
|
50770
52828
|
},
|
|
50771
52829
|
"403": {
|
|
50772
|
-
description: "
|
|
50773
|
-
schema: "any"
|
|
52830
|
+
description: "Caller is not a company admin"
|
|
50774
52831
|
},
|
|
50775
52832
|
"404": {
|
|
50776
|
-
description: "
|
|
50777
|
-
schema: "any"
|
|
52833
|
+
description: "Role not found in this company"
|
|
50778
52834
|
}
|
|
50779
52835
|
}
|
|
50780
52836
|
},
|
|
50781
52837
|
{
|
|
50782
|
-
path: "/v2/
|
|
52838
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
50783
52839
|
method: "PATCH",
|
|
50784
|
-
summary: "Update Alert
|
|
52840
|
+
summary: "Update Alert Role",
|
|
50785
52841
|
tags: [
|
|
50786
|
-
"
|
|
52842
|
+
"AlertRBAC"
|
|
50787
52843
|
],
|
|
50788
52844
|
parameters: [
|
|
52845
|
+
{
|
|
52846
|
+
name: "company_id",
|
|
52847
|
+
"in": "path",
|
|
52848
|
+
type: "integer",
|
|
52849
|
+
required: true,
|
|
52850
|
+
description: "Company ID"
|
|
52851
|
+
},
|
|
50789
52852
|
{
|
|
50790
52853
|
name: "id",
|
|
50791
52854
|
"in": "path",
|
|
50792
52855
|
type: "integer",
|
|
50793
52856
|
required: true,
|
|
50794
|
-
description: ""
|
|
52857
|
+
description: "Alert role ID"
|
|
50795
52858
|
}
|
|
50796
52859
|
],
|
|
50797
52860
|
requestBody: {
|
|
@@ -50801,16 +52864,18 @@ var clientsData = [
|
|
|
50801
52864
|
},
|
|
50802
52865
|
responses: {
|
|
50803
52866
|
"200": {
|
|
50804
|
-
description: "Updated alert
|
|
52867
|
+
description: "Updated alert role",
|
|
50805
52868
|
schema: "any"
|
|
50806
52869
|
},
|
|
52870
|
+
"400": {
|
|
52871
|
+
description: "Validation error"
|
|
52872
|
+
},
|
|
50807
52873
|
"401": {
|
|
50808
52874
|
description: "Authentication error",
|
|
50809
52875
|
schema: "any"
|
|
50810
52876
|
},
|
|
50811
52877
|
"403": {
|
|
50812
|
-
description: "
|
|
50813
|
-
schema: "any"
|
|
52878
|
+
description: "Caller is not a company admin"
|
|
50814
52879
|
},
|
|
50815
52880
|
"404": {
|
|
50816
52881
|
description: "Not found error",
|
|
@@ -50819,19 +52884,27 @@ var clientsData = [
|
|
|
50819
52884
|
}
|
|
50820
52885
|
},
|
|
50821
52886
|
{
|
|
50822
|
-
path: "/v2/
|
|
52887
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
50823
52888
|
method: "DELETE",
|
|
50824
|
-
summary: "Delete Alert
|
|
52889
|
+
summary: "Delete Alert Role",
|
|
52890
|
+
description: "Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",
|
|
50825
52891
|
tags: [
|
|
50826
|
-
"
|
|
52892
|
+
"AlertRBAC"
|
|
50827
52893
|
],
|
|
50828
52894
|
parameters: [
|
|
52895
|
+
{
|
|
52896
|
+
name: "company_id",
|
|
52897
|
+
"in": "path",
|
|
52898
|
+
type: "integer",
|
|
52899
|
+
required: true,
|
|
52900
|
+
description: "Company ID"
|
|
52901
|
+
},
|
|
50829
52902
|
{
|
|
50830
52903
|
name: "id",
|
|
50831
52904
|
"in": "path",
|
|
50832
52905
|
type: "integer",
|
|
50833
52906
|
required: true,
|
|
50834
|
-
description: ""
|
|
52907
|
+
description: "Alert role ID"
|
|
50835
52908
|
}
|
|
50836
52909
|
],
|
|
50837
52910
|
responses: {
|
|
@@ -50843,9 +52916,58 @@ var clientsData = [
|
|
|
50843
52916
|
schema: "any"
|
|
50844
52917
|
},
|
|
50845
52918
|
"403": {
|
|
50846
|
-
description: "
|
|
52919
|
+
description: "Caller is not a company admin, or the role is still assigned to members"
|
|
52920
|
+
},
|
|
52921
|
+
"404": {
|
|
52922
|
+
description: "Not found error",
|
|
52923
|
+
schema: "any"
|
|
52924
|
+
}
|
|
52925
|
+
}
|
|
52926
|
+
},
|
|
52927
|
+
{
|
|
52928
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}/abilities",
|
|
52929
|
+
method: "PUT",
|
|
52930
|
+
summary: "Replace Alert Role Abilities",
|
|
52931
|
+
description: "Atomically replaces the full set of ability grants on the role. A single invalid entry rolls back the whole change and leaves the prior matrix intact. An explicit empty array clears every grant; a missing or malformed `abilities` key is rejected with 400.",
|
|
52932
|
+
tags: [
|
|
52933
|
+
"AlertRBAC"
|
|
52934
|
+
],
|
|
52935
|
+
parameters: [
|
|
52936
|
+
{
|
|
52937
|
+
name: "company_id",
|
|
52938
|
+
"in": "path",
|
|
52939
|
+
type: "integer",
|
|
52940
|
+
required: true,
|
|
52941
|
+
description: "Company ID"
|
|
52942
|
+
},
|
|
52943
|
+
{
|
|
52944
|
+
name: "id",
|
|
52945
|
+
"in": "path",
|
|
52946
|
+
type: "integer",
|
|
52947
|
+
required: true,
|
|
52948
|
+
description: "Alert role ID"
|
|
52949
|
+
}
|
|
52950
|
+
],
|
|
52951
|
+
requestBody: {
|
|
52952
|
+
contentType: "application/json",
|
|
52953
|
+
schema: "any",
|
|
52954
|
+
required: true
|
|
52955
|
+
},
|
|
52956
|
+
responses: {
|
|
52957
|
+
"200": {
|
|
52958
|
+
description: "Role with its updated abilities",
|
|
52959
|
+
schema: "any"
|
|
52960
|
+
},
|
|
52961
|
+
"400": {
|
|
52962
|
+
description: "Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"
|
|
52963
|
+
},
|
|
52964
|
+
"401": {
|
|
52965
|
+
description: "Authentication error",
|
|
50847
52966
|
schema: "any"
|
|
50848
52967
|
},
|
|
52968
|
+
"403": {
|
|
52969
|
+
description: "Caller is not a company admin"
|
|
52970
|
+
},
|
|
50849
52971
|
"404": {
|
|
50850
52972
|
description: "Not found error",
|
|
50851
52973
|
schema: "any"
|
|
@@ -50947,6 +53069,20 @@ var clientsData = [
|
|
|
50947
53069
|
required: false,
|
|
50948
53070
|
description: "Timestamp to end alert at"
|
|
50949
53071
|
},
|
|
53072
|
+
{
|
|
53073
|
+
name: "last_alert_start",
|
|
53074
|
+
"in": "query",
|
|
53075
|
+
type: "integer",
|
|
53076
|
+
required: false,
|
|
53077
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
53078
|
+
},
|
|
53079
|
+
{
|
|
53080
|
+
name: "last_alert_end",
|
|
53081
|
+
"in": "query",
|
|
53082
|
+
type: "integer",
|
|
53083
|
+
required: false,
|
|
53084
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
53085
|
+
},
|
|
50950
53086
|
{
|
|
50951
53087
|
name: "page",
|
|
50952
53088
|
"in": "query",
|
|
@@ -52019,6 +54155,20 @@ var clientsData = [
|
|
|
52019
54155
|
required: false,
|
|
52020
54156
|
description: "Timestamp to end alert at"
|
|
52021
54157
|
},
|
|
54158
|
+
{
|
|
54159
|
+
name: "last_alert_start",
|
|
54160
|
+
"in": "query",
|
|
54161
|
+
type: "integer",
|
|
54162
|
+
required: false,
|
|
54163
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
54164
|
+
},
|
|
54165
|
+
{
|
|
54166
|
+
name: "last_alert_end",
|
|
54167
|
+
"in": "query",
|
|
54168
|
+
type: "integer",
|
|
54169
|
+
required: false,
|
|
54170
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
54171
|
+
},
|
|
52022
54172
|
{
|
|
52023
54173
|
name: "page",
|
|
52024
54174
|
"in": "query",
|
|
@@ -52159,6 +54309,20 @@ var clientsData = [
|
|
|
52159
54309
|
required: false,
|
|
52160
54310
|
description: "Timestamp to end alert at"
|
|
52161
54311
|
},
|
|
54312
|
+
{
|
|
54313
|
+
name: "last_alert_start",
|
|
54314
|
+
"in": "query",
|
|
54315
|
+
type: "integer",
|
|
54316
|
+
required: false,
|
|
54317
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
54318
|
+
},
|
|
54319
|
+
{
|
|
54320
|
+
name: "last_alert_end",
|
|
54321
|
+
"in": "query",
|
|
54322
|
+
type: "integer",
|
|
54323
|
+
required: false,
|
|
54324
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
54325
|
+
},
|
|
52162
54326
|
{
|
|
52163
54327
|
name: "created_after",
|
|
52164
54328
|
"in": "query",
|
|
@@ -52334,12 +54498,19 @@ var clientsData = [
|
|
|
52334
54498
|
required: true,
|
|
52335
54499
|
description: "Alert ID"
|
|
52336
54500
|
},
|
|
54501
|
+
{
|
|
54502
|
+
name: "sort",
|
|
54503
|
+
"in": "query",
|
|
54504
|
+
type: "string",
|
|
54505
|
+
required: false,
|
|
54506
|
+
description: "Field to sort by: start_at (default) or severity"
|
|
54507
|
+
},
|
|
52337
54508
|
{
|
|
52338
54509
|
name: "order",
|
|
52339
54510
|
"in": "query",
|
|
52340
54511
|
type: "string",
|
|
52341
54512
|
required: false,
|
|
52342
|
-
description: "Sort
|
|
54513
|
+
description: "Sort direction: asc (default) or desc"
|
|
52343
54514
|
},
|
|
52344
54515
|
{
|
|
52345
54516
|
name: "page",
|
|
@@ -78512,6 +80683,178 @@ var clientsData = [
|
|
|
78512
80683
|
}
|
|
78513
80684
|
}
|
|
78514
80685
|
],
|
|
80686
|
+
"Well Plan Checklists": [
|
|
80687
|
+
{
|
|
80688
|
+
path: "/v2/well_plan_checklists",
|
|
80689
|
+
method: "GET",
|
|
80690
|
+
summary: "List well plan checklists",
|
|
80691
|
+
tags: [
|
|
80692
|
+
"Well Plan Checklists"
|
|
80693
|
+
],
|
|
80694
|
+
parameters: [
|
|
80695
|
+
{
|
|
80696
|
+
name: "company_id",
|
|
80697
|
+
"in": "query",
|
|
80698
|
+
type: "integer",
|
|
80699
|
+
required: false,
|
|
80700
|
+
description: "Filter by company ID"
|
|
80701
|
+
},
|
|
80702
|
+
{
|
|
80703
|
+
name: "per_page",
|
|
80704
|
+
"in": "query",
|
|
80705
|
+
type: "integer",
|
|
80706
|
+
required: false,
|
|
80707
|
+
description: "Number of items to list per page"
|
|
80708
|
+
},
|
|
80709
|
+
{
|
|
80710
|
+
name: "page",
|
|
80711
|
+
"in": "query",
|
|
80712
|
+
type: "integer",
|
|
80713
|
+
required: false,
|
|
80714
|
+
description: "Page number"
|
|
80715
|
+
}
|
|
80716
|
+
],
|
|
80717
|
+
responses: {
|
|
80718
|
+
"200": {
|
|
80719
|
+
description: "Successful response",
|
|
80720
|
+
schema: "any"
|
|
80721
|
+
},
|
|
80722
|
+
"401": {
|
|
80723
|
+
description: "Authentication error",
|
|
80724
|
+
schema: "any"
|
|
80725
|
+
},
|
|
80726
|
+
"403": {
|
|
80727
|
+
description: "Authorization error",
|
|
80728
|
+
schema: "any"
|
|
80729
|
+
},
|
|
80730
|
+
"404": {
|
|
80731
|
+
description: "Not found error",
|
|
80732
|
+
schema: "any"
|
|
80733
|
+
}
|
|
80734
|
+
}
|
|
80735
|
+
},
|
|
80736
|
+
{
|
|
80737
|
+
path: "/v2/well_plan_checklists/{id}",
|
|
80738
|
+
method: "GET",
|
|
80739
|
+
summary: "Show well plan checklist",
|
|
80740
|
+
tags: [
|
|
80741
|
+
"Well Plan Checklists"
|
|
80742
|
+
],
|
|
80743
|
+
parameters: [
|
|
80744
|
+
{
|
|
80745
|
+
name: "id",
|
|
80746
|
+
"in": "path",
|
|
80747
|
+
type: "integer",
|
|
80748
|
+
required: true,
|
|
80749
|
+
description: "Well Plan Checklist ID"
|
|
80750
|
+
}
|
|
80751
|
+
],
|
|
80752
|
+
responses: {
|
|
80753
|
+
"200": {
|
|
80754
|
+
description: "Successful response",
|
|
80755
|
+
schema: "any"
|
|
80756
|
+
},
|
|
80757
|
+
"401": {
|
|
80758
|
+
description: "Authentication error",
|
|
80759
|
+
schema: "any"
|
|
80760
|
+
},
|
|
80761
|
+
"403": {
|
|
80762
|
+
description: "Authorization error",
|
|
80763
|
+
schema: "any"
|
|
80764
|
+
},
|
|
80765
|
+
"404": {
|
|
80766
|
+
description: "Not found error",
|
|
80767
|
+
schema: "any"
|
|
80768
|
+
}
|
|
80769
|
+
}
|
|
80770
|
+
}
|
|
80771
|
+
],
|
|
80772
|
+
"Well Plan Tabs": [
|
|
80773
|
+
{
|
|
80774
|
+
path: "/v2/well_plan_tabs",
|
|
80775
|
+
method: "GET",
|
|
80776
|
+
summary: "List well plan tabs",
|
|
80777
|
+
tags: [
|
|
80778
|
+
"Well Plan Tabs"
|
|
80779
|
+
],
|
|
80780
|
+
parameters: [
|
|
80781
|
+
{
|
|
80782
|
+
name: "company_id",
|
|
80783
|
+
"in": "query",
|
|
80784
|
+
type: "integer",
|
|
80785
|
+
required: false,
|
|
80786
|
+
description: "Filter by company ID"
|
|
80787
|
+
},
|
|
80788
|
+
{
|
|
80789
|
+
name: "per_page",
|
|
80790
|
+
"in": "query",
|
|
80791
|
+
type: "integer",
|
|
80792
|
+
required: false,
|
|
80793
|
+
description: "Number of items to list per page"
|
|
80794
|
+
},
|
|
80795
|
+
{
|
|
80796
|
+
name: "page",
|
|
80797
|
+
"in": "query",
|
|
80798
|
+
type: "integer",
|
|
80799
|
+
required: false,
|
|
80800
|
+
description: "Page number"
|
|
80801
|
+
}
|
|
80802
|
+
],
|
|
80803
|
+
responses: {
|
|
80804
|
+
"200": {
|
|
80805
|
+
description: "Successful response",
|
|
80806
|
+
schema: "any"
|
|
80807
|
+
},
|
|
80808
|
+
"401": {
|
|
80809
|
+
description: "Authentication error",
|
|
80810
|
+
schema: "any"
|
|
80811
|
+
},
|
|
80812
|
+
"403": {
|
|
80813
|
+
description: "Authorization error",
|
|
80814
|
+
schema: "any"
|
|
80815
|
+
},
|
|
80816
|
+
"404": {
|
|
80817
|
+
description: "Not found error",
|
|
80818
|
+
schema: "any"
|
|
80819
|
+
}
|
|
80820
|
+
}
|
|
80821
|
+
},
|
|
80822
|
+
{
|
|
80823
|
+
path: "/v2/well_plan_tabs/{id}",
|
|
80824
|
+
method: "GET",
|
|
80825
|
+
summary: "Show well plan tab",
|
|
80826
|
+
tags: [
|
|
80827
|
+
"Well Plan Tabs"
|
|
80828
|
+
],
|
|
80829
|
+
parameters: [
|
|
80830
|
+
{
|
|
80831
|
+
name: "id",
|
|
80832
|
+
"in": "path",
|
|
80833
|
+
type: "integer",
|
|
80834
|
+
required: true,
|
|
80835
|
+
description: "Well Plan Tab ID"
|
|
80836
|
+
}
|
|
80837
|
+
],
|
|
80838
|
+
responses: {
|
|
80839
|
+
"200": {
|
|
80840
|
+
description: "Successful response",
|
|
80841
|
+
schema: "any"
|
|
80842
|
+
},
|
|
80843
|
+
"401": {
|
|
80844
|
+
description: "Authentication error",
|
|
80845
|
+
schema: "any"
|
|
80846
|
+
},
|
|
80847
|
+
"403": {
|
|
80848
|
+
description: "Authorization error",
|
|
80849
|
+
schema: "any"
|
|
80850
|
+
},
|
|
80851
|
+
"404": {
|
|
80852
|
+
description: "Not found error",
|
|
80853
|
+
schema: "any"
|
|
80854
|
+
}
|
|
80855
|
+
}
|
|
80856
|
+
}
|
|
80857
|
+
],
|
|
78515
80858
|
"Well Planning Dashboards": [
|
|
78516
80859
|
{
|
|
78517
80860
|
path: "/v2/well_planning_dashboards",
|
|
@@ -78631,19 +80974,230 @@ var clientsData = [
|
|
|
78631
80974
|
}
|
|
78632
80975
|
},
|
|
78633
80976
|
{
|
|
78634
|
-
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
80977
|
+
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
80978
|
+
method: "PATCH",
|
|
80979
|
+
summary: "Update a well planning dashboard",
|
|
80980
|
+
tags: [
|
|
80981
|
+
"Well Planning Dashboards"
|
|
80982
|
+
],
|
|
80983
|
+
parameters: [
|
|
80984
|
+
{
|
|
80985
|
+
name: "id_or_slug",
|
|
80986
|
+
"in": "path",
|
|
80987
|
+
type: "string",
|
|
80988
|
+
required: true,
|
|
80989
|
+
description: "Well Planning Dashboard ID or slug"
|
|
80990
|
+
}
|
|
80991
|
+
],
|
|
80992
|
+
requestBody: {
|
|
80993
|
+
contentType: "application/json",
|
|
80994
|
+
schema: "any",
|
|
80995
|
+
required: true
|
|
80996
|
+
},
|
|
80997
|
+
responses: {
|
|
80998
|
+
"200": {
|
|
80999
|
+
description: "Updated well planning dashboard",
|
|
81000
|
+
schema: "any"
|
|
81001
|
+
},
|
|
81002
|
+
"401": {
|
|
81003
|
+
description: "Authentication error",
|
|
81004
|
+
schema: "any"
|
|
81005
|
+
},
|
|
81006
|
+
"403": {
|
|
81007
|
+
description: "Authorization error",
|
|
81008
|
+
schema: "any"
|
|
81009
|
+
},
|
|
81010
|
+
"404": {
|
|
81011
|
+
description: "Not found error",
|
|
81012
|
+
schema: "any"
|
|
81013
|
+
}
|
|
81014
|
+
}
|
|
81015
|
+
},
|
|
81016
|
+
{
|
|
81017
|
+
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
81018
|
+
method: "DELETE",
|
|
81019
|
+
summary: "Delete a well planning dashboard",
|
|
81020
|
+
tags: [
|
|
81021
|
+
"Well Planning Dashboards"
|
|
81022
|
+
],
|
|
81023
|
+
parameters: [
|
|
81024
|
+
{
|
|
81025
|
+
name: "id_or_slug",
|
|
81026
|
+
"in": "path",
|
|
81027
|
+
type: "string",
|
|
81028
|
+
required: true,
|
|
81029
|
+
description: "Well Planning Dashboard ID or slug"
|
|
81030
|
+
}
|
|
81031
|
+
],
|
|
81032
|
+
responses: {
|
|
81033
|
+
"200": {
|
|
81034
|
+
description: "Well planning dashboard deleted",
|
|
81035
|
+
schema: "any"
|
|
81036
|
+
},
|
|
81037
|
+
"401": {
|
|
81038
|
+
description: "Authentication error",
|
|
81039
|
+
schema: "any"
|
|
81040
|
+
},
|
|
81041
|
+
"403": {
|
|
81042
|
+
description: "Authorization error",
|
|
81043
|
+
schema: "any"
|
|
81044
|
+
},
|
|
81045
|
+
"404": {
|
|
81046
|
+
description: "Not found error",
|
|
81047
|
+
schema: "any"
|
|
81048
|
+
}
|
|
81049
|
+
}
|
|
81050
|
+
},
|
|
81051
|
+
{
|
|
81052
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
81053
|
+
method: "POST",
|
|
81054
|
+
summary: "Create a dashboard app on a well planning dashboard",
|
|
81055
|
+
tags: [
|
|
81056
|
+
"Well Planning Dashboards"
|
|
81057
|
+
],
|
|
81058
|
+
parameters: [
|
|
81059
|
+
{
|
|
81060
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
81061
|
+
"in": "path",
|
|
81062
|
+
type: "string",
|
|
81063
|
+
required: true,
|
|
81064
|
+
description: "Well Planning Dashboard ID or slug"
|
|
81065
|
+
}
|
|
81066
|
+
],
|
|
81067
|
+
requestBody: {
|
|
81068
|
+
contentType: "application/json",
|
|
81069
|
+
schema: "any",
|
|
81070
|
+
required: true
|
|
81071
|
+
},
|
|
81072
|
+
responses: {
|
|
81073
|
+
"200": {
|
|
81074
|
+
description: "Created dashboard app",
|
|
81075
|
+
schema: "any"
|
|
81076
|
+
},
|
|
81077
|
+
"401": {
|
|
81078
|
+
description: "Authentication error",
|
|
81079
|
+
schema: "any"
|
|
81080
|
+
},
|
|
81081
|
+
"403": {
|
|
81082
|
+
description: "Authorization error",
|
|
81083
|
+
schema: "any"
|
|
81084
|
+
},
|
|
81085
|
+
"404": {
|
|
81086
|
+
description: "Not found error",
|
|
81087
|
+
schema: "any"
|
|
81088
|
+
}
|
|
81089
|
+
}
|
|
81090
|
+
},
|
|
81091
|
+
{
|
|
81092
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
81093
|
+
method: "PUT",
|
|
81094
|
+
summary: "Batch update dashboard apps on a well planning dashboard",
|
|
81095
|
+
tags: [
|
|
81096
|
+
"Well Planning Dashboards"
|
|
81097
|
+
],
|
|
81098
|
+
parameters: [
|
|
81099
|
+
{
|
|
81100
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
81101
|
+
"in": "path",
|
|
81102
|
+
type: "string",
|
|
81103
|
+
required: true,
|
|
81104
|
+
description: "Well Planning Dashboard ID or slug"
|
|
81105
|
+
}
|
|
81106
|
+
],
|
|
81107
|
+
requestBody: {
|
|
81108
|
+
contentType: "application/json",
|
|
81109
|
+
schema: "any",
|
|
81110
|
+
required: true
|
|
81111
|
+
},
|
|
81112
|
+
responses: {
|
|
81113
|
+
"200": {
|
|
81114
|
+
description: "Updated dashboard apps",
|
|
81115
|
+
schema: "any"
|
|
81116
|
+
},
|
|
81117
|
+
"401": {
|
|
81118
|
+
description: "Authentication error",
|
|
81119
|
+
schema: "any"
|
|
81120
|
+
},
|
|
81121
|
+
"403": {
|
|
81122
|
+
description: "Authorization error",
|
|
81123
|
+
schema: "any"
|
|
81124
|
+
},
|
|
81125
|
+
"404": {
|
|
81126
|
+
description: "Not found error",
|
|
81127
|
+
schema: "any"
|
|
81128
|
+
}
|
|
81129
|
+
}
|
|
81130
|
+
},
|
|
81131
|
+
{
|
|
81132
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
81133
|
+
method: "GET",
|
|
81134
|
+
summary: "Show dashboard app on a well planning dashboard",
|
|
81135
|
+
tags: [
|
|
81136
|
+
"Well Planning Dashboards"
|
|
81137
|
+
],
|
|
81138
|
+
parameters: [
|
|
81139
|
+
{
|
|
81140
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
81141
|
+
"in": "path",
|
|
81142
|
+
type: "string",
|
|
81143
|
+
required: true,
|
|
81144
|
+
description: "Well Planning Dashboard ID or slug"
|
|
81145
|
+
},
|
|
81146
|
+
{
|
|
81147
|
+
name: "id",
|
|
81148
|
+
"in": "path",
|
|
81149
|
+
type: "integer",
|
|
81150
|
+
required: true,
|
|
81151
|
+
description: "Dashboard App ID"
|
|
81152
|
+
},
|
|
81153
|
+
{
|
|
81154
|
+
name: "filter_asset_id",
|
|
81155
|
+
"in": "query",
|
|
81156
|
+
type: "integer",
|
|
81157
|
+
required: false,
|
|
81158
|
+
description: "Data filter's Asset ID"
|
|
81159
|
+
}
|
|
81160
|
+
],
|
|
81161
|
+
responses: {
|
|
81162
|
+
"200": {
|
|
81163
|
+
description: "Successful response",
|
|
81164
|
+
schema: "any"
|
|
81165
|
+
},
|
|
81166
|
+
"401": {
|
|
81167
|
+
description: "Authentication error",
|
|
81168
|
+
schema: "any"
|
|
81169
|
+
},
|
|
81170
|
+
"403": {
|
|
81171
|
+
description: "Authorization error",
|
|
81172
|
+
schema: "any"
|
|
81173
|
+
},
|
|
81174
|
+
"404": {
|
|
81175
|
+
description: "Not found error",
|
|
81176
|
+
schema: "any"
|
|
81177
|
+
}
|
|
81178
|
+
}
|
|
81179
|
+
},
|
|
81180
|
+
{
|
|
81181
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
78635
81182
|
method: "PATCH",
|
|
78636
|
-
summary: "Update a well planning dashboard",
|
|
81183
|
+
summary: "Update dashboard app on a well planning dashboard",
|
|
78637
81184
|
tags: [
|
|
78638
81185
|
"Well Planning Dashboards"
|
|
78639
81186
|
],
|
|
78640
81187
|
parameters: [
|
|
78641
81188
|
{
|
|
78642
|
-
name: "
|
|
81189
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
78643
81190
|
"in": "path",
|
|
78644
81191
|
type: "string",
|
|
78645
81192
|
required: true,
|
|
78646
81193
|
description: "Well Planning Dashboard ID or slug"
|
|
81194
|
+
},
|
|
81195
|
+
{
|
|
81196
|
+
name: "id",
|
|
81197
|
+
"in": "path",
|
|
81198
|
+
type: "integer",
|
|
81199
|
+
required: true,
|
|
81200
|
+
description: "Dashboard App ID"
|
|
78647
81201
|
}
|
|
78648
81202
|
],
|
|
78649
81203
|
requestBody: {
|
|
@@ -78653,7 +81207,7 @@ var clientsData = [
|
|
|
78653
81207
|
},
|
|
78654
81208
|
responses: {
|
|
78655
81209
|
"200": {
|
|
78656
|
-
description: "Updated
|
|
81210
|
+
description: "Updated dashboard app",
|
|
78657
81211
|
schema: "any"
|
|
78658
81212
|
},
|
|
78659
81213
|
"401": {
|
|
@@ -78671,25 +81225,31 @@ var clientsData = [
|
|
|
78671
81225
|
}
|
|
78672
81226
|
},
|
|
78673
81227
|
{
|
|
78674
|
-
path: "/v2/well_planning_dashboards/{
|
|
81228
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
78675
81229
|
method: "DELETE",
|
|
78676
|
-
summary: "Delete a well planning dashboard",
|
|
81230
|
+
summary: "Delete dashboard app from a well planning dashboard",
|
|
78677
81231
|
tags: [
|
|
78678
81232
|
"Well Planning Dashboards"
|
|
78679
81233
|
],
|
|
78680
81234
|
parameters: [
|
|
78681
81235
|
{
|
|
78682
|
-
name: "
|
|
81236
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
78683
81237
|
"in": "path",
|
|
78684
81238
|
type: "string",
|
|
78685
81239
|
required: true,
|
|
78686
81240
|
description: "Well Planning Dashboard ID or slug"
|
|
81241
|
+
},
|
|
81242
|
+
{
|
|
81243
|
+
name: "id",
|
|
81244
|
+
"in": "path",
|
|
81245
|
+
type: "integer",
|
|
81246
|
+
required: true,
|
|
81247
|
+
description: "Dashboard App ID"
|
|
78687
81248
|
}
|
|
78688
81249
|
],
|
|
78689
81250
|
responses: {
|
|
78690
81251
|
"200": {
|
|
78691
|
-
description: "
|
|
78692
|
-
schema: "any"
|
|
81252
|
+
description: "Dashboard app deleted"
|
|
78693
81253
|
},
|
|
78694
81254
|
"401": {
|
|
78695
81255
|
description: "Authentication error",
|
|
@@ -78706,9 +81266,9 @@ var clientsData = [
|
|
|
78706
81266
|
}
|
|
78707
81267
|
},
|
|
78708
81268
|
{
|
|
78709
|
-
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
81269
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/bulk_create",
|
|
78710
81270
|
method: "POST",
|
|
78711
|
-
summary: "
|
|
81271
|
+
summary: "Bulk create dashboard apps on a well planning dashboard",
|
|
78712
81272
|
tags: [
|
|
78713
81273
|
"Well Planning Dashboards"
|
|
78714
81274
|
],
|
|
@@ -78728,7 +81288,7 @@ var clientsData = [
|
|
|
78728
81288
|
},
|
|
78729
81289
|
responses: {
|
|
78730
81290
|
"200": {
|
|
78731
|
-
description: "Created dashboard
|
|
81291
|
+
description: "Created dashboard apps",
|
|
78732
81292
|
schema: "any"
|
|
78733
81293
|
},
|
|
78734
81294
|
"401": {
|
|
@@ -78744,23 +81304,88 @@ var clientsData = [
|
|
|
78744
81304
|
schema: "any"
|
|
78745
81305
|
}
|
|
78746
81306
|
}
|
|
78747
|
-
}
|
|
81307
|
+
}
|
|
81308
|
+
],
|
|
81309
|
+
"Well Plans": [
|
|
78748
81310
|
{
|
|
78749
|
-
path: "/v2/
|
|
78750
|
-
method: "
|
|
78751
|
-
summary: "
|
|
81311
|
+
path: "/v2/well_plans",
|
|
81312
|
+
method: "GET",
|
|
81313
|
+
summary: "List well plans",
|
|
78752
81314
|
tags: [
|
|
78753
|
-
"Well
|
|
81315
|
+
"Well Plans"
|
|
78754
81316
|
],
|
|
78755
81317
|
parameters: [
|
|
78756
81318
|
{
|
|
78757
|
-
name: "
|
|
78758
|
-
"in": "
|
|
81319
|
+
name: "company_id",
|
|
81320
|
+
"in": "query",
|
|
81321
|
+
type: "integer",
|
|
81322
|
+
required: false,
|
|
81323
|
+
description: "Filter by company ID"
|
|
81324
|
+
},
|
|
81325
|
+
{
|
|
81326
|
+
name: "well_id",
|
|
81327
|
+
"in": "query",
|
|
81328
|
+
type: "integer",
|
|
81329
|
+
required: false,
|
|
81330
|
+
description: "Filter by well ID"
|
|
81331
|
+
},
|
|
81332
|
+
{
|
|
81333
|
+
name: "source_well_id",
|
|
81334
|
+
"in": "query",
|
|
81335
|
+
type: "integer",
|
|
81336
|
+
required: false,
|
|
81337
|
+
description: "Filter by source well ID"
|
|
81338
|
+
},
|
|
81339
|
+
{
|
|
81340
|
+
name: "status",
|
|
81341
|
+
"in": "query",
|
|
78759
81342
|
type: "string",
|
|
78760
|
-
required:
|
|
78761
|
-
description: "
|
|
81343
|
+
required: false,
|
|
81344
|
+
description: "Filter by status"
|
|
81345
|
+
},
|
|
81346
|
+
{
|
|
81347
|
+
name: "per_page",
|
|
81348
|
+
"in": "query",
|
|
81349
|
+
type: "integer",
|
|
81350
|
+
required: false,
|
|
81351
|
+
description: "Number of items to list per page"
|
|
81352
|
+
},
|
|
81353
|
+
{
|
|
81354
|
+
name: "page",
|
|
81355
|
+
"in": "query",
|
|
81356
|
+
type: "integer",
|
|
81357
|
+
required: false,
|
|
81358
|
+
description: "Page number"
|
|
78762
81359
|
}
|
|
78763
81360
|
],
|
|
81361
|
+
responses: {
|
|
81362
|
+
"200": {
|
|
81363
|
+
description: "Successful response",
|
|
81364
|
+
schema: "any"
|
|
81365
|
+
},
|
|
81366
|
+
"401": {
|
|
81367
|
+
description: "Authentication error",
|
|
81368
|
+
schema: "any"
|
|
81369
|
+
},
|
|
81370
|
+
"403": {
|
|
81371
|
+
description: "Authorization error",
|
|
81372
|
+
schema: "any"
|
|
81373
|
+
},
|
|
81374
|
+
"404": {
|
|
81375
|
+
description: "Not found error",
|
|
81376
|
+
schema: "any"
|
|
81377
|
+
}
|
|
81378
|
+
}
|
|
81379
|
+
},
|
|
81380
|
+
{
|
|
81381
|
+
path: "/v2/well_plans",
|
|
81382
|
+
method: "POST",
|
|
81383
|
+
summary: "Create a well plan",
|
|
81384
|
+
tags: [
|
|
81385
|
+
"Well Plans"
|
|
81386
|
+
],
|
|
81387
|
+
parameters: [
|
|
81388
|
+
],
|
|
78764
81389
|
requestBody: {
|
|
78765
81390
|
contentType: "application/json",
|
|
78766
81391
|
schema: "any",
|
|
@@ -78768,7 +81393,7 @@ var clientsData = [
|
|
|
78768
81393
|
},
|
|
78769
81394
|
responses: {
|
|
78770
81395
|
"200": {
|
|
78771
|
-
description: "
|
|
81396
|
+
description: "Created well plan",
|
|
78772
81397
|
schema: "any"
|
|
78773
81398
|
},
|
|
78774
81399
|
"401": {
|
|
@@ -78786,33 +81411,19 @@ var clientsData = [
|
|
|
78786
81411
|
}
|
|
78787
81412
|
},
|
|
78788
81413
|
{
|
|
78789
|
-
path: "/v2/
|
|
81414
|
+
path: "/v2/well_plans/{id}",
|
|
78790
81415
|
method: "GET",
|
|
78791
|
-
summary: "Show
|
|
81416
|
+
summary: "Show well plan",
|
|
78792
81417
|
tags: [
|
|
78793
|
-
"Well
|
|
81418
|
+
"Well Plans"
|
|
78794
81419
|
],
|
|
78795
81420
|
parameters: [
|
|
78796
|
-
{
|
|
78797
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
78798
|
-
"in": "path",
|
|
78799
|
-
type: "string",
|
|
78800
|
-
required: true,
|
|
78801
|
-
description: "Well Planning Dashboard ID or slug"
|
|
78802
|
-
},
|
|
78803
81421
|
{
|
|
78804
81422
|
name: "id",
|
|
78805
81423
|
"in": "path",
|
|
78806
81424
|
type: "integer",
|
|
78807
81425
|
required: true,
|
|
78808
|
-
description: "
|
|
78809
|
-
},
|
|
78810
|
-
{
|
|
78811
|
-
name: "filter_asset_id",
|
|
78812
|
-
"in": "query",
|
|
78813
|
-
type: "integer",
|
|
78814
|
-
required: false,
|
|
78815
|
-
description: "Data filter's Asset ID"
|
|
81426
|
+
description: "Well Plan ID"
|
|
78816
81427
|
}
|
|
78817
81428
|
],
|
|
78818
81429
|
responses: {
|
|
@@ -78835,26 +81446,19 @@ var clientsData = [
|
|
|
78835
81446
|
}
|
|
78836
81447
|
},
|
|
78837
81448
|
{
|
|
78838
|
-
path: "/v2/
|
|
81449
|
+
path: "/v2/well_plans/{id}",
|
|
78839
81450
|
method: "PATCH",
|
|
78840
|
-
summary: "Update
|
|
81451
|
+
summary: "Update well plan",
|
|
78841
81452
|
tags: [
|
|
78842
|
-
"Well
|
|
81453
|
+
"Well Plans"
|
|
78843
81454
|
],
|
|
78844
81455
|
parameters: [
|
|
78845
|
-
{
|
|
78846
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
78847
|
-
"in": "path",
|
|
78848
|
-
type: "string",
|
|
78849
|
-
required: true,
|
|
78850
|
-
description: "Well Planning Dashboard ID or slug"
|
|
78851
|
-
},
|
|
78852
81456
|
{
|
|
78853
81457
|
name: "id",
|
|
78854
81458
|
"in": "path",
|
|
78855
81459
|
type: "integer",
|
|
78856
81460
|
required: true,
|
|
78857
|
-
description: "
|
|
81461
|
+
description: "Well Plan ID"
|
|
78858
81462
|
}
|
|
78859
81463
|
],
|
|
78860
81464
|
requestBody: {
|
|
@@ -78864,7 +81468,7 @@ var clientsData = [
|
|
|
78864
81468
|
},
|
|
78865
81469
|
responses: {
|
|
78866
81470
|
"200": {
|
|
78867
|
-
description: "Updated
|
|
81471
|
+
description: "Updated well plan",
|
|
78868
81472
|
schema: "any"
|
|
78869
81473
|
},
|
|
78870
81474
|
"401": {
|
|
@@ -78882,31 +81486,25 @@ var clientsData = [
|
|
|
78882
81486
|
}
|
|
78883
81487
|
},
|
|
78884
81488
|
{
|
|
78885
|
-
path: "/v2/
|
|
81489
|
+
path: "/v2/well_plans/{id}",
|
|
78886
81490
|
method: "DELETE",
|
|
78887
|
-
summary: "Delete
|
|
81491
|
+
summary: "Delete well plan",
|
|
78888
81492
|
tags: [
|
|
78889
|
-
"Well
|
|
81493
|
+
"Well Plans"
|
|
78890
81494
|
],
|
|
78891
81495
|
parameters: [
|
|
78892
|
-
{
|
|
78893
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
78894
|
-
"in": "path",
|
|
78895
|
-
type: "string",
|
|
78896
|
-
required: true,
|
|
78897
|
-
description: "Well Planning Dashboard ID or slug"
|
|
78898
|
-
},
|
|
78899
81496
|
{
|
|
78900
81497
|
name: "id",
|
|
78901
81498
|
"in": "path",
|
|
78902
81499
|
type: "integer",
|
|
78903
81500
|
required: true,
|
|
78904
|
-
description: "
|
|
81501
|
+
description: "Well Plan ID"
|
|
78905
81502
|
}
|
|
78906
81503
|
],
|
|
78907
81504
|
responses: {
|
|
78908
81505
|
"200": {
|
|
78909
|
-
description: "
|
|
81506
|
+
description: "Well plan deleted",
|
|
81507
|
+
schema: "any"
|
|
78910
81508
|
},
|
|
78911
81509
|
"401": {
|
|
78912
81510
|
description: "Authentication error",
|
|
@@ -78921,31 +81519,35 @@ var clientsData = [
|
|
|
78921
81519
|
schema: "any"
|
|
78922
81520
|
}
|
|
78923
81521
|
}
|
|
78924
|
-
}
|
|
81522
|
+
}
|
|
81523
|
+
],
|
|
81524
|
+
WellCache: [
|
|
78925
81525
|
{
|
|
78926
|
-
path: "/
|
|
78927
|
-
method: "
|
|
78928
|
-
summary: "
|
|
81526
|
+
path: "/v1/data/corva/well_cache",
|
|
81527
|
+
method: "GET",
|
|
81528
|
+
summary: "List WellCache Records",
|
|
78929
81529
|
tags: [
|
|
78930
|
-
"
|
|
81530
|
+
"WellCache"
|
|
78931
81531
|
],
|
|
78932
81532
|
parameters: [
|
|
78933
81533
|
{
|
|
78934
|
-
name: "
|
|
78935
|
-
"in": "
|
|
78936
|
-
type: "
|
|
78937
|
-
required:
|
|
78938
|
-
description: "
|
|
81534
|
+
name: "asset_id",
|
|
81535
|
+
"in": "query",
|
|
81536
|
+
type: "integer",
|
|
81537
|
+
required: false,
|
|
81538
|
+
description: "Search by Asset ID"
|
|
81539
|
+
},
|
|
81540
|
+
{
|
|
81541
|
+
name: "company_id",
|
|
81542
|
+
"in": "query",
|
|
81543
|
+
type: "integer",
|
|
81544
|
+
required: false,
|
|
81545
|
+
description: "Search by Company ID"
|
|
78939
81546
|
}
|
|
78940
81547
|
],
|
|
78941
|
-
requestBody: {
|
|
78942
|
-
contentType: "application/json",
|
|
78943
|
-
schema: "any",
|
|
78944
|
-
required: true
|
|
78945
|
-
},
|
|
78946
81548
|
responses: {
|
|
78947
81549
|
"200": {
|
|
78948
|
-
description: "
|
|
81550
|
+
description: "Successful response",
|
|
78949
81551
|
schema: "any"
|
|
78950
81552
|
},
|
|
78951
81553
|
"401": {
|
|
@@ -78963,33 +81565,103 @@ var clientsData = [
|
|
|
78963
81565
|
}
|
|
78964
81566
|
}
|
|
78965
81567
|
],
|
|
78966
|
-
|
|
81568
|
+
WellDrilloutUnitRuns: [
|
|
78967
81569
|
{
|
|
78968
|
-
path: "/
|
|
81570
|
+
path: "/v2/well_drillout_unit_runs",
|
|
78969
81571
|
method: "GET",
|
|
78970
|
-
summary: "List
|
|
81572
|
+
summary: "List well drillout unit runs",
|
|
78971
81573
|
tags: [
|
|
78972
|
-
"
|
|
81574
|
+
"WellDrilloutUnitRuns"
|
|
78973
81575
|
],
|
|
78974
81576
|
parameters: [
|
|
78975
81577
|
{
|
|
78976
|
-
name: "
|
|
81578
|
+
name: "company_id",
|
|
78977
81579
|
"in": "query",
|
|
78978
81580
|
type: "integer",
|
|
78979
81581
|
required: false,
|
|
78980
|
-
description: "
|
|
81582
|
+
description: "Filter by company ID"
|
|
78981
81583
|
},
|
|
78982
81584
|
{
|
|
78983
|
-
name: "
|
|
81585
|
+
name: "well_id",
|
|
78984
81586
|
"in": "query",
|
|
78985
81587
|
type: "integer",
|
|
78986
81588
|
required: false,
|
|
78987
|
-
description: "
|
|
81589
|
+
description: "Filter by well ID"
|
|
81590
|
+
},
|
|
81591
|
+
{
|
|
81592
|
+
name: "drillout_unit_id",
|
|
81593
|
+
"in": "query",
|
|
81594
|
+
type: "integer",
|
|
81595
|
+
required: false,
|
|
81596
|
+
description: "Filter by drillout unit ID"
|
|
81597
|
+
},
|
|
81598
|
+
{
|
|
81599
|
+
name: "fields",
|
|
81600
|
+
"in": "query",
|
|
81601
|
+
type: "any",
|
|
81602
|
+
required: false,
|
|
81603
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
81604
|
+
},
|
|
81605
|
+
{
|
|
81606
|
+
name: "per_page",
|
|
81607
|
+
"in": "query",
|
|
81608
|
+
type: "integer",
|
|
81609
|
+
required: false,
|
|
81610
|
+
description: "Number of well drillout unit runs per page"
|
|
81611
|
+
},
|
|
81612
|
+
{
|
|
81613
|
+
name: "page",
|
|
81614
|
+
"in": "query",
|
|
81615
|
+
type: "integer",
|
|
81616
|
+
required: false,
|
|
81617
|
+
description: "Page number"
|
|
78988
81618
|
}
|
|
78989
81619
|
],
|
|
78990
81620
|
responses: {
|
|
78991
81621
|
"200": {
|
|
78992
|
-
description: "
|
|
81622
|
+
description: "List well drillout unit runs",
|
|
81623
|
+
schema: "any"
|
|
81624
|
+
},
|
|
81625
|
+
"401": {
|
|
81626
|
+
description: "Authentication error",
|
|
81627
|
+
schema: "any"
|
|
81628
|
+
},
|
|
81629
|
+
"403": {
|
|
81630
|
+
description: "Authorization error",
|
|
81631
|
+
schema: "any"
|
|
81632
|
+
},
|
|
81633
|
+
"404": {
|
|
81634
|
+
description: "Not found error",
|
|
81635
|
+
schema: "any"
|
|
81636
|
+
}
|
|
81637
|
+
}
|
|
81638
|
+
},
|
|
81639
|
+
{
|
|
81640
|
+
path: "/v2/well_drillout_unit_runs/{id}",
|
|
81641
|
+
method: "GET",
|
|
81642
|
+
summary: "Get a single well drillout unit run",
|
|
81643
|
+
tags: [
|
|
81644
|
+
"WellDrilloutUnitRuns"
|
|
81645
|
+
],
|
|
81646
|
+
parameters: [
|
|
81647
|
+
{
|
|
81648
|
+
name: "id",
|
|
81649
|
+
"in": "path",
|
|
81650
|
+
type: "integer",
|
|
81651
|
+
required: true,
|
|
81652
|
+
description: "Well Drillout Unit Run ID"
|
|
81653
|
+
},
|
|
81654
|
+
{
|
|
81655
|
+
name: "fields",
|
|
81656
|
+
"in": "query",
|
|
81657
|
+
type: "any",
|
|
81658
|
+
required: false,
|
|
81659
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
81660
|
+
}
|
|
81661
|
+
],
|
|
81662
|
+
responses: {
|
|
81663
|
+
"200": {
|
|
81664
|
+
description: "Get well drillout unit run",
|
|
78993
81665
|
schema: "any"
|
|
78994
81666
|
},
|
|
78995
81667
|
"401": {
|
|
@@ -94828,11 +97500,22 @@ var entries = [
|
|
|
94828
97500
|
"enable",
|
|
94829
97501
|
"disable",
|
|
94830
97502
|
"alertdefinitions",
|
|
94831
|
-
"
|
|
97503
|
+
"subscribe",
|
|
97504
|
+
"unsubscribe",
|
|
94832
97505
|
"alert_groups",
|
|
97506
|
+
"alert_definitions",
|
|
97507
|
+
"alertgroups",
|
|
94833
97508
|
"alert_group_users",
|
|
94834
97509
|
"alert_group_assets",
|
|
94835
97510
|
"alert_group_configurations",
|
|
97511
|
+
"bulk_create",
|
|
97512
|
+
"bulk_destroy",
|
|
97513
|
+
"alertrbac",
|
|
97514
|
+
"alert_abilities",
|
|
97515
|
+
"companies",
|
|
97516
|
+
"alert_roles",
|
|
97517
|
+
"abilities",
|
|
97518
|
+
"alert_rbac",
|
|
94836
97519
|
"occurrences",
|
|
94837
97520
|
"acknowledge",
|
|
94838
97521
|
"classify",
|
|
@@ -94876,7 +97559,6 @@ var entries = [
|
|
|
94876
97559
|
"dashboards",
|
|
94877
97560
|
"users",
|
|
94878
97561
|
"dashboard_apps",
|
|
94879
|
-
"bulk_create",
|
|
94880
97562
|
"batch_update",
|
|
94881
97563
|
"dashboard_folders",
|
|
94882
97564
|
"dashboard_shares",
|
|
@@ -94885,6 +97567,12 @@ var entries = [
|
|
|
94885
97567
|
"clone",
|
|
94886
97568
|
"use_template",
|
|
94887
97569
|
"available_timezones",
|
|
97570
|
+
"well plan checklists",
|
|
97571
|
+
"well_plan_checklists",
|
|
97572
|
+
"well plans",
|
|
97573
|
+
"well_plans",
|
|
97574
|
+
"well plan tabs",
|
|
97575
|
+
"well_plan_tabs",
|
|
94888
97576
|
"well planning dashboards",
|
|
94889
97577
|
"well_planning_dashboards",
|
|
94890
97578
|
"data",
|
|
@@ -94920,9 +97608,7 @@ var entries = [
|
|
|
94920
97608
|
"count",
|
|
94921
97609
|
"unread",
|
|
94922
97610
|
"security_policies",
|
|
94923
|
-
"companies",
|
|
94924
97611
|
"permissions",
|
|
94925
|
-
"bulk_destroy",
|
|
94926
97612
|
"grouped",
|
|
94927
97613
|
"picklists",
|
|
94928
97614
|
"items",
|
|
@@ -95029,8 +97715,6 @@ var entries = [
|
|
|
95029
97715
|
"update_package",
|
|
95030
97716
|
"apperroralert",
|
|
95031
97717
|
"app_error_alerts",
|
|
95032
|
-
"subscribe",
|
|
95033
|
-
"unsubscribe",
|
|
95034
97718
|
"usage",
|
|
95035
97719
|
"summaries",
|
|
95036
97720
|
"workflows",
|
|
@@ -95112,6 +97796,8 @@ var entries = [
|
|
|
95112
97796
|
"test_connection",
|
|
95113
97797
|
"api_key_audits",
|
|
95114
97798
|
"typewells",
|
|
97799
|
+
"welldrilloutunitruns",
|
|
97800
|
+
"well_drillout_unit_runs",
|
|
95115
97801
|
"padfracfleets",
|
|
95116
97802
|
"pad_frac_fleets",
|
|
95117
97803
|
"fracfleetcontracts",
|
|
@@ -95138,7 +97824,7 @@ var entries = [
|
|
|
95138
97824
|
],
|
|
95139
97825
|
category: "clients",
|
|
95140
97826
|
importPath: "@corva/ui/clients",
|
|
95141
|
-
searchText: "corvaapi main api client for corva platform. provides methods for get, put, patch, post, delete requests. api http request fetch rest get post put delete patch abilitycheck v2 ability_check check_feature check_permission feed activities alerts v1 comments likes toggle definitions context trigger close check templates enable disable alertdefinitions
|
|
97827
|
+
searchText: "corvaapi main api client for corva platform. provides methods for get, put, patch, post, delete requests. api http request fetch rest get post put delete patch abilitycheck v2 ability_check check_feature check_permission feed activities alerts v1 comments likes toggle definitions context trigger close check templates enable disable alertdefinitions subscribe unsubscribe alert_groups alert_definitions alertgroups alert_group_users alert_group_assets alert_group_configurations bulk_create bulk_destroy alertrbac alert_abilities companies alert_roles abilities alert_rbac occurrences acknowledge classify transition escalate deescalate totals details alertworkflows alert_workflows appreviews app_reviews approve decline assets favorites settings type_wells type_well reruns ancestor_ids resolve autocomplete programs clusters pads frac_fleets app_wells wells active_wells rigs active_well well_cache drillout_units frac fleets wirelines dashboardappannotations dashboard_app_annotations last_annotations dashboards users dashboard_apps batch_update dashboard_folders dashboard_shares dashboard_folder_shares use clone use_template available_timezones well plan checklists well_plan_checklists well plans well_plans well plan tabs well_plan_tabs well planning dashboards well_planning_dashboards data data_filters data_filters#2 files file sign preview download download_link url security groups assign_users copy_users wellview integration ingest bha frac_stage_design frac_stage_summary frac_stage_summary_calculated job_settings plugs .well-known jwks.json jwks messageproducer message_producer notifications acknowledge_all count unread security_policies permissions grouped picklists items tasks user_token#1 user_token#2 user_token#3 user_token#4 sessions verification schemas export streaks identity_verifiers api_keys current deactivate apps install packages upload app_categories categories featured types secrets appdatasets app_datasets mark_followable app_help_contents signed_url applogs app_logs events search apptypes app_types appsettingstemplates app_settings_templates share unshare copy publish appstreamtemplate app_stream_templates appstreamtemplateapp add_app update_app remove_app datasettypes dataset_types datset_types documents document_sections rig_templates aggregated_values rig aggregated values rig_template_categories rig_template_items tiers productsubscriptions product_subscriptions cancel deny platformsubscriptions platform_subscriptions resume provisioningsubscriptions provisioning_subscriptions app_streams purchasesubscriptions purchase_subscriptions subscriptionfeatures subscription_features wellcache corva blacklisteddatasets blacklisted_datasets app metrics app_metrics for_selected_apps appassets packagereviews package_reviews apppurchases app_purchases datasets filtered_by_apps appruns app_runs stop duplicate_check appstream idle_worker_stats create_backfill_stream force_resume batch_destroy update_edr_provider_connection_status appconnection app_connections update_package apperroralert app_error_alerts usage summaries workflows workflow_content_blocks workflow_apps workflowroles workflow_roles columnmappertemplates column_mapper_templates add_asset remove_asset columnmappertemplatechannels column_mapper_template_channels columnmappertemplaterules column_mapper_template_rules dashboard_workflows ungroup ungroup_all change_asset competitoranalysis competitor_analysis statistics company app_companies appstoretemplates app_store_templates appstoretemplatesections app_store_template_sections app_store_template_section appstorearticles app_store_articles remove_section signedurl audits dataset_audits permission_audits group_membership_audits provisioning_subscription_audits platform_subscription_audits purchase_subscription_audits event audit appusage usage_analytics app_usage usage_list view_date_list top_apps top_users total_usage_trend partialwellreruns partial_reruns list start_merging fail restart app_progress partialwellrerunappprogresses app_progresses searchsuggestions search_suggestions goals projects projectfolders project_folders projectfiles project_files registeredmodels registered_models appschedule app_schedules bulk_update_status package_audits apikey api_keys_management activate edrproviders edr_providers test_connection api_key_audits typewells welldrilloutunitruns well_drillout_unit_runs padfracfleets pad_frac_fleets fracfleetcontracts frac_fleet_contracts interventionunits intervention_units interventionunitevents intervention_unit_events data export app data_export_app column_fields column_fields_list flat activity_code_mappings metrics_definitions countries country_list revoltchat revolt_chat_sessions interventionunitreruns intervention_unit_reruns"
|
|
95142
97828
|
},
|
|
95143
97829
|
{
|
|
95144
97830
|
id: "client-corvaDataAPI",
|