@corva/ui 3.67.0-6 → 3.67.0-8
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/cjs-bundle/components/Casing/CasingTableV2/components/SortableComponent.js +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/SortableComponent.js.map +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/SortableComponents.js +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/SortableComponents.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/SortableComponent.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/SortableComponent.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/SortableComponents.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/SortableComponents.js.map +1 -1
- package/cjs-bundle/components/NewDocumentViewer/components/CsvViewer.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Table/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Table/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/Filter/components/VirtualizedListBox/VirtualizedListBox.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/Filter/components/VirtualizedListBox/VirtualizedListBox.module.css.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellPickerV5WithStore/components/CompanySafeguardWrapper/CompanySafeguardWrapper.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellsTable/components/MetricsHeaderCells/MetricsHeaderCells.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellsTable/components/OffsetWellsTableHead/OffsetWellsTableHead.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellsTable/components/SortableHeaderCell/SortableHeaderCell.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellsTable/components/WellNameHeaderCell/WellNameHeaderCell.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/constants.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/hooks/useSortedWells.js +1 -1
- package/cjs-bundle/components/VirtualizedTable/DraggableList.js +1 -1
- package/cjs-bundle/components/VirtualizedTable/DraggableList.js.map +1 -1
- package/cjs-bundle/components/VirtualizedTable/VirtualizedTable.js +1 -1
- package/cjs-bundle/components/VirtualizedTable/index.js +1 -1
- package/components/Casing/CasingTableV2/components/SortableComponent.d.ts +31 -1
- package/components/Casing/CasingTableV2/components/SortableComponent.d.ts.map +1 -1
- package/components/Casing/CasingTableV2/components/SortableComponent.js +1 -1
- package/components/Casing/CasingTableV2/components/SortableComponent.js.map +1 -1
- package/components/Casing/CasingTableV2/components/SortableComponents.d.ts +28 -1
- package/components/Casing/CasingTableV2/components/SortableComponents.js +1 -1
- package/components/Casing/CasingTableV2/components/SortableComponents.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponent.d.ts +36 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponent.d.ts.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponent.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponent.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponents.d.ts +32 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponents.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/SortableComponents.js.map +1 -1
- package/components/NewDocumentViewer/components/CsvViewer.d.ts.map +1 -1
- package/components/NewDocumentViewer/components/CsvViewer.js +1 -1
- package/components/OffsetWellPickerV2/components/Table/index.d.ts +81 -1
- package/components/OffsetWellPickerV2/components/Table/index.d.ts.map +1 -1
- package/components/OffsetWellPickerV2/components/Table/index.js +1 -1
- package/components/OffsetWellPickerV2/components/Table/index.js.map +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/index.d.ts.map +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/index.js +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/index.js.map +1 -1
- package/components/OffsetWellPickerV4/constants.d.ts +4 -0
- package/components/OffsetWellPickerV4/effects/useSortedWells.d.ts +1 -1
- package/components/OffsetWellPickerV4/effects/useSortedWells.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/Filter/components/VirtualizedListBox/VirtualizedListBox.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/Filter/components/VirtualizedListBox/VirtualizedListBox.js +1 -1
- package/components/OffsetWellPickerV5/components/Filter/components/VirtualizedListBox/VirtualizedListBox.module.css.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.types.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.types.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellPickerV5WithStore/components/CompanySafeguardWrapper/CompanySafeguardWrapper.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/MetricsHeaderCells/MetricsHeaderCells.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/MetricsHeaderCells/MetricsHeaderCells.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/MetricsHeaderCells/MetricsHeaderCells.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/OffsetWellsTableHead/OffsetWellsTableHead.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/OffsetWellsTableHead/OffsetWellsTableHead.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/OffsetWellsTableHead/OffsetWellsTableHead.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/SortableHeaderCell/SortableHeaderCell.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/SortableHeaderCell/SortableHeaderCell.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/SortableHeaderCell/SortableHeaderCell.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/WellNameHeaderCell/WellNameHeaderCell.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/WellNameHeaderCell/WellNameHeaderCell.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellsTable/components/WellNameHeaderCell/WellNameHeaderCell.js +1 -1
- package/components/OffsetWellPickerV5/components/TableSection/TableSection.d.ts +1 -1
- package/components/OffsetWellPickerV5/components/TableSection/TableSection.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/constants.d.ts +6 -0
- package/components/OffsetWellPickerV5/constants.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/constants.js +1 -1
- package/components/OffsetWellPickerV5/hooks/useSortedWells.d.ts +1 -1
- package/components/OffsetWellPickerV5/hooks/useSortedWells.d.ts.map +1 -1
- package/components/OffsetWellPickerV5/hooks/useSortedWells.js +1 -1
- package/components/VirtualizedTable/DraggableList.d.ts.map +1 -1
- package/components/VirtualizedTable/DraggableList.js +1 -1
- package/components/VirtualizedTable/DraggableList.js.map +1 -1
- package/components/VirtualizedTable/VirtualizedTable.d.ts.map +1 -1
- package/components/VirtualizedTable/VirtualizedTable.js +1 -1
- package/components/VirtualizedTable/index.d.ts +4 -2
- package/components/VirtualizedTable/index.d.ts.map +1 -1
- package/components/VirtualizedTable/index.js +1 -1
- package/mcp-server/server.mjs +3273 -583
- package/package.json +7 -3
- package/tsconfig.tsbuildinfo +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.67.0-
|
|
234
|
+
var version = "3.67.0-8";
|
|
235
235
|
|
|
236
236
|
const CORVA_UI_VERSION = version;
|
|
237
237
|
|
|
@@ -16167,7 +16167,7 @@ var componentsV1Data = [
|
|
|
16167
16167
|
modulePath: "components/VirtualizedTable",
|
|
16168
16168
|
importPath: "@corva/ui/components",
|
|
16169
16169
|
category: "v1",
|
|
16170
|
-
description: "",
|
|
16170
|
+
description: "Virtualized table.",
|
|
16171
16171
|
isExperimental: false,
|
|
16172
16172
|
isDeprecated: false,
|
|
16173
16173
|
props: [
|
|
@@ -16181,7 +16181,9 @@ var componentsV1Data = [
|
|
|
16181
16181
|
],
|
|
16182
16182
|
sourceUrl: "https://github.com/corva-ai/corva-ui/blob/develop/src/components/VirtualizedTable/index.tsx",
|
|
16183
16183
|
keywords: [
|
|
16184
|
-
"virtualizedtable"
|
|
16184
|
+
"virtualizedtable",
|
|
16185
|
+
"virtualized",
|
|
16186
|
+
"table."
|
|
16185
16187
|
]
|
|
16186
16188
|
},
|
|
16187
16189
|
{
|
|
@@ -18468,11 +18470,22 @@ var clientsData = [
|
|
|
18468
18470
|
"enable",
|
|
18469
18471
|
"disable",
|
|
18470
18472
|
"alertdefinitions",
|
|
18471
|
-
"
|
|
18473
|
+
"subscribe",
|
|
18474
|
+
"unsubscribe",
|
|
18472
18475
|
"alert_groups",
|
|
18476
|
+
"alert_definitions",
|
|
18477
|
+
"alertgroups",
|
|
18473
18478
|
"alert_group_users",
|
|
18474
18479
|
"alert_group_assets",
|
|
18475
18480
|
"alert_group_configurations",
|
|
18481
|
+
"bulk_create",
|
|
18482
|
+
"bulk_destroy",
|
|
18483
|
+
"alertrbac",
|
|
18484
|
+
"alert_abilities",
|
|
18485
|
+
"companies",
|
|
18486
|
+
"alert_roles",
|
|
18487
|
+
"abilities",
|
|
18488
|
+
"alert_rbac",
|
|
18476
18489
|
"occurrences",
|
|
18477
18490
|
"acknowledge",
|
|
18478
18491
|
"classify",
|
|
@@ -18516,7 +18529,6 @@ var clientsData = [
|
|
|
18516
18529
|
"dashboards",
|
|
18517
18530
|
"users",
|
|
18518
18531
|
"dashboard_apps",
|
|
18519
|
-
"bulk_create",
|
|
18520
18532
|
"batch_update",
|
|
18521
18533
|
"dashboard_folders",
|
|
18522
18534
|
"dashboard_shares",
|
|
@@ -18525,6 +18537,12 @@ var clientsData = [
|
|
|
18525
18537
|
"clone",
|
|
18526
18538
|
"use_template",
|
|
18527
18539
|
"available_timezones",
|
|
18540
|
+
"well plan checklists",
|
|
18541
|
+
"well_plan_checklists",
|
|
18542
|
+
"well plans",
|
|
18543
|
+
"well_plans",
|
|
18544
|
+
"well plan tabs",
|
|
18545
|
+
"well_plan_tabs",
|
|
18528
18546
|
"well planning dashboards",
|
|
18529
18547
|
"well_planning_dashboards",
|
|
18530
18548
|
"data",
|
|
@@ -18560,9 +18578,7 @@ var clientsData = [
|
|
|
18560
18578
|
"count",
|
|
18561
18579
|
"unread",
|
|
18562
18580
|
"security_policies",
|
|
18563
|
-
"companies",
|
|
18564
18581
|
"permissions",
|
|
18565
|
-
"bulk_destroy",
|
|
18566
18582
|
"grouped",
|
|
18567
18583
|
"picklists",
|
|
18568
18584
|
"items",
|
|
@@ -18669,8 +18685,6 @@ var clientsData = [
|
|
|
18669
18685
|
"update_package",
|
|
18670
18686
|
"apperroralert",
|
|
18671
18687
|
"app_error_alerts",
|
|
18672
|
-
"subscribe",
|
|
18673
|
-
"unsubscribe",
|
|
18674
18688
|
"usage",
|
|
18675
18689
|
"summaries",
|
|
18676
18690
|
"workflows",
|
|
@@ -18752,6 +18766,8 @@ var clientsData = [
|
|
|
18752
18766
|
"test_connection",
|
|
18753
18767
|
"api_key_audits",
|
|
18754
18768
|
"typewells",
|
|
18769
|
+
"welldrilloutunitruns",
|
|
18770
|
+
"well_drillout_unit_runs",
|
|
18755
18771
|
"padfracfleets",
|
|
18756
18772
|
"pad_frac_fleets",
|
|
18757
18773
|
"fracfleetcontracts",
|
|
@@ -19861,6 +19877,13 @@ var clientsData = [
|
|
|
19861
19877
|
required: false,
|
|
19862
19878
|
description: "Filter by type (personal/company)"
|
|
19863
19879
|
},
|
|
19880
|
+
{
|
|
19881
|
+
name: "alert_group_id",
|
|
19882
|
+
"in": "query",
|
|
19883
|
+
type: "string",
|
|
19884
|
+
required: false,
|
|
19885
|
+
description: "Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"
|
|
19886
|
+
},
|
|
19864
19887
|
{
|
|
19865
19888
|
name: "search",
|
|
19866
19889
|
"in": "query",
|
|
@@ -19868,6 +19891,13 @@ var clientsData = [
|
|
|
19868
19891
|
required: false,
|
|
19869
19892
|
description: "Search by name"
|
|
19870
19893
|
},
|
|
19894
|
+
{
|
|
19895
|
+
name: "segment",
|
|
19896
|
+
"in": "query",
|
|
19897
|
+
type: "string",
|
|
19898
|
+
required: false,
|
|
19899
|
+
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."
|
|
19900
|
+
},
|
|
19871
19901
|
{
|
|
19872
19902
|
name: "page",
|
|
19873
19903
|
"in": "query",
|
|
@@ -20045,39 +20075,29 @@ var clientsData = [
|
|
|
20045
20075
|
}
|
|
20046
20076
|
},
|
|
20047
20077
|
{
|
|
20048
|
-
path: "/v2/
|
|
20049
|
-
method: "
|
|
20050
|
-
summary: "
|
|
20078
|
+
path: "/v2/alerts/definitions/{id}/subscribe",
|
|
20079
|
+
method: "POST",
|
|
20080
|
+
summary: "Subscribe to Alert Definition",
|
|
20051
20081
|
tags: [
|
|
20052
|
-
"
|
|
20082
|
+
"AlertDefinitions"
|
|
20053
20083
|
],
|
|
20054
20084
|
parameters: [
|
|
20055
20085
|
{
|
|
20056
|
-
name: "
|
|
20057
|
-
"in": "
|
|
20058
|
-
type: "string",
|
|
20059
|
-
required: false,
|
|
20060
|
-
description: "Search by name"
|
|
20061
|
-
},
|
|
20062
|
-
{
|
|
20063
|
-
name: "page",
|
|
20064
|
-
"in": "query",
|
|
20065
|
-
type: "integer",
|
|
20066
|
-
required: false,
|
|
20067
|
-
description: "Page number"
|
|
20068
|
-
},
|
|
20069
|
-
{
|
|
20070
|
-
name: "per_page",
|
|
20071
|
-
"in": "query",
|
|
20086
|
+
name: "id",
|
|
20087
|
+
"in": "path",
|
|
20072
20088
|
type: "integer",
|
|
20073
|
-
required:
|
|
20074
|
-
description: "
|
|
20089
|
+
required: true,
|
|
20090
|
+
description: ""
|
|
20075
20091
|
}
|
|
20076
20092
|
],
|
|
20093
|
+
requestBody: {
|
|
20094
|
+
contentType: "application/json",
|
|
20095
|
+
schema: "any",
|
|
20096
|
+
required: false
|
|
20097
|
+
},
|
|
20077
20098
|
responses: {
|
|
20078
20099
|
"200": {
|
|
20079
|
-
description: "
|
|
20080
|
-
schema: "any"
|
|
20100
|
+
description: "Subscription created; activates an inactive definition"
|
|
20081
20101
|
},
|
|
20082
20102
|
"401": {
|
|
20083
20103
|
description: "Authentication error",
|
|
@@ -20090,27 +20110,31 @@ var clientsData = [
|
|
|
20090
20110
|
"404": {
|
|
20091
20111
|
description: "Not found error",
|
|
20092
20112
|
schema: "any"
|
|
20113
|
+
},
|
|
20114
|
+
"409": {
|
|
20115
|
+
description: "Subscription already exists"
|
|
20093
20116
|
}
|
|
20094
20117
|
}
|
|
20095
20118
|
},
|
|
20096
20119
|
{
|
|
20097
|
-
path: "/v2/
|
|
20120
|
+
path: "/v2/alerts/definitions/{id}/unsubscribe",
|
|
20098
20121
|
method: "POST",
|
|
20099
|
-
summary: "
|
|
20122
|
+
summary: "Unsubscribe from Alert Definition",
|
|
20100
20123
|
tags: [
|
|
20101
|
-
"
|
|
20124
|
+
"AlertDefinitions"
|
|
20102
20125
|
],
|
|
20103
20126
|
parameters: [
|
|
20127
|
+
{
|
|
20128
|
+
name: "id",
|
|
20129
|
+
"in": "path",
|
|
20130
|
+
type: "integer",
|
|
20131
|
+
required: true,
|
|
20132
|
+
description: ""
|
|
20133
|
+
}
|
|
20104
20134
|
],
|
|
20105
|
-
requestBody: {
|
|
20106
|
-
contentType: "application/json",
|
|
20107
|
-
schema: "any",
|
|
20108
|
-
required: true
|
|
20109
|
-
},
|
|
20110
20135
|
responses: {
|
|
20111
20136
|
"200": {
|
|
20112
|
-
description: "
|
|
20113
|
-
schema: "any"
|
|
20137
|
+
description: "Unsubscribed; deactivates a personal definition left without subscriptions"
|
|
20114
20138
|
},
|
|
20115
20139
|
"401": {
|
|
20116
20140
|
description: "Authentication error",
|
|
@@ -20127,24 +20151,52 @@ var clientsData = [
|
|
|
20127
20151
|
}
|
|
20128
20152
|
},
|
|
20129
20153
|
{
|
|
20130
|
-
path: "/v2/alert_groups/{
|
|
20154
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_definitions",
|
|
20131
20155
|
method: "GET",
|
|
20132
|
-
summary: "
|
|
20156
|
+
summary: "List an Alert Group's Definitions",
|
|
20133
20157
|
tags: [
|
|
20134
|
-
"
|
|
20158
|
+
"AlertDefinitions"
|
|
20135
20159
|
],
|
|
20136
20160
|
parameters: [
|
|
20137
20161
|
{
|
|
20138
|
-
name: "
|
|
20162
|
+
name: "alert_group_id",
|
|
20139
20163
|
"in": "path",
|
|
20140
20164
|
type: "integer",
|
|
20141
20165
|
required: true,
|
|
20142
|
-
description: ""
|
|
20166
|
+
description: "Alert group ID"
|
|
20167
|
+
},
|
|
20168
|
+
{
|
|
20169
|
+
name: "type",
|
|
20170
|
+
"in": "query",
|
|
20171
|
+
type: "string",
|
|
20172
|
+
required: false,
|
|
20173
|
+
description: "Filter by type (personal/company)"
|
|
20174
|
+
},
|
|
20175
|
+
{
|
|
20176
|
+
name: "search",
|
|
20177
|
+
"in": "query",
|
|
20178
|
+
type: "string",
|
|
20179
|
+
required: false,
|
|
20180
|
+
description: "Search by name"
|
|
20181
|
+
},
|
|
20182
|
+
{
|
|
20183
|
+
name: "page",
|
|
20184
|
+
"in": "query",
|
|
20185
|
+
type: "integer",
|
|
20186
|
+
required: false,
|
|
20187
|
+
description: "Page number"
|
|
20188
|
+
},
|
|
20189
|
+
{
|
|
20190
|
+
name: "per_page",
|
|
20191
|
+
"in": "query",
|
|
20192
|
+
type: "integer",
|
|
20193
|
+
required: false,
|
|
20194
|
+
description: "Items per page"
|
|
20143
20195
|
}
|
|
20144
20196
|
],
|
|
20145
20197
|
responses: {
|
|
20146
20198
|
"200": {
|
|
20147
|
-
description: "
|
|
20199
|
+
description: "The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",
|
|
20148
20200
|
schema: "any"
|
|
20149
20201
|
},
|
|
20150
20202
|
"401": {
|
|
@@ -20162,29 +20214,38 @@ var clientsData = [
|
|
|
20162
20214
|
}
|
|
20163
20215
|
},
|
|
20164
20216
|
{
|
|
20165
|
-
path: "/v2/alert_groups
|
|
20166
|
-
method: "
|
|
20167
|
-
summary: "
|
|
20217
|
+
path: "/v2/alert_groups",
|
|
20218
|
+
method: "GET",
|
|
20219
|
+
summary: "List Alert Groups",
|
|
20168
20220
|
tags: [
|
|
20169
20221
|
"AlertGroups"
|
|
20170
20222
|
],
|
|
20171
20223
|
parameters: [
|
|
20172
20224
|
{
|
|
20173
|
-
name: "
|
|
20174
|
-
"in": "
|
|
20225
|
+
name: "search",
|
|
20226
|
+
"in": "query",
|
|
20227
|
+
type: "string",
|
|
20228
|
+
required: false,
|
|
20229
|
+
description: "Search by name"
|
|
20230
|
+
},
|
|
20231
|
+
{
|
|
20232
|
+
name: "page",
|
|
20233
|
+
"in": "query",
|
|
20175
20234
|
type: "integer",
|
|
20176
|
-
required:
|
|
20177
|
-
description: ""
|
|
20235
|
+
required: false,
|
|
20236
|
+
description: "Page number"
|
|
20237
|
+
},
|
|
20238
|
+
{
|
|
20239
|
+
name: "per_page",
|
|
20240
|
+
"in": "query",
|
|
20241
|
+
type: "integer",
|
|
20242
|
+
required: false,
|
|
20243
|
+
description: "Items per page"
|
|
20178
20244
|
}
|
|
20179
20245
|
],
|
|
20180
|
-
requestBody: {
|
|
20181
|
-
contentType: "application/json",
|
|
20182
|
-
schema: "any",
|
|
20183
|
-
required: true
|
|
20184
|
-
},
|
|
20185
20246
|
responses: {
|
|
20186
20247
|
"200": {
|
|
20187
|
-
description: "
|
|
20248
|
+
description: "List of alert groups",
|
|
20188
20249
|
schema: "any"
|
|
20189
20250
|
},
|
|
20190
20251
|
"401": {
|
|
@@ -20202,24 +20263,23 @@ var clientsData = [
|
|
|
20202
20263
|
}
|
|
20203
20264
|
},
|
|
20204
20265
|
{
|
|
20205
|
-
path: "/v2/alert_groups
|
|
20206
|
-
method: "
|
|
20207
|
-
summary: "
|
|
20266
|
+
path: "/v2/alert_groups",
|
|
20267
|
+
method: "POST",
|
|
20268
|
+
summary: "Create Alert Group",
|
|
20208
20269
|
tags: [
|
|
20209
20270
|
"AlertGroups"
|
|
20210
20271
|
],
|
|
20211
20272
|
parameters: [
|
|
20212
|
-
{
|
|
20213
|
-
name: "id",
|
|
20214
|
-
"in": "path",
|
|
20215
|
-
type: "integer",
|
|
20216
|
-
required: true,
|
|
20217
|
-
description: ""
|
|
20218
|
-
}
|
|
20219
20273
|
],
|
|
20274
|
+
requestBody: {
|
|
20275
|
+
contentType: "application/json",
|
|
20276
|
+
schema: "any",
|
|
20277
|
+
required: true
|
|
20278
|
+
},
|
|
20220
20279
|
responses: {
|
|
20221
20280
|
"200": {
|
|
20222
|
-
description: "
|
|
20281
|
+
description: "Created alert group",
|
|
20282
|
+
schema: "any"
|
|
20223
20283
|
},
|
|
20224
20284
|
"401": {
|
|
20225
20285
|
description: "Authentication error",
|
|
@@ -20236,15 +20296,15 @@ var clientsData = [
|
|
|
20236
20296
|
}
|
|
20237
20297
|
},
|
|
20238
20298
|
{
|
|
20239
|
-
path: "/v2/alert_groups/{
|
|
20299
|
+
path: "/v2/alert_groups/{id}",
|
|
20240
20300
|
method: "GET",
|
|
20241
|
-
summary: "
|
|
20301
|
+
summary: "Get Alert Group",
|
|
20242
20302
|
tags: [
|
|
20243
20303
|
"AlertGroups"
|
|
20244
20304
|
],
|
|
20245
20305
|
parameters: [
|
|
20246
20306
|
{
|
|
20247
|
-
name: "
|
|
20307
|
+
name: "id",
|
|
20248
20308
|
"in": "path",
|
|
20249
20309
|
type: "integer",
|
|
20250
20310
|
required: true,
|
|
@@ -20253,7 +20313,7 @@ var clientsData = [
|
|
|
20253
20313
|
],
|
|
20254
20314
|
responses: {
|
|
20255
20315
|
"200": {
|
|
20256
|
-
description: "
|
|
20316
|
+
description: "Alert group details",
|
|
20257
20317
|
schema: "any"
|
|
20258
20318
|
},
|
|
20259
20319
|
"401": {
|
|
@@ -20271,15 +20331,15 @@ var clientsData = [
|
|
|
20271
20331
|
}
|
|
20272
20332
|
},
|
|
20273
20333
|
{
|
|
20274
|
-
path: "/v2/alert_groups/{
|
|
20275
|
-
method: "
|
|
20276
|
-
summary: "
|
|
20334
|
+
path: "/v2/alert_groups/{id}",
|
|
20335
|
+
method: "PATCH",
|
|
20336
|
+
summary: "Update Alert Group",
|
|
20277
20337
|
tags: [
|
|
20278
20338
|
"AlertGroups"
|
|
20279
20339
|
],
|
|
20280
20340
|
parameters: [
|
|
20281
20341
|
{
|
|
20282
|
-
name: "
|
|
20342
|
+
name: "id",
|
|
20283
20343
|
"in": "path",
|
|
20284
20344
|
type: "integer",
|
|
20285
20345
|
required: true,
|
|
@@ -20293,7 +20353,7 @@ var clientsData = [
|
|
|
20293
20353
|
},
|
|
20294
20354
|
responses: {
|
|
20295
20355
|
"200": {
|
|
20296
|
-
description: "
|
|
20356
|
+
description: "Updated alert group",
|
|
20297
20357
|
schema: "any"
|
|
20298
20358
|
},
|
|
20299
20359
|
"401": {
|
|
@@ -20311,20 +20371,13 @@ var clientsData = [
|
|
|
20311
20371
|
}
|
|
20312
20372
|
},
|
|
20313
20373
|
{
|
|
20314
|
-
path: "/v2/alert_groups/{
|
|
20374
|
+
path: "/v2/alert_groups/{id}",
|
|
20315
20375
|
method: "DELETE",
|
|
20316
|
-
summary: "
|
|
20376
|
+
summary: "Delete Alert Group",
|
|
20317
20377
|
tags: [
|
|
20318
20378
|
"AlertGroups"
|
|
20319
20379
|
],
|
|
20320
20380
|
parameters: [
|
|
20321
|
-
{
|
|
20322
|
-
name: "alert_group_id",
|
|
20323
|
-
"in": "path",
|
|
20324
|
-
type: "integer",
|
|
20325
|
-
required: true,
|
|
20326
|
-
description: ""
|
|
20327
|
-
},
|
|
20328
20381
|
{
|
|
20329
20382
|
name: "id",
|
|
20330
20383
|
"in": "path",
|
|
@@ -20335,7 +20388,7 @@ var clientsData = [
|
|
|
20335
20388
|
],
|
|
20336
20389
|
responses: {
|
|
20337
20390
|
"200": {
|
|
20338
|
-
description: "
|
|
20391
|
+
description: "Deleted"
|
|
20339
20392
|
},
|
|
20340
20393
|
"401": {
|
|
20341
20394
|
description: "Authentication error",
|
|
@@ -20352,9 +20405,9 @@ var clientsData = [
|
|
|
20352
20405
|
}
|
|
20353
20406
|
},
|
|
20354
20407
|
{
|
|
20355
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20408
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
20356
20409
|
method: "GET",
|
|
20357
|
-
summary: "List Group
|
|
20410
|
+
summary: "List Group Members",
|
|
20358
20411
|
tags: [
|
|
20359
20412
|
"AlertGroups"
|
|
20360
20413
|
],
|
|
@@ -20369,7 +20422,7 @@ var clientsData = [
|
|
|
20369
20422
|
],
|
|
20370
20423
|
responses: {
|
|
20371
20424
|
"200": {
|
|
20372
|
-
description: "List of group
|
|
20425
|
+
description: "List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",
|
|
20373
20426
|
schema: "any"
|
|
20374
20427
|
},
|
|
20375
20428
|
"401": {
|
|
@@ -20387,9 +20440,9 @@ var clientsData = [
|
|
|
20387
20440
|
}
|
|
20388
20441
|
},
|
|
20389
20442
|
{
|
|
20390
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20443
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
20391
20444
|
method: "POST",
|
|
20392
|
-
summary: "Add
|
|
20445
|
+
summary: "Add Member to Group",
|
|
20393
20446
|
tags: [
|
|
20394
20447
|
"AlertGroups"
|
|
20395
20448
|
],
|
|
@@ -20409,7 +20462,7 @@ var clientsData = [
|
|
|
20409
20462
|
},
|
|
20410
20463
|
responses: {
|
|
20411
20464
|
"200": {
|
|
20412
|
-
description: "Added
|
|
20465
|
+
description: "Added member",
|
|
20413
20466
|
schema: "any"
|
|
20414
20467
|
},
|
|
20415
20468
|
"401": {
|
|
@@ -20427,9 +20480,9 @@ var clientsData = [
|
|
|
20427
20480
|
}
|
|
20428
20481
|
},
|
|
20429
20482
|
{
|
|
20430
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20483
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",
|
|
20431
20484
|
method: "DELETE",
|
|
20432
|
-
summary: "Remove
|
|
20485
|
+
summary: "Remove Member from Group",
|
|
20433
20486
|
tags: [
|
|
20434
20487
|
"AlertGroups"
|
|
20435
20488
|
],
|
|
@@ -20468,9 +20521,9 @@ var clientsData = [
|
|
|
20468
20521
|
}
|
|
20469
20522
|
},
|
|
20470
20523
|
{
|
|
20471
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20524
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
20472
20525
|
method: "GET",
|
|
20473
|
-
summary: "List Group
|
|
20526
|
+
summary: "List Group Assets",
|
|
20474
20527
|
tags: [
|
|
20475
20528
|
"AlertGroups"
|
|
20476
20529
|
],
|
|
@@ -20485,7 +20538,7 @@ var clientsData = [
|
|
|
20485
20538
|
],
|
|
20486
20539
|
responses: {
|
|
20487
20540
|
"200": {
|
|
20488
|
-
description: "List of
|
|
20541
|
+
description: "List of group assets",
|
|
20489
20542
|
schema: "any"
|
|
20490
20543
|
},
|
|
20491
20544
|
"401": {
|
|
@@ -20503,49 +20556,9 @@ var clientsData = [
|
|
|
20503
20556
|
}
|
|
20504
20557
|
},
|
|
20505
20558
|
{
|
|
20506
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20559
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
20507
20560
|
method: "POST",
|
|
20508
|
-
summary: "
|
|
20509
|
-
tags: [
|
|
20510
|
-
"AlertGroups"
|
|
20511
|
-
],
|
|
20512
|
-
parameters: [
|
|
20513
|
-
{
|
|
20514
|
-
name: "alert_group_id",
|
|
20515
|
-
"in": "path",
|
|
20516
|
-
type: "integer",
|
|
20517
|
-
required: true,
|
|
20518
|
-
description: ""
|
|
20519
|
-
}
|
|
20520
|
-
],
|
|
20521
|
-
requestBody: {
|
|
20522
|
-
contentType: "application/json",
|
|
20523
|
-
schema: "any",
|
|
20524
|
-
required: true
|
|
20525
|
-
},
|
|
20526
|
-
responses: {
|
|
20527
|
-
"200": {
|
|
20528
|
-
description: "Created configuration",
|
|
20529
|
-
schema: "any"
|
|
20530
|
-
},
|
|
20531
|
-
"401": {
|
|
20532
|
-
description: "Authentication error",
|
|
20533
|
-
schema: "any"
|
|
20534
|
-
},
|
|
20535
|
-
"403": {
|
|
20536
|
-
description: "Authorization error",
|
|
20537
|
-
schema: "any"
|
|
20538
|
-
},
|
|
20539
|
-
"404": {
|
|
20540
|
-
description: "Not found error",
|
|
20541
|
-
schema: "any"
|
|
20542
|
-
}
|
|
20543
|
-
}
|
|
20544
|
-
},
|
|
20545
|
-
{
|
|
20546
|
-
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
20547
|
-
method: "PATCH",
|
|
20548
|
-
summary: "Update Group Configuration",
|
|
20561
|
+
summary: "Add Asset to Group",
|
|
20549
20562
|
tags: [
|
|
20550
20563
|
"AlertGroups"
|
|
20551
20564
|
],
|
|
@@ -20556,13 +20569,6 @@ var clientsData = [
|
|
|
20556
20569
|
type: "integer",
|
|
20557
20570
|
required: true,
|
|
20558
20571
|
description: ""
|
|
20559
|
-
},
|
|
20560
|
-
{
|
|
20561
|
-
name: "id",
|
|
20562
|
-
"in": "path",
|
|
20563
|
-
type: "integer",
|
|
20564
|
-
required: true,
|
|
20565
|
-
description: ""
|
|
20566
20572
|
}
|
|
20567
20573
|
],
|
|
20568
20574
|
requestBody: {
|
|
@@ -20572,7 +20578,7 @@ var clientsData = [
|
|
|
20572
20578
|
},
|
|
20573
20579
|
responses: {
|
|
20574
20580
|
"200": {
|
|
20575
|
-
description: "
|
|
20581
|
+
description: "Added asset",
|
|
20576
20582
|
schema: "any"
|
|
20577
20583
|
},
|
|
20578
20584
|
"401": {
|
|
@@ -20590,9 +20596,172 @@ var clientsData = [
|
|
|
20590
20596
|
}
|
|
20591
20597
|
},
|
|
20592
20598
|
{
|
|
20593
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
20599
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/{id}",
|
|
20594
20600
|
method: "DELETE",
|
|
20595
|
-
summary: "
|
|
20601
|
+
summary: "Remove Asset from Group",
|
|
20602
|
+
tags: [
|
|
20603
|
+
"AlertGroups"
|
|
20604
|
+
],
|
|
20605
|
+
parameters: [
|
|
20606
|
+
{
|
|
20607
|
+
name: "alert_group_id",
|
|
20608
|
+
"in": "path",
|
|
20609
|
+
type: "integer",
|
|
20610
|
+
required: true,
|
|
20611
|
+
description: ""
|
|
20612
|
+
},
|
|
20613
|
+
{
|
|
20614
|
+
name: "id",
|
|
20615
|
+
"in": "path",
|
|
20616
|
+
type: "integer",
|
|
20617
|
+
required: true,
|
|
20618
|
+
description: ""
|
|
20619
|
+
}
|
|
20620
|
+
],
|
|
20621
|
+
responses: {
|
|
20622
|
+
"200": {
|
|
20623
|
+
description: "Removed"
|
|
20624
|
+
},
|
|
20625
|
+
"401": {
|
|
20626
|
+
description: "Authentication error",
|
|
20627
|
+
schema: "any"
|
|
20628
|
+
},
|
|
20629
|
+
"403": {
|
|
20630
|
+
description: "Authorization error",
|
|
20631
|
+
schema: "any"
|
|
20632
|
+
},
|
|
20633
|
+
"404": {
|
|
20634
|
+
description: "Not found error",
|
|
20635
|
+
schema: "any"
|
|
20636
|
+
}
|
|
20637
|
+
}
|
|
20638
|
+
},
|
|
20639
|
+
{
|
|
20640
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
20641
|
+
method: "GET",
|
|
20642
|
+
summary: "List Group Configurations",
|
|
20643
|
+
tags: [
|
|
20644
|
+
"AlertGroups"
|
|
20645
|
+
],
|
|
20646
|
+
parameters: [
|
|
20647
|
+
{
|
|
20648
|
+
name: "alert_group_id",
|
|
20649
|
+
"in": "path",
|
|
20650
|
+
type: "integer",
|
|
20651
|
+
required: true,
|
|
20652
|
+
description: ""
|
|
20653
|
+
}
|
|
20654
|
+
],
|
|
20655
|
+
responses: {
|
|
20656
|
+
"200": {
|
|
20657
|
+
description: "List of configurations",
|
|
20658
|
+
schema: "any"
|
|
20659
|
+
},
|
|
20660
|
+
"401": {
|
|
20661
|
+
description: "Authentication error",
|
|
20662
|
+
schema: "any"
|
|
20663
|
+
},
|
|
20664
|
+
"403": {
|
|
20665
|
+
description: "Authorization error",
|
|
20666
|
+
schema: "any"
|
|
20667
|
+
},
|
|
20668
|
+
"404": {
|
|
20669
|
+
description: "Not found error",
|
|
20670
|
+
schema: "any"
|
|
20671
|
+
}
|
|
20672
|
+
}
|
|
20673
|
+
},
|
|
20674
|
+
{
|
|
20675
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
20676
|
+
method: "POST",
|
|
20677
|
+
summary: "Create Group Configuration",
|
|
20678
|
+
tags: [
|
|
20679
|
+
"AlertGroups"
|
|
20680
|
+
],
|
|
20681
|
+
parameters: [
|
|
20682
|
+
{
|
|
20683
|
+
name: "alert_group_id",
|
|
20684
|
+
"in": "path",
|
|
20685
|
+
type: "integer",
|
|
20686
|
+
required: true,
|
|
20687
|
+
description: ""
|
|
20688
|
+
}
|
|
20689
|
+
],
|
|
20690
|
+
requestBody: {
|
|
20691
|
+
contentType: "application/json",
|
|
20692
|
+
schema: "any",
|
|
20693
|
+
required: true
|
|
20694
|
+
},
|
|
20695
|
+
responses: {
|
|
20696
|
+
"200": {
|
|
20697
|
+
description: "Created configuration",
|
|
20698
|
+
schema: "any"
|
|
20699
|
+
},
|
|
20700
|
+
"401": {
|
|
20701
|
+
description: "Authentication error",
|
|
20702
|
+
schema: "any"
|
|
20703
|
+
},
|
|
20704
|
+
"403": {
|
|
20705
|
+
description: "Authorization error",
|
|
20706
|
+
schema: "any"
|
|
20707
|
+
},
|
|
20708
|
+
"404": {
|
|
20709
|
+
description: "Not found error",
|
|
20710
|
+
schema: "any"
|
|
20711
|
+
}
|
|
20712
|
+
}
|
|
20713
|
+
},
|
|
20714
|
+
{
|
|
20715
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
20716
|
+
method: "PATCH",
|
|
20717
|
+
summary: "Update Group Configuration",
|
|
20718
|
+
tags: [
|
|
20719
|
+
"AlertGroups"
|
|
20720
|
+
],
|
|
20721
|
+
parameters: [
|
|
20722
|
+
{
|
|
20723
|
+
name: "alert_group_id",
|
|
20724
|
+
"in": "path",
|
|
20725
|
+
type: "integer",
|
|
20726
|
+
required: true,
|
|
20727
|
+
description: ""
|
|
20728
|
+
},
|
|
20729
|
+
{
|
|
20730
|
+
name: "id",
|
|
20731
|
+
"in": "path",
|
|
20732
|
+
type: "integer",
|
|
20733
|
+
required: true,
|
|
20734
|
+
description: ""
|
|
20735
|
+
}
|
|
20736
|
+
],
|
|
20737
|
+
requestBody: {
|
|
20738
|
+
contentType: "application/json",
|
|
20739
|
+
schema: "any",
|
|
20740
|
+
required: true
|
|
20741
|
+
},
|
|
20742
|
+
responses: {
|
|
20743
|
+
"200": {
|
|
20744
|
+
description: "Updated configuration",
|
|
20745
|
+
schema: "any"
|
|
20746
|
+
},
|
|
20747
|
+
"401": {
|
|
20748
|
+
description: "Authentication error",
|
|
20749
|
+
schema: "any"
|
|
20750
|
+
},
|
|
20751
|
+
"403": {
|
|
20752
|
+
description: "Authorization error",
|
|
20753
|
+
schema: "any"
|
|
20754
|
+
},
|
|
20755
|
+
"404": {
|
|
20756
|
+
description: "Not found error",
|
|
20757
|
+
schema: "any"
|
|
20758
|
+
}
|
|
20759
|
+
}
|
|
20760
|
+
},
|
|
20761
|
+
{
|
|
20762
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
20763
|
+
method: "DELETE",
|
|
20764
|
+
summary: "Delete Group Configuration",
|
|
20596
20765
|
tags: [
|
|
20597
20766
|
"AlertGroups"
|
|
20598
20767
|
],
|
|
@@ -20630,6 +20799,635 @@ var clientsData = [
|
|
|
20630
20799
|
}
|
|
20631
20800
|
}
|
|
20632
20801
|
},
|
|
20802
|
+
{
|
|
20803
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",
|
|
20804
|
+
method: "POST",
|
|
20805
|
+
summary: "Bulk Add Members to Group",
|
|
20806
|
+
tags: [
|
|
20807
|
+
"AlertGroups"
|
|
20808
|
+
],
|
|
20809
|
+
parameters: [
|
|
20810
|
+
{
|
|
20811
|
+
name: "alert_group_id",
|
|
20812
|
+
"in": "path",
|
|
20813
|
+
type: "integer",
|
|
20814
|
+
required: true,
|
|
20815
|
+
description: ""
|
|
20816
|
+
}
|
|
20817
|
+
],
|
|
20818
|
+
requestBody: {
|
|
20819
|
+
contentType: "application/json",
|
|
20820
|
+
schema: "any",
|
|
20821
|
+
required: true
|
|
20822
|
+
},
|
|
20823
|
+
responses: {
|
|
20824
|
+
"200": {
|
|
20825
|
+
description: "Members added (idempotent — users already in the group are skipped)",
|
|
20826
|
+
schema: "any"
|
|
20827
|
+
},
|
|
20828
|
+
"400": {
|
|
20829
|
+
description: "Validation error; no members were added"
|
|
20830
|
+
},
|
|
20831
|
+
"401": {
|
|
20832
|
+
description: "Authentication error",
|
|
20833
|
+
schema: "any"
|
|
20834
|
+
},
|
|
20835
|
+
"403": {
|
|
20836
|
+
description: "Authorization error",
|
|
20837
|
+
schema: "any"
|
|
20838
|
+
},
|
|
20839
|
+
"404": {
|
|
20840
|
+
description: "Not found error",
|
|
20841
|
+
schema: "any"
|
|
20842
|
+
}
|
|
20843
|
+
}
|
|
20844
|
+
},
|
|
20845
|
+
{
|
|
20846
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",
|
|
20847
|
+
method: "DELETE",
|
|
20848
|
+
summary: "Bulk Remove Members from Group",
|
|
20849
|
+
tags: [
|
|
20850
|
+
"AlertGroups"
|
|
20851
|
+
],
|
|
20852
|
+
parameters: [
|
|
20853
|
+
{
|
|
20854
|
+
name: "alert_group_id",
|
|
20855
|
+
"in": "path",
|
|
20856
|
+
type: "integer",
|
|
20857
|
+
required: true,
|
|
20858
|
+
description: ""
|
|
20859
|
+
}
|
|
20860
|
+
],
|
|
20861
|
+
requestBody: {
|
|
20862
|
+
contentType: "application/json",
|
|
20863
|
+
schema: "any",
|
|
20864
|
+
required: true
|
|
20865
|
+
},
|
|
20866
|
+
responses: {
|
|
20867
|
+
"200": {
|
|
20868
|
+
description: "Members removed",
|
|
20869
|
+
schema: "any"
|
|
20870
|
+
},
|
|
20871
|
+
"401": {
|
|
20872
|
+
description: "Authentication error",
|
|
20873
|
+
schema: "any"
|
|
20874
|
+
},
|
|
20875
|
+
"403": {
|
|
20876
|
+
description: "Authorization error",
|
|
20877
|
+
schema: "any"
|
|
20878
|
+
},
|
|
20879
|
+
"404": {
|
|
20880
|
+
description: "Not found error",
|
|
20881
|
+
schema: "any"
|
|
20882
|
+
}
|
|
20883
|
+
}
|
|
20884
|
+
},
|
|
20885
|
+
{
|
|
20886
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_create",
|
|
20887
|
+
method: "POST",
|
|
20888
|
+
summary: "Bulk Add Assets to Group",
|
|
20889
|
+
tags: [
|
|
20890
|
+
"AlertGroups"
|
|
20891
|
+
],
|
|
20892
|
+
parameters: [
|
|
20893
|
+
{
|
|
20894
|
+
name: "alert_group_id",
|
|
20895
|
+
"in": "path",
|
|
20896
|
+
type: "integer",
|
|
20897
|
+
required: true,
|
|
20898
|
+
description: ""
|
|
20899
|
+
}
|
|
20900
|
+
],
|
|
20901
|
+
requestBody: {
|
|
20902
|
+
contentType: "application/json",
|
|
20903
|
+
schema: "any",
|
|
20904
|
+
required: true
|
|
20905
|
+
},
|
|
20906
|
+
responses: {
|
|
20907
|
+
"200": {
|
|
20908
|
+
description: "Assets added (idempotent — assets already in the group are skipped)",
|
|
20909
|
+
schema: "any"
|
|
20910
|
+
},
|
|
20911
|
+
"400": {
|
|
20912
|
+
description: "Validation error; no assets were added"
|
|
20913
|
+
},
|
|
20914
|
+
"401": {
|
|
20915
|
+
description: "Authentication error",
|
|
20916
|
+
schema: "any"
|
|
20917
|
+
},
|
|
20918
|
+
"403": {
|
|
20919
|
+
description: "Authorization error",
|
|
20920
|
+
schema: "any"
|
|
20921
|
+
},
|
|
20922
|
+
"404": {
|
|
20923
|
+
description: "Not found error",
|
|
20924
|
+
schema: "any"
|
|
20925
|
+
}
|
|
20926
|
+
}
|
|
20927
|
+
},
|
|
20928
|
+
{
|
|
20929
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_destroy",
|
|
20930
|
+
method: "DELETE",
|
|
20931
|
+
summary: "Bulk Remove Assets from Group",
|
|
20932
|
+
tags: [
|
|
20933
|
+
"AlertGroups"
|
|
20934
|
+
],
|
|
20935
|
+
parameters: [
|
|
20936
|
+
{
|
|
20937
|
+
name: "alert_group_id",
|
|
20938
|
+
"in": "path",
|
|
20939
|
+
type: "integer",
|
|
20940
|
+
required: true,
|
|
20941
|
+
description: ""
|
|
20942
|
+
}
|
|
20943
|
+
],
|
|
20944
|
+
requestBody: {
|
|
20945
|
+
contentType: "application/json",
|
|
20946
|
+
schema: "any",
|
|
20947
|
+
required: true
|
|
20948
|
+
},
|
|
20949
|
+
responses: {
|
|
20950
|
+
"200": {
|
|
20951
|
+
description: "Assets removed",
|
|
20952
|
+
schema: "any"
|
|
20953
|
+
},
|
|
20954
|
+
"401": {
|
|
20955
|
+
description: "Authentication error",
|
|
20956
|
+
schema: "any"
|
|
20957
|
+
},
|
|
20958
|
+
"403": {
|
|
20959
|
+
description: "Authorization error",
|
|
20960
|
+
schema: "any"
|
|
20961
|
+
},
|
|
20962
|
+
"404": {
|
|
20963
|
+
description: "Not found error",
|
|
20964
|
+
schema: "any"
|
|
20965
|
+
}
|
|
20966
|
+
}
|
|
20967
|
+
},
|
|
20968
|
+
{
|
|
20969
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",
|
|
20970
|
+
method: "POST",
|
|
20971
|
+
summary: "Bulk Create Group Configurations",
|
|
20972
|
+
tags: [
|
|
20973
|
+
"AlertGroups"
|
|
20974
|
+
],
|
|
20975
|
+
parameters: [
|
|
20976
|
+
{
|
|
20977
|
+
name: "alert_group_id",
|
|
20978
|
+
"in": "path",
|
|
20979
|
+
type: "integer",
|
|
20980
|
+
required: true,
|
|
20981
|
+
description: ""
|
|
20982
|
+
}
|
|
20983
|
+
],
|
|
20984
|
+
requestBody: {
|
|
20985
|
+
contentType: "application/json",
|
|
20986
|
+
schema: "any",
|
|
20987
|
+
required: true
|
|
20988
|
+
},
|
|
20989
|
+
responses: {
|
|
20990
|
+
"200": {
|
|
20991
|
+
description: "Configurations created (all-or-nothing — none created if any is invalid)",
|
|
20992
|
+
schema: "any"
|
|
20993
|
+
},
|
|
20994
|
+
"400": {
|
|
20995
|
+
description: "Validation error; no configurations were created"
|
|
20996
|
+
},
|
|
20997
|
+
"401": {
|
|
20998
|
+
description: "Authentication error",
|
|
20999
|
+
schema: "any"
|
|
21000
|
+
},
|
|
21001
|
+
"403": {
|
|
21002
|
+
description: "Authorization error",
|
|
21003
|
+
schema: "any"
|
|
21004
|
+
},
|
|
21005
|
+
"404": {
|
|
21006
|
+
description: "Not found error",
|
|
21007
|
+
schema: "any"
|
|
21008
|
+
}
|
|
21009
|
+
}
|
|
21010
|
+
},
|
|
21011
|
+
{
|
|
21012
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",
|
|
21013
|
+
method: "DELETE",
|
|
21014
|
+
summary: "Bulk Delete Group Configurations",
|
|
21015
|
+
tags: [
|
|
21016
|
+
"AlertGroups"
|
|
21017
|
+
],
|
|
21018
|
+
parameters: [
|
|
21019
|
+
{
|
|
21020
|
+
name: "alert_group_id",
|
|
21021
|
+
"in": "path",
|
|
21022
|
+
type: "integer",
|
|
21023
|
+
required: true,
|
|
21024
|
+
description: ""
|
|
21025
|
+
}
|
|
21026
|
+
],
|
|
21027
|
+
requestBody: {
|
|
21028
|
+
contentType: "application/json",
|
|
21029
|
+
schema: "any",
|
|
21030
|
+
required: true
|
|
21031
|
+
},
|
|
21032
|
+
responses: {
|
|
21033
|
+
"200": {
|
|
21034
|
+
description: "Configurations removed",
|
|
21035
|
+
schema: "any"
|
|
21036
|
+
},
|
|
21037
|
+
"401": {
|
|
21038
|
+
description: "Authentication error",
|
|
21039
|
+
schema: "any"
|
|
21040
|
+
},
|
|
21041
|
+
"403": {
|
|
21042
|
+
description: "Authorization error",
|
|
21043
|
+
schema: "any"
|
|
21044
|
+
},
|
|
21045
|
+
"404": {
|
|
21046
|
+
description: "Not found error",
|
|
21047
|
+
schema: "any"
|
|
21048
|
+
}
|
|
21049
|
+
}
|
|
21050
|
+
},
|
|
21051
|
+
{
|
|
21052
|
+
path: "/v2/alert_abilities",
|
|
21053
|
+
method: "GET",
|
|
21054
|
+
summary: "List Assignable Alert Abilities",
|
|
21055
|
+
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.",
|
|
21056
|
+
tags: [
|
|
21057
|
+
"AlertRBAC"
|
|
21058
|
+
],
|
|
21059
|
+
parameters: [
|
|
21060
|
+
{
|
|
21061
|
+
name: "locale",
|
|
21062
|
+
"in": "query",
|
|
21063
|
+
type: "string",
|
|
21064
|
+
required: false,
|
|
21065
|
+
description: "Display-name language; unknown/unsupported locales fall back to English"
|
|
21066
|
+
}
|
|
21067
|
+
],
|
|
21068
|
+
responses: {
|
|
21069
|
+
"200": {
|
|
21070
|
+
description: "Ability catalog",
|
|
21071
|
+
schema: "any"
|
|
21072
|
+
},
|
|
21073
|
+
"401": {
|
|
21074
|
+
description: "Authentication error",
|
|
21075
|
+
schema: "any"
|
|
21076
|
+
},
|
|
21077
|
+
"403": {
|
|
21078
|
+
description: "Authorization error",
|
|
21079
|
+
schema: "any"
|
|
21080
|
+
},
|
|
21081
|
+
"404": {
|
|
21082
|
+
description: "Not found error",
|
|
21083
|
+
schema: "any"
|
|
21084
|
+
}
|
|
21085
|
+
}
|
|
21086
|
+
},
|
|
21087
|
+
{
|
|
21088
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
21089
|
+
method: "GET",
|
|
21090
|
+
summary: "List Alert Roles",
|
|
21091
|
+
description: "Company-defined alert roles. Gated by `update Company` (company admins only).",
|
|
21092
|
+
tags: [
|
|
21093
|
+
"AlertRBAC"
|
|
21094
|
+
],
|
|
21095
|
+
parameters: [
|
|
21096
|
+
{
|
|
21097
|
+
name: "company_id",
|
|
21098
|
+
"in": "path",
|
|
21099
|
+
type: "integer",
|
|
21100
|
+
required: true,
|
|
21101
|
+
description: "Company ID"
|
|
21102
|
+
},
|
|
21103
|
+
{
|
|
21104
|
+
name: "page",
|
|
21105
|
+
"in": "query",
|
|
21106
|
+
type: "integer",
|
|
21107
|
+
required: false,
|
|
21108
|
+
description: "Page number"
|
|
21109
|
+
},
|
|
21110
|
+
{
|
|
21111
|
+
name: "per_page",
|
|
21112
|
+
"in": "query",
|
|
21113
|
+
type: "integer",
|
|
21114
|
+
required: false,
|
|
21115
|
+
description: "Items per page"
|
|
21116
|
+
}
|
|
21117
|
+
],
|
|
21118
|
+
responses: {
|
|
21119
|
+
"200": {
|
|
21120
|
+
description: "List of alert roles",
|
|
21121
|
+
schema: "any"
|
|
21122
|
+
},
|
|
21123
|
+
"401": {
|
|
21124
|
+
description: "Authentication error",
|
|
21125
|
+
schema: "any"
|
|
21126
|
+
},
|
|
21127
|
+
"403": {
|
|
21128
|
+
description: "Caller is not a company admin"
|
|
21129
|
+
},
|
|
21130
|
+
"404": {
|
|
21131
|
+
description: "Not found error",
|
|
21132
|
+
schema: "any"
|
|
21133
|
+
}
|
|
21134
|
+
}
|
|
21135
|
+
},
|
|
21136
|
+
{
|
|
21137
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
21138
|
+
method: "POST",
|
|
21139
|
+
summary: "Create Alert Role",
|
|
21140
|
+
tags: [
|
|
21141
|
+
"AlertRBAC"
|
|
21142
|
+
],
|
|
21143
|
+
parameters: [
|
|
21144
|
+
{
|
|
21145
|
+
name: "company_id",
|
|
21146
|
+
"in": "path",
|
|
21147
|
+
type: "integer",
|
|
21148
|
+
required: true,
|
|
21149
|
+
description: "Company ID"
|
|
21150
|
+
}
|
|
21151
|
+
],
|
|
21152
|
+
requestBody: {
|
|
21153
|
+
contentType: "application/json",
|
|
21154
|
+
schema: "any",
|
|
21155
|
+
required: true
|
|
21156
|
+
},
|
|
21157
|
+
responses: {
|
|
21158
|
+
"200": {
|
|
21159
|
+
description: "Created alert role",
|
|
21160
|
+
schema: "any"
|
|
21161
|
+
},
|
|
21162
|
+
"400": {
|
|
21163
|
+
description: "Validation error (e.g. blank or duplicate name)"
|
|
21164
|
+
},
|
|
21165
|
+
"401": {
|
|
21166
|
+
description: "Authentication error",
|
|
21167
|
+
schema: "any"
|
|
21168
|
+
},
|
|
21169
|
+
"403": {
|
|
21170
|
+
description: "Caller is not a company admin"
|
|
21171
|
+
},
|
|
21172
|
+
"404": {
|
|
21173
|
+
description: "Not found error",
|
|
21174
|
+
schema: "any"
|
|
21175
|
+
}
|
|
21176
|
+
}
|
|
21177
|
+
},
|
|
21178
|
+
{
|
|
21179
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
21180
|
+
method: "GET",
|
|
21181
|
+
summary: "Get Alert Role",
|
|
21182
|
+
tags: [
|
|
21183
|
+
"AlertRBAC"
|
|
21184
|
+
],
|
|
21185
|
+
parameters: [
|
|
21186
|
+
{
|
|
21187
|
+
name: "company_id",
|
|
21188
|
+
"in": "path",
|
|
21189
|
+
type: "integer",
|
|
21190
|
+
required: true,
|
|
21191
|
+
description: "Company ID"
|
|
21192
|
+
},
|
|
21193
|
+
{
|
|
21194
|
+
name: "id",
|
|
21195
|
+
"in": "path",
|
|
21196
|
+
type: "integer",
|
|
21197
|
+
required: true,
|
|
21198
|
+
description: "Alert role ID"
|
|
21199
|
+
}
|
|
21200
|
+
],
|
|
21201
|
+
responses: {
|
|
21202
|
+
"200": {
|
|
21203
|
+
description: "Alert role details",
|
|
21204
|
+
schema: "any"
|
|
21205
|
+
},
|
|
21206
|
+
"401": {
|
|
21207
|
+
description: "Authentication error",
|
|
21208
|
+
schema: "any"
|
|
21209
|
+
},
|
|
21210
|
+
"403": {
|
|
21211
|
+
description: "Caller is not a company admin"
|
|
21212
|
+
},
|
|
21213
|
+
"404": {
|
|
21214
|
+
description: "Role not found in this company"
|
|
21215
|
+
}
|
|
21216
|
+
}
|
|
21217
|
+
},
|
|
21218
|
+
{
|
|
21219
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
21220
|
+
method: "PATCH",
|
|
21221
|
+
summary: "Update Alert Role",
|
|
21222
|
+
tags: [
|
|
21223
|
+
"AlertRBAC"
|
|
21224
|
+
],
|
|
21225
|
+
parameters: [
|
|
21226
|
+
{
|
|
21227
|
+
name: "company_id",
|
|
21228
|
+
"in": "path",
|
|
21229
|
+
type: "integer",
|
|
21230
|
+
required: true,
|
|
21231
|
+
description: "Company ID"
|
|
21232
|
+
},
|
|
21233
|
+
{
|
|
21234
|
+
name: "id",
|
|
21235
|
+
"in": "path",
|
|
21236
|
+
type: "integer",
|
|
21237
|
+
required: true,
|
|
21238
|
+
description: "Alert role ID"
|
|
21239
|
+
}
|
|
21240
|
+
],
|
|
21241
|
+
requestBody: {
|
|
21242
|
+
contentType: "application/json",
|
|
21243
|
+
schema: "any",
|
|
21244
|
+
required: true
|
|
21245
|
+
},
|
|
21246
|
+
responses: {
|
|
21247
|
+
"200": {
|
|
21248
|
+
description: "Updated alert role",
|
|
21249
|
+
schema: "any"
|
|
21250
|
+
},
|
|
21251
|
+
"400": {
|
|
21252
|
+
description: "Validation error"
|
|
21253
|
+
},
|
|
21254
|
+
"401": {
|
|
21255
|
+
description: "Authentication error",
|
|
21256
|
+
schema: "any"
|
|
21257
|
+
},
|
|
21258
|
+
"403": {
|
|
21259
|
+
description: "Caller is not a company admin"
|
|
21260
|
+
},
|
|
21261
|
+
"404": {
|
|
21262
|
+
description: "Not found error",
|
|
21263
|
+
schema: "any"
|
|
21264
|
+
}
|
|
21265
|
+
}
|
|
21266
|
+
},
|
|
21267
|
+
{
|
|
21268
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
21269
|
+
method: "DELETE",
|
|
21270
|
+
summary: "Delete Alert Role",
|
|
21271
|
+
description: "Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",
|
|
21272
|
+
tags: [
|
|
21273
|
+
"AlertRBAC"
|
|
21274
|
+
],
|
|
21275
|
+
parameters: [
|
|
21276
|
+
{
|
|
21277
|
+
name: "company_id",
|
|
21278
|
+
"in": "path",
|
|
21279
|
+
type: "integer",
|
|
21280
|
+
required: true,
|
|
21281
|
+
description: "Company ID"
|
|
21282
|
+
},
|
|
21283
|
+
{
|
|
21284
|
+
name: "id",
|
|
21285
|
+
"in": "path",
|
|
21286
|
+
type: "integer",
|
|
21287
|
+
required: true,
|
|
21288
|
+
description: "Alert role ID"
|
|
21289
|
+
}
|
|
21290
|
+
],
|
|
21291
|
+
responses: {
|
|
21292
|
+
"200": {
|
|
21293
|
+
description: "Deleted"
|
|
21294
|
+
},
|
|
21295
|
+
"401": {
|
|
21296
|
+
description: "Authentication error",
|
|
21297
|
+
schema: "any"
|
|
21298
|
+
},
|
|
21299
|
+
"403": {
|
|
21300
|
+
description: "Caller is not a company admin, or the role is still assigned to members"
|
|
21301
|
+
},
|
|
21302
|
+
"404": {
|
|
21303
|
+
description: "Not found error",
|
|
21304
|
+
schema: "any"
|
|
21305
|
+
}
|
|
21306
|
+
}
|
|
21307
|
+
},
|
|
21308
|
+
{
|
|
21309
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}/abilities",
|
|
21310
|
+
method: "PUT",
|
|
21311
|
+
summary: "Replace Alert Role Abilities",
|
|
21312
|
+
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.",
|
|
21313
|
+
tags: [
|
|
21314
|
+
"AlertRBAC"
|
|
21315
|
+
],
|
|
21316
|
+
parameters: [
|
|
21317
|
+
{
|
|
21318
|
+
name: "company_id",
|
|
21319
|
+
"in": "path",
|
|
21320
|
+
type: "integer",
|
|
21321
|
+
required: true,
|
|
21322
|
+
description: "Company ID"
|
|
21323
|
+
},
|
|
21324
|
+
{
|
|
21325
|
+
name: "id",
|
|
21326
|
+
"in": "path",
|
|
21327
|
+
type: "integer",
|
|
21328
|
+
required: true,
|
|
21329
|
+
description: "Alert role ID"
|
|
21330
|
+
}
|
|
21331
|
+
],
|
|
21332
|
+
requestBody: {
|
|
21333
|
+
contentType: "application/json",
|
|
21334
|
+
schema: "any",
|
|
21335
|
+
required: true
|
|
21336
|
+
},
|
|
21337
|
+
responses: {
|
|
21338
|
+
"200": {
|
|
21339
|
+
description: "Role with its updated abilities",
|
|
21340
|
+
schema: "any"
|
|
21341
|
+
},
|
|
21342
|
+
"400": {
|
|
21343
|
+
description: "Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"
|
|
21344
|
+
},
|
|
21345
|
+
"401": {
|
|
21346
|
+
description: "Authentication error",
|
|
21347
|
+
schema: "any"
|
|
21348
|
+
},
|
|
21349
|
+
"403": {
|
|
21350
|
+
description: "Caller is not a company admin"
|
|
21351
|
+
},
|
|
21352
|
+
"404": {
|
|
21353
|
+
description: "Not found error",
|
|
21354
|
+
schema: "any"
|
|
21355
|
+
}
|
|
21356
|
+
}
|
|
21357
|
+
},
|
|
21358
|
+
{
|
|
21359
|
+
path: "/v2/companies/{company_id}/alert_rbac/enable",
|
|
21360
|
+
method: "POST",
|
|
21361
|
+
summary: "Enable Alert RBAC",
|
|
21362
|
+
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.",
|
|
21363
|
+
tags: [
|
|
21364
|
+
"AlertRBAC"
|
|
21365
|
+
],
|
|
21366
|
+
parameters: [
|
|
21367
|
+
{
|
|
21368
|
+
name: "company_id",
|
|
21369
|
+
"in": "path",
|
|
21370
|
+
type: "integer",
|
|
21371
|
+
required: true,
|
|
21372
|
+
description: "Company ID"
|
|
21373
|
+
}
|
|
21374
|
+
],
|
|
21375
|
+
responses: {
|
|
21376
|
+
"200": {
|
|
21377
|
+
description: "RBAC enabled",
|
|
21378
|
+
schema: "any"
|
|
21379
|
+
},
|
|
21380
|
+
"401": {
|
|
21381
|
+
description: "Authentication error",
|
|
21382
|
+
schema: "any"
|
|
21383
|
+
},
|
|
21384
|
+
"403": {
|
|
21385
|
+
description: "Caller is not a company admin"
|
|
21386
|
+
},
|
|
21387
|
+
"404": {
|
|
21388
|
+
description: "Not found error",
|
|
21389
|
+
schema: "any"
|
|
21390
|
+
},
|
|
21391
|
+
"422": {
|
|
21392
|
+
description: "No alert role exists yet"
|
|
21393
|
+
}
|
|
21394
|
+
}
|
|
21395
|
+
},
|
|
21396
|
+
{
|
|
21397
|
+
path: "/v2/companies/{company_id}/alert_rbac/disable",
|
|
21398
|
+
method: "POST",
|
|
21399
|
+
summary: "Disable Alert RBAC",
|
|
21400
|
+
description: "Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",
|
|
21401
|
+
tags: [
|
|
21402
|
+
"AlertRBAC"
|
|
21403
|
+
],
|
|
21404
|
+
parameters: [
|
|
21405
|
+
{
|
|
21406
|
+
name: "company_id",
|
|
21407
|
+
"in": "path",
|
|
21408
|
+
type: "integer",
|
|
21409
|
+
required: true,
|
|
21410
|
+
description: "Company ID"
|
|
21411
|
+
}
|
|
21412
|
+
],
|
|
21413
|
+
responses: {
|
|
21414
|
+
"200": {
|
|
21415
|
+
description: "RBAC disabled",
|
|
21416
|
+
schema: "any"
|
|
21417
|
+
},
|
|
21418
|
+
"401": {
|
|
21419
|
+
description: "Authentication error",
|
|
21420
|
+
schema: "any"
|
|
21421
|
+
},
|
|
21422
|
+
"403": {
|
|
21423
|
+
description: "Caller is not a company admin"
|
|
21424
|
+
},
|
|
21425
|
+
"404": {
|
|
21426
|
+
description: "Not found error",
|
|
21427
|
+
schema: "any"
|
|
21428
|
+
}
|
|
21429
|
+
}
|
|
21430
|
+
},
|
|
20633
21431
|
{
|
|
20634
21432
|
path: "/v2/alerts/{alert_id}/occurrences",
|
|
20635
21433
|
method: "GET",
|
|
@@ -20645,12 +21443,19 @@ var clientsData = [
|
|
|
20645
21443
|
required: true,
|
|
20646
21444
|
description: "Alert ID"
|
|
20647
21445
|
},
|
|
21446
|
+
{
|
|
21447
|
+
name: "sort",
|
|
21448
|
+
"in": "query",
|
|
21449
|
+
type: "string",
|
|
21450
|
+
required: false,
|
|
21451
|
+
description: "Field to sort by: start_at (default) or severity"
|
|
21452
|
+
},
|
|
20648
21453
|
{
|
|
20649
21454
|
name: "order",
|
|
20650
21455
|
"in": "query",
|
|
20651
21456
|
type: "string",
|
|
20652
21457
|
required: false,
|
|
20653
|
-
description: "Sort
|
|
21458
|
+
description: "Sort direction: asc (default) or desc"
|
|
20654
21459
|
},
|
|
20655
21460
|
{
|
|
20656
21461
|
name: "page",
|
|
@@ -20705,6 +21510,20 @@ var clientsData = [
|
|
|
20705
21510
|
required: false,
|
|
20706
21511
|
description: "Timestamp to end alert at"
|
|
20707
21512
|
},
|
|
21513
|
+
{
|
|
21514
|
+
name: "last_alert_start",
|
|
21515
|
+
"in": "query",
|
|
21516
|
+
type: "integer",
|
|
21517
|
+
required: false,
|
|
21518
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
21519
|
+
},
|
|
21520
|
+
{
|
|
21521
|
+
name: "last_alert_end",
|
|
21522
|
+
"in": "query",
|
|
21523
|
+
type: "integer",
|
|
21524
|
+
required: false,
|
|
21525
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
21526
|
+
},
|
|
20708
21527
|
{
|
|
20709
21528
|
name: "page",
|
|
20710
21529
|
"in": "query",
|
|
@@ -21121,6 +21940,20 @@ var clientsData = [
|
|
|
21121
21940
|
required: false,
|
|
21122
21941
|
description: "Timestamp to end alert at"
|
|
21123
21942
|
},
|
|
21943
|
+
{
|
|
21944
|
+
name: "last_alert_start",
|
|
21945
|
+
"in": "query",
|
|
21946
|
+
type: "integer",
|
|
21947
|
+
required: false,
|
|
21948
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
21949
|
+
},
|
|
21950
|
+
{
|
|
21951
|
+
name: "last_alert_end",
|
|
21952
|
+
"in": "query",
|
|
21953
|
+
type: "integer",
|
|
21954
|
+
required: false,
|
|
21955
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
21956
|
+
},
|
|
21124
21957
|
{
|
|
21125
21958
|
name: "created_after",
|
|
21126
21959
|
"in": "query",
|
|
@@ -21233,6 +22066,20 @@ var clientsData = [
|
|
|
21233
22066
|
required: false,
|
|
21234
22067
|
description: "Timestamp to end alert at"
|
|
21235
22068
|
},
|
|
22069
|
+
{
|
|
22070
|
+
name: "last_alert_start",
|
|
22071
|
+
"in": "query",
|
|
22072
|
+
type: "integer",
|
|
22073
|
+
required: false,
|
|
22074
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
22075
|
+
},
|
|
22076
|
+
{
|
|
22077
|
+
name: "last_alert_end",
|
|
22078
|
+
"in": "query",
|
|
22079
|
+
type: "integer",
|
|
22080
|
+
required: false,
|
|
22081
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
22082
|
+
},
|
|
21236
22083
|
{
|
|
21237
22084
|
name: "page",
|
|
21238
22085
|
"in": "query",
|
|
@@ -27306,27 +28153,503 @@ var clientsData = [
|
|
|
27306
28153
|
}
|
|
27307
28154
|
},
|
|
27308
28155
|
{
|
|
27309
|
-
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
27310
|
-
method: "PATCH",
|
|
27311
|
-
summary: "Update a dashboard",
|
|
28156
|
+
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
28157
|
+
method: "PATCH",
|
|
28158
|
+
summary: "Update a dashboard",
|
|
28159
|
+
tags: [
|
|
28160
|
+
"Dashboards"
|
|
28161
|
+
],
|
|
28162
|
+
parameters: [
|
|
28163
|
+
{
|
|
28164
|
+
name: "user_id",
|
|
28165
|
+
"in": "path",
|
|
28166
|
+
type: "integer",
|
|
28167
|
+
required: true,
|
|
28168
|
+
description: "User ID"
|
|
28169
|
+
},
|
|
28170
|
+
{
|
|
28171
|
+
name: "id",
|
|
28172
|
+
"in": "path",
|
|
28173
|
+
type: "integer",
|
|
28174
|
+
required: true,
|
|
28175
|
+
description: "Dashboard ID"
|
|
28176
|
+
}
|
|
28177
|
+
],
|
|
28178
|
+
requestBody: {
|
|
28179
|
+
contentType: "application/json",
|
|
28180
|
+
schema: "any",
|
|
28181
|
+
required: true
|
|
28182
|
+
},
|
|
28183
|
+
responses: {
|
|
28184
|
+
"200": {
|
|
28185
|
+
description: "Updated dashboard",
|
|
28186
|
+
schema: "any"
|
|
28187
|
+
},
|
|
28188
|
+
"401": {
|
|
28189
|
+
description: "Authentication error",
|
|
28190
|
+
schema: "any"
|
|
28191
|
+
},
|
|
28192
|
+
"403": {
|
|
28193
|
+
description: "Authorization error",
|
|
28194
|
+
schema: "any"
|
|
28195
|
+
},
|
|
28196
|
+
"404": {
|
|
28197
|
+
description: "Not found error",
|
|
28198
|
+
schema: "any"
|
|
28199
|
+
}
|
|
28200
|
+
}
|
|
28201
|
+
},
|
|
28202
|
+
{
|
|
28203
|
+
path: "/v2/users/{user_id}/dashboards/{id}",
|
|
28204
|
+
method: "DELETE",
|
|
28205
|
+
summary: "Delete a dashboard",
|
|
28206
|
+
tags: [
|
|
28207
|
+
"Dashboards"
|
|
28208
|
+
],
|
|
28209
|
+
parameters: [
|
|
28210
|
+
{
|
|
28211
|
+
name: "user_id",
|
|
28212
|
+
"in": "path",
|
|
28213
|
+
type: "integer",
|
|
28214
|
+
required: true,
|
|
28215
|
+
description: "User ID"
|
|
28216
|
+
},
|
|
28217
|
+
{
|
|
28218
|
+
name: "id",
|
|
28219
|
+
"in": "path",
|
|
28220
|
+
type: "integer",
|
|
28221
|
+
required: true,
|
|
28222
|
+
description: "Dashboard ID"
|
|
28223
|
+
}
|
|
28224
|
+
],
|
|
28225
|
+
responses: {
|
|
28226
|
+
"200": {
|
|
28227
|
+
description: "Dashboard deleted"
|
|
28228
|
+
},
|
|
28229
|
+
"401": {
|
|
28230
|
+
description: "Authentication error",
|
|
28231
|
+
schema: "any"
|
|
28232
|
+
},
|
|
28233
|
+
"403": {
|
|
28234
|
+
description: "Authorization error",
|
|
28235
|
+
schema: "any"
|
|
28236
|
+
},
|
|
28237
|
+
"404": {
|
|
28238
|
+
description: "Not found error",
|
|
28239
|
+
schema: "any"
|
|
28240
|
+
}
|
|
28241
|
+
}
|
|
28242
|
+
},
|
|
28243
|
+
{
|
|
28244
|
+
path: "/v2/users/{user_id}/dashboards/{id}/clone",
|
|
28245
|
+
method: "POST",
|
|
28246
|
+
summary: "Clone a dashboard",
|
|
28247
|
+
tags: [
|
|
28248
|
+
"Dashboards"
|
|
28249
|
+
],
|
|
28250
|
+
parameters: [
|
|
28251
|
+
{
|
|
28252
|
+
name: "user_id",
|
|
28253
|
+
"in": "path",
|
|
28254
|
+
type: "integer",
|
|
28255
|
+
required: true,
|
|
28256
|
+
description: "User ID"
|
|
28257
|
+
},
|
|
28258
|
+
{
|
|
28259
|
+
name: "id",
|
|
28260
|
+
"in": "path",
|
|
28261
|
+
type: "integer",
|
|
28262
|
+
required: true,
|
|
28263
|
+
description: "Dashboard ID"
|
|
28264
|
+
}
|
|
28265
|
+
],
|
|
28266
|
+
requestBody: {
|
|
28267
|
+
contentType: "application/json",
|
|
28268
|
+
schema: "any",
|
|
28269
|
+
required: true
|
|
28270
|
+
},
|
|
28271
|
+
responses: {
|
|
28272
|
+
"200": {
|
|
28273
|
+
description: "Cloned dashboard",
|
|
28274
|
+
schema: "any"
|
|
28275
|
+
},
|
|
28276
|
+
"401": {
|
|
28277
|
+
description: "Authentication error",
|
|
28278
|
+
schema: "any"
|
|
28279
|
+
},
|
|
28280
|
+
"403": {
|
|
28281
|
+
description: "Authorization error",
|
|
28282
|
+
schema: "any"
|
|
28283
|
+
},
|
|
28284
|
+
"404": {
|
|
28285
|
+
description: "Not found error",
|
|
28286
|
+
schema: "any"
|
|
28287
|
+
}
|
|
28288
|
+
}
|
|
28289
|
+
},
|
|
28290
|
+
{
|
|
28291
|
+
path: "/v2/dashboards/templates",
|
|
28292
|
+
method: "GET",
|
|
28293
|
+
summary: "Get template dashboards",
|
|
28294
|
+
tags: [
|
|
28295
|
+
"Dashboards"
|
|
28296
|
+
],
|
|
28297
|
+
parameters: [
|
|
28298
|
+
],
|
|
28299
|
+
responses: {
|
|
28300
|
+
"200": {
|
|
28301
|
+
description: "Template dashboards",
|
|
28302
|
+
schema: "any"
|
|
28303
|
+
},
|
|
28304
|
+
"401": {
|
|
28305
|
+
description: "Authentication error",
|
|
28306
|
+
schema: "any"
|
|
28307
|
+
},
|
|
28308
|
+
"403": {
|
|
28309
|
+
description: "Authorization error",
|
|
28310
|
+
schema: "any"
|
|
28311
|
+
},
|
|
28312
|
+
"404": {
|
|
28313
|
+
description: "Not found error",
|
|
28314
|
+
schema: "any"
|
|
28315
|
+
}
|
|
28316
|
+
}
|
|
28317
|
+
},
|
|
28318
|
+
{
|
|
28319
|
+
path: "/v2/users/{user_id}/dashboards/{id}/use_template",
|
|
28320
|
+
method: "POST",
|
|
28321
|
+
summary: "Set dashboard apps and layout from a template dashboard",
|
|
28322
|
+
tags: [
|
|
28323
|
+
"Dashboards"
|
|
28324
|
+
],
|
|
28325
|
+
parameters: [
|
|
28326
|
+
{
|
|
28327
|
+
name: "user_id",
|
|
28328
|
+
"in": "path",
|
|
28329
|
+
type: "integer",
|
|
28330
|
+
required: true,
|
|
28331
|
+
description: "User ID"
|
|
28332
|
+
},
|
|
28333
|
+
{
|
|
28334
|
+
name: "id",
|
|
28335
|
+
"in": "path",
|
|
28336
|
+
type: "integer",
|
|
28337
|
+
required: true,
|
|
28338
|
+
description: "Dashboard ID"
|
|
28339
|
+
}
|
|
28340
|
+
],
|
|
28341
|
+
requestBody: {
|
|
28342
|
+
contentType: "application/json",
|
|
28343
|
+
schema: "integer",
|
|
28344
|
+
required: true
|
|
28345
|
+
},
|
|
28346
|
+
responses: {
|
|
28347
|
+
"200": {
|
|
28348
|
+
description: "Modified dashboard",
|
|
28349
|
+
schema: "any"
|
|
28350
|
+
},
|
|
28351
|
+
"401": {
|
|
28352
|
+
description: "Authentication error",
|
|
28353
|
+
schema: "any"
|
|
28354
|
+
},
|
|
28355
|
+
"403": {
|
|
28356
|
+
description: "Authorization error",
|
|
28357
|
+
schema: "any"
|
|
28358
|
+
},
|
|
28359
|
+
"404": {
|
|
28360
|
+
description: "Not found error",
|
|
28361
|
+
schema: "any"
|
|
28362
|
+
}
|
|
28363
|
+
}
|
|
28364
|
+
},
|
|
28365
|
+
{
|
|
28366
|
+
path: "/v2/dashboards",
|
|
28367
|
+
method: "GET",
|
|
28368
|
+
summary: "List all dashboards",
|
|
28369
|
+
tags: [
|
|
28370
|
+
"Dashboards"
|
|
28371
|
+
],
|
|
28372
|
+
parameters: [
|
|
28373
|
+
{
|
|
28374
|
+
name: "visibility",
|
|
28375
|
+
"in": "query",
|
|
28376
|
+
type: "string",
|
|
28377
|
+
required: false,
|
|
28378
|
+
description: "Filter Dashboards by visibility"
|
|
28379
|
+
},
|
|
28380
|
+
{
|
|
28381
|
+
name: "type",
|
|
28382
|
+
"in": "query",
|
|
28383
|
+
type: "string",
|
|
28384
|
+
required: false,
|
|
28385
|
+
description: "Filter Dashboards by type"
|
|
28386
|
+
},
|
|
28387
|
+
{
|
|
28388
|
+
name: "viewed",
|
|
28389
|
+
"in": "query",
|
|
28390
|
+
type: "string",
|
|
28391
|
+
required: false,
|
|
28392
|
+
description: "Filter Dashboards by viewed"
|
|
28393
|
+
},
|
|
28394
|
+
{
|
|
28395
|
+
name: "segment",
|
|
28396
|
+
"in": "query",
|
|
28397
|
+
type: "string",
|
|
28398
|
+
required: false,
|
|
28399
|
+
description: "Filter Dashboards by segment"
|
|
28400
|
+
},
|
|
28401
|
+
{
|
|
28402
|
+
name: "layout",
|
|
28403
|
+
"in": "query",
|
|
28404
|
+
type: "string",
|
|
28405
|
+
required: false,
|
|
28406
|
+
description: "Filter Dashboards by layout"
|
|
28407
|
+
},
|
|
28408
|
+
{
|
|
28409
|
+
name: "category",
|
|
28410
|
+
"in": "query",
|
|
28411
|
+
type: "string",
|
|
28412
|
+
required: false,
|
|
28413
|
+
description: "Filter Dashboards by category"
|
|
28414
|
+
},
|
|
28415
|
+
{
|
|
28416
|
+
name: "exclude_shared",
|
|
28417
|
+
"in": "query",
|
|
28418
|
+
type: "boolean",
|
|
28419
|
+
required: false,
|
|
28420
|
+
description: "Filter Shared Dashboards"
|
|
28421
|
+
},
|
|
28422
|
+
{
|
|
28423
|
+
name: "can_update",
|
|
28424
|
+
"in": "query",
|
|
28425
|
+
type: "boolean",
|
|
28426
|
+
required: false,
|
|
28427
|
+
description: "Filter Dashboards by ability to update"
|
|
28428
|
+
},
|
|
28429
|
+
{
|
|
28430
|
+
name: "sort",
|
|
28431
|
+
"in": "query",
|
|
28432
|
+
type: "string",
|
|
28433
|
+
required: false,
|
|
28434
|
+
description: "Sort dashboards by order field"
|
|
28435
|
+
}
|
|
28436
|
+
],
|
|
28437
|
+
responses: {
|
|
28438
|
+
"200": {
|
|
28439
|
+
description: "Successful response",
|
|
28440
|
+
schema: "any"
|
|
28441
|
+
},
|
|
28442
|
+
"401": {
|
|
28443
|
+
description: "Authentication error",
|
|
28444
|
+
schema: "any"
|
|
28445
|
+
},
|
|
28446
|
+
"403": {
|
|
28447
|
+
description: "Authorization error",
|
|
28448
|
+
schema: "any"
|
|
28449
|
+
},
|
|
28450
|
+
"404": {
|
|
28451
|
+
description: "Not found error",
|
|
28452
|
+
schema: "any"
|
|
28453
|
+
}
|
|
28454
|
+
}
|
|
28455
|
+
},
|
|
28456
|
+
{
|
|
28457
|
+
path: "/v2/dashboards/{id}/available_timezones",
|
|
28458
|
+
method: "GET",
|
|
28459
|
+
summary: "List timezones for dashboard",
|
|
28460
|
+
tags: [
|
|
28461
|
+
"Dashboards"
|
|
28462
|
+
],
|
|
28463
|
+
parameters: [
|
|
28464
|
+
{
|
|
28465
|
+
name: "id",
|
|
28466
|
+
"in": "path",
|
|
28467
|
+
type: "integer",
|
|
28468
|
+
required: true,
|
|
28469
|
+
description: "Dashboard ID"
|
|
28470
|
+
}
|
|
28471
|
+
],
|
|
28472
|
+
responses: {
|
|
28473
|
+
"200": {
|
|
28474
|
+
description: "Successful response",
|
|
28475
|
+
schema: "any"
|
|
28476
|
+
},
|
|
28477
|
+
"401": {
|
|
28478
|
+
description: "Authentication error",
|
|
28479
|
+
schema: "any"
|
|
28480
|
+
},
|
|
28481
|
+
"403": {
|
|
28482
|
+
description: "Authorization error",
|
|
28483
|
+
schema: "any"
|
|
28484
|
+
},
|
|
28485
|
+
"404": {
|
|
28486
|
+
description: "Not found error",
|
|
28487
|
+
schema: "any"
|
|
28488
|
+
}
|
|
28489
|
+
}
|
|
28490
|
+
},
|
|
28491
|
+
{
|
|
28492
|
+
path: "/v2/well_plan_checklists",
|
|
28493
|
+
method: "GET",
|
|
28494
|
+
summary: "List well plan checklists",
|
|
28495
|
+
tags: [
|
|
28496
|
+
"Well Plan Checklists"
|
|
28497
|
+
],
|
|
28498
|
+
parameters: [
|
|
28499
|
+
{
|
|
28500
|
+
name: "company_id",
|
|
28501
|
+
"in": "query",
|
|
28502
|
+
type: "integer",
|
|
28503
|
+
required: false,
|
|
28504
|
+
description: "Filter by company ID"
|
|
28505
|
+
},
|
|
28506
|
+
{
|
|
28507
|
+
name: "per_page",
|
|
28508
|
+
"in": "query",
|
|
28509
|
+
type: "integer",
|
|
28510
|
+
required: false,
|
|
28511
|
+
description: "Number of items to list per page"
|
|
28512
|
+
},
|
|
28513
|
+
{
|
|
28514
|
+
name: "page",
|
|
28515
|
+
"in": "query",
|
|
28516
|
+
type: "integer",
|
|
28517
|
+
required: false,
|
|
28518
|
+
description: "Page number"
|
|
28519
|
+
}
|
|
28520
|
+
],
|
|
28521
|
+
responses: {
|
|
28522
|
+
"200": {
|
|
28523
|
+
description: "Successful response",
|
|
28524
|
+
schema: "any"
|
|
28525
|
+
},
|
|
28526
|
+
"401": {
|
|
28527
|
+
description: "Authentication error",
|
|
28528
|
+
schema: "any"
|
|
28529
|
+
},
|
|
28530
|
+
"403": {
|
|
28531
|
+
description: "Authorization error",
|
|
28532
|
+
schema: "any"
|
|
28533
|
+
},
|
|
28534
|
+
"404": {
|
|
28535
|
+
description: "Not found error",
|
|
28536
|
+
schema: "any"
|
|
28537
|
+
}
|
|
28538
|
+
}
|
|
28539
|
+
},
|
|
28540
|
+
{
|
|
28541
|
+
path: "/v2/well_plan_checklists/{id}",
|
|
28542
|
+
method: "GET",
|
|
28543
|
+
summary: "Show well plan checklist",
|
|
28544
|
+
tags: [
|
|
28545
|
+
"Well Plan Checklists"
|
|
28546
|
+
],
|
|
28547
|
+
parameters: [
|
|
28548
|
+
{
|
|
28549
|
+
name: "id",
|
|
28550
|
+
"in": "path",
|
|
28551
|
+
type: "integer",
|
|
28552
|
+
required: true,
|
|
28553
|
+
description: "Well Plan Checklist ID"
|
|
28554
|
+
}
|
|
28555
|
+
],
|
|
28556
|
+
responses: {
|
|
28557
|
+
"200": {
|
|
28558
|
+
description: "Successful response",
|
|
28559
|
+
schema: "any"
|
|
28560
|
+
},
|
|
28561
|
+
"401": {
|
|
28562
|
+
description: "Authentication error",
|
|
28563
|
+
schema: "any"
|
|
28564
|
+
},
|
|
28565
|
+
"403": {
|
|
28566
|
+
description: "Authorization error",
|
|
28567
|
+
schema: "any"
|
|
28568
|
+
},
|
|
28569
|
+
"404": {
|
|
28570
|
+
description: "Not found error",
|
|
28571
|
+
schema: "any"
|
|
28572
|
+
}
|
|
28573
|
+
}
|
|
28574
|
+
},
|
|
28575
|
+
{
|
|
28576
|
+
path: "/v2/well_plans",
|
|
28577
|
+
method: "GET",
|
|
28578
|
+
summary: "List well plans",
|
|
28579
|
+
tags: [
|
|
28580
|
+
"Well Plans"
|
|
28581
|
+
],
|
|
28582
|
+
parameters: [
|
|
28583
|
+
{
|
|
28584
|
+
name: "company_id",
|
|
28585
|
+
"in": "query",
|
|
28586
|
+
type: "integer",
|
|
28587
|
+
required: false,
|
|
28588
|
+
description: "Filter by company ID"
|
|
28589
|
+
},
|
|
28590
|
+
{
|
|
28591
|
+
name: "well_id",
|
|
28592
|
+
"in": "query",
|
|
28593
|
+
type: "integer",
|
|
28594
|
+
required: false,
|
|
28595
|
+
description: "Filter by well ID"
|
|
28596
|
+
},
|
|
28597
|
+
{
|
|
28598
|
+
name: "source_well_id",
|
|
28599
|
+
"in": "query",
|
|
28600
|
+
type: "integer",
|
|
28601
|
+
required: false,
|
|
28602
|
+
description: "Filter by source well ID"
|
|
28603
|
+
},
|
|
28604
|
+
{
|
|
28605
|
+
name: "status",
|
|
28606
|
+
"in": "query",
|
|
28607
|
+
type: "string",
|
|
28608
|
+
required: false,
|
|
28609
|
+
description: "Filter by status"
|
|
28610
|
+
},
|
|
28611
|
+
{
|
|
28612
|
+
name: "per_page",
|
|
28613
|
+
"in": "query",
|
|
28614
|
+
type: "integer",
|
|
28615
|
+
required: false,
|
|
28616
|
+
description: "Number of items to list per page"
|
|
28617
|
+
},
|
|
28618
|
+
{
|
|
28619
|
+
name: "page",
|
|
28620
|
+
"in": "query",
|
|
28621
|
+
type: "integer",
|
|
28622
|
+
required: false,
|
|
28623
|
+
description: "Page number"
|
|
28624
|
+
}
|
|
28625
|
+
],
|
|
28626
|
+
responses: {
|
|
28627
|
+
"200": {
|
|
28628
|
+
description: "Successful response",
|
|
28629
|
+
schema: "any"
|
|
28630
|
+
},
|
|
28631
|
+
"401": {
|
|
28632
|
+
description: "Authentication error",
|
|
28633
|
+
schema: "any"
|
|
28634
|
+
},
|
|
28635
|
+
"403": {
|
|
28636
|
+
description: "Authorization error",
|
|
28637
|
+
schema: "any"
|
|
28638
|
+
},
|
|
28639
|
+
"404": {
|
|
28640
|
+
description: "Not found error",
|
|
28641
|
+
schema: "any"
|
|
28642
|
+
}
|
|
28643
|
+
}
|
|
28644
|
+
},
|
|
28645
|
+
{
|
|
28646
|
+
path: "/v2/well_plans",
|
|
28647
|
+
method: "POST",
|
|
28648
|
+
summary: "Create a well plan",
|
|
27312
28649
|
tags: [
|
|
27313
|
-
"
|
|
28650
|
+
"Well Plans"
|
|
27314
28651
|
],
|
|
27315
28652
|
parameters: [
|
|
27316
|
-
{
|
|
27317
|
-
name: "user_id",
|
|
27318
|
-
"in": "path",
|
|
27319
|
-
type: "integer",
|
|
27320
|
-
required: true,
|
|
27321
|
-
description: "User ID"
|
|
27322
|
-
},
|
|
27323
|
-
{
|
|
27324
|
-
name: "id",
|
|
27325
|
-
"in": "path",
|
|
27326
|
-
type: "integer",
|
|
27327
|
-
required: true,
|
|
27328
|
-
description: "Dashboard ID"
|
|
27329
|
-
}
|
|
27330
28653
|
],
|
|
27331
28654
|
requestBody: {
|
|
27332
28655
|
contentType: "application/json",
|
|
@@ -27335,7 +28658,7 @@ var clientsData = [
|
|
|
27335
28658
|
},
|
|
27336
28659
|
responses: {
|
|
27337
28660
|
"200": {
|
|
27338
|
-
description: "
|
|
28661
|
+
description: "Created well plan",
|
|
27339
28662
|
schema: "any"
|
|
27340
28663
|
},
|
|
27341
28664
|
"401": {
|
|
@@ -27353,31 +28676,25 @@ var clientsData = [
|
|
|
27353
28676
|
}
|
|
27354
28677
|
},
|
|
27355
28678
|
{
|
|
27356
|
-
path: "/v2/
|
|
27357
|
-
method: "
|
|
27358
|
-
summary: "
|
|
28679
|
+
path: "/v2/well_plans/{id}",
|
|
28680
|
+
method: "GET",
|
|
28681
|
+
summary: "Show well plan",
|
|
27359
28682
|
tags: [
|
|
27360
|
-
"
|
|
28683
|
+
"Well Plans"
|
|
27361
28684
|
],
|
|
27362
28685
|
parameters: [
|
|
27363
|
-
{
|
|
27364
|
-
name: "user_id",
|
|
27365
|
-
"in": "path",
|
|
27366
|
-
type: "integer",
|
|
27367
|
-
required: true,
|
|
27368
|
-
description: "User ID"
|
|
27369
|
-
},
|
|
27370
28686
|
{
|
|
27371
28687
|
name: "id",
|
|
27372
28688
|
"in": "path",
|
|
27373
28689
|
type: "integer",
|
|
27374
28690
|
required: true,
|
|
27375
|
-
description: "
|
|
28691
|
+
description: "Well Plan ID"
|
|
27376
28692
|
}
|
|
27377
28693
|
],
|
|
27378
28694
|
responses: {
|
|
27379
28695
|
"200": {
|
|
27380
|
-
description: "
|
|
28696
|
+
description: "Successful response",
|
|
28697
|
+
schema: "any"
|
|
27381
28698
|
},
|
|
27382
28699
|
"401": {
|
|
27383
28700
|
description: "Authentication error",
|
|
@@ -27394,26 +28711,19 @@ var clientsData = [
|
|
|
27394
28711
|
}
|
|
27395
28712
|
},
|
|
27396
28713
|
{
|
|
27397
|
-
path: "/v2/
|
|
27398
|
-
method: "
|
|
27399
|
-
summary: "
|
|
28714
|
+
path: "/v2/well_plans/{id}",
|
|
28715
|
+
method: "PATCH",
|
|
28716
|
+
summary: "Update well plan",
|
|
27400
28717
|
tags: [
|
|
27401
|
-
"
|
|
28718
|
+
"Well Plans"
|
|
27402
28719
|
],
|
|
27403
28720
|
parameters: [
|
|
27404
|
-
{
|
|
27405
|
-
name: "user_id",
|
|
27406
|
-
"in": "path",
|
|
27407
|
-
type: "integer",
|
|
27408
|
-
required: true,
|
|
27409
|
-
description: "User ID"
|
|
27410
|
-
},
|
|
27411
28721
|
{
|
|
27412
28722
|
name: "id",
|
|
27413
28723
|
"in": "path",
|
|
27414
28724
|
type: "integer",
|
|
27415
28725
|
required: true,
|
|
27416
|
-
description: "
|
|
28726
|
+
description: "Well Plan ID"
|
|
27417
28727
|
}
|
|
27418
28728
|
],
|
|
27419
28729
|
requestBody: {
|
|
@@ -27423,7 +28733,7 @@ var clientsData = [
|
|
|
27423
28733
|
},
|
|
27424
28734
|
responses: {
|
|
27425
28735
|
"200": {
|
|
27426
|
-
description: "
|
|
28736
|
+
description: "Updated well plan",
|
|
27427
28737
|
schema: "any"
|
|
27428
28738
|
},
|
|
27429
28739
|
"401": {
|
|
@@ -27441,64 +28751,24 @@ var clientsData = [
|
|
|
27441
28751
|
}
|
|
27442
28752
|
},
|
|
27443
28753
|
{
|
|
27444
|
-
path: "/v2/
|
|
27445
|
-
method: "
|
|
27446
|
-
summary: "
|
|
27447
|
-
tags: [
|
|
27448
|
-
"Dashboards"
|
|
27449
|
-
],
|
|
27450
|
-
parameters: [
|
|
27451
|
-
],
|
|
27452
|
-
responses: {
|
|
27453
|
-
"200": {
|
|
27454
|
-
description: "Template dashboards",
|
|
27455
|
-
schema: "any"
|
|
27456
|
-
},
|
|
27457
|
-
"401": {
|
|
27458
|
-
description: "Authentication error",
|
|
27459
|
-
schema: "any"
|
|
27460
|
-
},
|
|
27461
|
-
"403": {
|
|
27462
|
-
description: "Authorization error",
|
|
27463
|
-
schema: "any"
|
|
27464
|
-
},
|
|
27465
|
-
"404": {
|
|
27466
|
-
description: "Not found error",
|
|
27467
|
-
schema: "any"
|
|
27468
|
-
}
|
|
27469
|
-
}
|
|
27470
|
-
},
|
|
27471
|
-
{
|
|
27472
|
-
path: "/v2/users/{user_id}/dashboards/{id}/use_template",
|
|
27473
|
-
method: "POST",
|
|
27474
|
-
summary: "Set dashboard apps and layout from a template dashboard",
|
|
28754
|
+
path: "/v2/well_plans/{id}",
|
|
28755
|
+
method: "DELETE",
|
|
28756
|
+
summary: "Delete well plan",
|
|
27475
28757
|
tags: [
|
|
27476
|
-
"
|
|
28758
|
+
"Well Plans"
|
|
27477
28759
|
],
|
|
27478
28760
|
parameters: [
|
|
27479
|
-
{
|
|
27480
|
-
name: "user_id",
|
|
27481
|
-
"in": "path",
|
|
27482
|
-
type: "integer",
|
|
27483
|
-
required: true,
|
|
27484
|
-
description: "User ID"
|
|
27485
|
-
},
|
|
27486
28761
|
{
|
|
27487
28762
|
name: "id",
|
|
27488
28763
|
"in": "path",
|
|
27489
28764
|
type: "integer",
|
|
27490
28765
|
required: true,
|
|
27491
|
-
description: "
|
|
28766
|
+
description: "Well Plan ID"
|
|
27492
28767
|
}
|
|
27493
28768
|
],
|
|
27494
|
-
requestBody: {
|
|
27495
|
-
contentType: "application/json",
|
|
27496
|
-
schema: "integer",
|
|
27497
|
-
required: true
|
|
27498
|
-
},
|
|
27499
28769
|
responses: {
|
|
27500
28770
|
"200": {
|
|
27501
|
-
description: "
|
|
28771
|
+
description: "Well plan deleted",
|
|
27502
28772
|
schema: "any"
|
|
27503
28773
|
},
|
|
27504
28774
|
"401": {
|
|
@@ -27516,75 +28786,33 @@ var clientsData = [
|
|
|
27516
28786
|
}
|
|
27517
28787
|
},
|
|
27518
28788
|
{
|
|
27519
|
-
path: "/v2/
|
|
28789
|
+
path: "/v2/well_plan_tabs",
|
|
27520
28790
|
method: "GET",
|
|
27521
|
-
summary: "List
|
|
28791
|
+
summary: "List well plan tabs",
|
|
27522
28792
|
tags: [
|
|
27523
|
-
"
|
|
28793
|
+
"Well Plan Tabs"
|
|
27524
28794
|
],
|
|
27525
28795
|
parameters: [
|
|
27526
28796
|
{
|
|
27527
|
-
name: "
|
|
27528
|
-
"in": "query",
|
|
27529
|
-
type: "string",
|
|
27530
|
-
required: false,
|
|
27531
|
-
description: "Filter Dashboards by visibility"
|
|
27532
|
-
},
|
|
27533
|
-
{
|
|
27534
|
-
name: "type",
|
|
27535
|
-
"in": "query",
|
|
27536
|
-
type: "string",
|
|
27537
|
-
required: false,
|
|
27538
|
-
description: "Filter Dashboards by type"
|
|
27539
|
-
},
|
|
27540
|
-
{
|
|
27541
|
-
name: "viewed",
|
|
27542
|
-
"in": "query",
|
|
27543
|
-
type: "string",
|
|
27544
|
-
required: false,
|
|
27545
|
-
description: "Filter Dashboards by viewed"
|
|
27546
|
-
},
|
|
27547
|
-
{
|
|
27548
|
-
name: "segment",
|
|
27549
|
-
"in": "query",
|
|
27550
|
-
type: "string",
|
|
27551
|
-
required: false,
|
|
27552
|
-
description: "Filter Dashboards by segment"
|
|
27553
|
-
},
|
|
27554
|
-
{
|
|
27555
|
-
name: "layout",
|
|
27556
|
-
"in": "query",
|
|
27557
|
-
type: "string",
|
|
27558
|
-
required: false,
|
|
27559
|
-
description: "Filter Dashboards by layout"
|
|
27560
|
-
},
|
|
27561
|
-
{
|
|
27562
|
-
name: "category",
|
|
27563
|
-
"in": "query",
|
|
27564
|
-
type: "string",
|
|
27565
|
-
required: false,
|
|
27566
|
-
description: "Filter Dashboards by category"
|
|
27567
|
-
},
|
|
27568
|
-
{
|
|
27569
|
-
name: "exclude_shared",
|
|
28797
|
+
name: "company_id",
|
|
27570
28798
|
"in": "query",
|
|
27571
|
-
type: "
|
|
28799
|
+
type: "integer",
|
|
27572
28800
|
required: false,
|
|
27573
|
-
description: "Filter
|
|
28801
|
+
description: "Filter by company ID"
|
|
27574
28802
|
},
|
|
27575
28803
|
{
|
|
27576
|
-
name: "
|
|
28804
|
+
name: "per_page",
|
|
27577
28805
|
"in": "query",
|
|
27578
|
-
type: "
|
|
28806
|
+
type: "integer",
|
|
27579
28807
|
required: false,
|
|
27580
|
-
description: "
|
|
28808
|
+
description: "Number of items to list per page"
|
|
27581
28809
|
},
|
|
27582
28810
|
{
|
|
27583
|
-
name: "
|
|
28811
|
+
name: "page",
|
|
27584
28812
|
"in": "query",
|
|
27585
|
-
type: "
|
|
28813
|
+
type: "integer",
|
|
27586
28814
|
required: false,
|
|
27587
|
-
description: "
|
|
28815
|
+
description: "Page number"
|
|
27588
28816
|
}
|
|
27589
28817
|
],
|
|
27590
28818
|
responses: {
|
|
@@ -27607,11 +28835,11 @@ var clientsData = [
|
|
|
27607
28835
|
}
|
|
27608
28836
|
},
|
|
27609
28837
|
{
|
|
27610
|
-
path: "/v2/
|
|
28838
|
+
path: "/v2/well_plan_tabs/{id}",
|
|
27611
28839
|
method: "GET",
|
|
27612
|
-
summary: "
|
|
28840
|
+
summary: "Show well plan tab",
|
|
27613
28841
|
tags: [
|
|
27614
|
-
"
|
|
28842
|
+
"Well Plan Tabs"
|
|
27615
28843
|
],
|
|
27616
28844
|
parameters: [
|
|
27617
28845
|
{
|
|
@@ -27619,7 +28847,7 @@ var clientsData = [
|
|
|
27619
28847
|
"in": "path",
|
|
27620
28848
|
type: "integer",
|
|
27621
28849
|
required: true,
|
|
27622
|
-
description: "
|
|
28850
|
+
description: "Well Plan Tab ID"
|
|
27623
28851
|
}
|
|
27624
28852
|
],
|
|
27625
28853
|
responses: {
|
|
@@ -47174,6 +48402,118 @@ var clientsData = [
|
|
|
47174
48402
|
}
|
|
47175
48403
|
}
|
|
47176
48404
|
},
|
|
48405
|
+
{
|
|
48406
|
+
path: "/v2/well_drillout_unit_runs",
|
|
48407
|
+
method: "GET",
|
|
48408
|
+
summary: "List well drillout unit runs",
|
|
48409
|
+
tags: [
|
|
48410
|
+
"WellDrilloutUnitRuns"
|
|
48411
|
+
],
|
|
48412
|
+
parameters: [
|
|
48413
|
+
{
|
|
48414
|
+
name: "company_id",
|
|
48415
|
+
"in": "query",
|
|
48416
|
+
type: "integer",
|
|
48417
|
+
required: false,
|
|
48418
|
+
description: "Filter by company ID"
|
|
48419
|
+
},
|
|
48420
|
+
{
|
|
48421
|
+
name: "well_id",
|
|
48422
|
+
"in": "query",
|
|
48423
|
+
type: "integer",
|
|
48424
|
+
required: false,
|
|
48425
|
+
description: "Filter by well ID"
|
|
48426
|
+
},
|
|
48427
|
+
{
|
|
48428
|
+
name: "drillout_unit_id",
|
|
48429
|
+
"in": "query",
|
|
48430
|
+
type: "integer",
|
|
48431
|
+
required: false,
|
|
48432
|
+
description: "Filter by drillout unit ID"
|
|
48433
|
+
},
|
|
48434
|
+
{
|
|
48435
|
+
name: "fields",
|
|
48436
|
+
"in": "query",
|
|
48437
|
+
type: "any",
|
|
48438
|
+
required: false,
|
|
48439
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
48440
|
+
},
|
|
48441
|
+
{
|
|
48442
|
+
name: "per_page",
|
|
48443
|
+
"in": "query",
|
|
48444
|
+
type: "integer",
|
|
48445
|
+
required: false,
|
|
48446
|
+
description: "Number of well drillout unit runs per page"
|
|
48447
|
+
},
|
|
48448
|
+
{
|
|
48449
|
+
name: "page",
|
|
48450
|
+
"in": "query",
|
|
48451
|
+
type: "integer",
|
|
48452
|
+
required: false,
|
|
48453
|
+
description: "Page number"
|
|
48454
|
+
}
|
|
48455
|
+
],
|
|
48456
|
+
responses: {
|
|
48457
|
+
"200": {
|
|
48458
|
+
description: "List well drillout unit runs",
|
|
48459
|
+
schema: "any"
|
|
48460
|
+
},
|
|
48461
|
+
"401": {
|
|
48462
|
+
description: "Authentication error",
|
|
48463
|
+
schema: "any"
|
|
48464
|
+
},
|
|
48465
|
+
"403": {
|
|
48466
|
+
description: "Authorization error",
|
|
48467
|
+
schema: "any"
|
|
48468
|
+
},
|
|
48469
|
+
"404": {
|
|
48470
|
+
description: "Not found error",
|
|
48471
|
+
schema: "any"
|
|
48472
|
+
}
|
|
48473
|
+
}
|
|
48474
|
+
},
|
|
48475
|
+
{
|
|
48476
|
+
path: "/v2/well_drillout_unit_runs/{id}",
|
|
48477
|
+
method: "GET",
|
|
48478
|
+
summary: "Get a single well drillout unit run",
|
|
48479
|
+
tags: [
|
|
48480
|
+
"WellDrilloutUnitRuns"
|
|
48481
|
+
],
|
|
48482
|
+
parameters: [
|
|
48483
|
+
{
|
|
48484
|
+
name: "id",
|
|
48485
|
+
"in": "path",
|
|
48486
|
+
type: "integer",
|
|
48487
|
+
required: true,
|
|
48488
|
+
description: "Well Drillout Unit Run ID"
|
|
48489
|
+
},
|
|
48490
|
+
{
|
|
48491
|
+
name: "fields",
|
|
48492
|
+
"in": "query",
|
|
48493
|
+
type: "any",
|
|
48494
|
+
required: false,
|
|
48495
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
48496
|
+
}
|
|
48497
|
+
],
|
|
48498
|
+
responses: {
|
|
48499
|
+
"200": {
|
|
48500
|
+
description: "Get well drillout unit run",
|
|
48501
|
+
schema: "any"
|
|
48502
|
+
},
|
|
48503
|
+
"401": {
|
|
48504
|
+
description: "Authentication error",
|
|
48505
|
+
schema: "any"
|
|
48506
|
+
},
|
|
48507
|
+
"403": {
|
|
48508
|
+
description: "Authorization error",
|
|
48509
|
+
schema: "any"
|
|
48510
|
+
},
|
|
48511
|
+
"404": {
|
|
48512
|
+
description: "Not found error",
|
|
48513
|
+
schema: "any"
|
|
48514
|
+
}
|
|
48515
|
+
}
|
|
48516
|
+
},
|
|
47177
48517
|
{
|
|
47178
48518
|
path: "/v2/pad_frac_fleets",
|
|
47179
48519
|
method: "GET",
|
|
@@ -48754,30 +50094,296 @@ var clientsData = [
|
|
|
48754
50094
|
description: "Not found error",
|
|
48755
50095
|
schema: "NotFoundError"
|
|
48756
50096
|
}
|
|
48757
|
-
}
|
|
48758
|
-
}
|
|
48759
|
-
],
|
|
48760
|
-
endpointsByTag: {
|
|
48761
|
-
AbilityCheck: [
|
|
50097
|
+
}
|
|
50098
|
+
}
|
|
50099
|
+
],
|
|
50100
|
+
endpointsByTag: {
|
|
50101
|
+
AbilityCheck: [
|
|
50102
|
+
{
|
|
50103
|
+
path: "v2/ability_check/check_feature",
|
|
50104
|
+
method: "GET",
|
|
50105
|
+
summary: "Check feature status for user",
|
|
50106
|
+
tags: [
|
|
50107
|
+
"AbilityCheck"
|
|
50108
|
+
],
|
|
50109
|
+
parameters: [
|
|
50110
|
+
{
|
|
50111
|
+
name: "feature_name",
|
|
50112
|
+
"in": "query",
|
|
50113
|
+
type: "string",
|
|
50114
|
+
required: true,
|
|
50115
|
+
description: "Name of Feature"
|
|
50116
|
+
}
|
|
50117
|
+
],
|
|
50118
|
+
responses: {
|
|
50119
|
+
"200": {
|
|
50120
|
+
description: "Successful response",
|
|
50121
|
+
schema: "any"
|
|
50122
|
+
},
|
|
50123
|
+
"401": {
|
|
50124
|
+
description: "Authentication error",
|
|
50125
|
+
schema: "any"
|
|
50126
|
+
},
|
|
50127
|
+
"403": {
|
|
50128
|
+
description: "Authorization error",
|
|
50129
|
+
schema: "any"
|
|
50130
|
+
},
|
|
50131
|
+
"404": {
|
|
50132
|
+
description: "Not found error",
|
|
50133
|
+
schema: "any"
|
|
50134
|
+
}
|
|
50135
|
+
}
|
|
50136
|
+
},
|
|
50137
|
+
{
|
|
50138
|
+
path: "v2/ability_check/check_permission",
|
|
50139
|
+
method: "GET",
|
|
50140
|
+
summary: "Check permission status for user",
|
|
50141
|
+
tags: [
|
|
50142
|
+
"AbilityCheck"
|
|
50143
|
+
],
|
|
50144
|
+
parameters: [
|
|
50145
|
+
{
|
|
50146
|
+
name: "ability",
|
|
50147
|
+
"in": "query",
|
|
50148
|
+
type: "string",
|
|
50149
|
+
required: true,
|
|
50150
|
+
description: "Ability to check"
|
|
50151
|
+
},
|
|
50152
|
+
{
|
|
50153
|
+
name: "resource_class",
|
|
50154
|
+
"in": "query",
|
|
50155
|
+
type: "string",
|
|
50156
|
+
required: true,
|
|
50157
|
+
description: "Class of resource"
|
|
50158
|
+
},
|
|
50159
|
+
{
|
|
50160
|
+
name: "resource_id",
|
|
50161
|
+
"in": "query",
|
|
50162
|
+
type: "integer",
|
|
50163
|
+
required: false,
|
|
50164
|
+
description: "Id of resource if checking permission for particular entity"
|
|
50165
|
+
},
|
|
50166
|
+
{
|
|
50167
|
+
name: "name",
|
|
50168
|
+
"in": "query",
|
|
50169
|
+
type: "integer",
|
|
50170
|
+
required: false,
|
|
50171
|
+
description: "Dataset name"
|
|
50172
|
+
},
|
|
50173
|
+
{
|
|
50174
|
+
name: "provider",
|
|
50175
|
+
"in": "query",
|
|
50176
|
+
type: "integer",
|
|
50177
|
+
required: false,
|
|
50178
|
+
description: "Dataset provider"
|
|
50179
|
+
}
|
|
50180
|
+
],
|
|
50181
|
+
responses: {
|
|
50182
|
+
"200": {
|
|
50183
|
+
description: "Successful response",
|
|
50184
|
+
schema: "any"
|
|
50185
|
+
},
|
|
50186
|
+
"401": {
|
|
50187
|
+
description: "Authentication error",
|
|
50188
|
+
schema: "any"
|
|
50189
|
+
},
|
|
50190
|
+
"403": {
|
|
50191
|
+
description: "Authorization error",
|
|
50192
|
+
schema: "any"
|
|
50193
|
+
},
|
|
50194
|
+
"404": {
|
|
50195
|
+
description: "Not found error",
|
|
50196
|
+
schema: "any"
|
|
50197
|
+
}
|
|
50198
|
+
}
|
|
50199
|
+
}
|
|
50200
|
+
],
|
|
50201
|
+
AlertDefinitions: [
|
|
50202
|
+
{
|
|
50203
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_definitions",
|
|
50204
|
+
method: "GET",
|
|
50205
|
+
summary: "List an Alert Group's Definitions",
|
|
50206
|
+
tags: [
|
|
50207
|
+
"AlertDefinitions"
|
|
50208
|
+
],
|
|
50209
|
+
parameters: [
|
|
50210
|
+
{
|
|
50211
|
+
name: "alert_group_id",
|
|
50212
|
+
"in": "path",
|
|
50213
|
+
type: "integer",
|
|
50214
|
+
required: true,
|
|
50215
|
+
description: "Alert group ID"
|
|
50216
|
+
},
|
|
50217
|
+
{
|
|
50218
|
+
name: "type",
|
|
50219
|
+
"in": "query",
|
|
50220
|
+
type: "string",
|
|
50221
|
+
required: false,
|
|
50222
|
+
description: "Filter by type (personal/company)"
|
|
50223
|
+
},
|
|
50224
|
+
{
|
|
50225
|
+
name: "search",
|
|
50226
|
+
"in": "query",
|
|
50227
|
+
type: "string",
|
|
50228
|
+
required: false,
|
|
50229
|
+
description: "Search by name"
|
|
50230
|
+
},
|
|
50231
|
+
{
|
|
50232
|
+
name: "page",
|
|
50233
|
+
"in": "query",
|
|
50234
|
+
type: "integer",
|
|
50235
|
+
required: false,
|
|
50236
|
+
description: "Page number"
|
|
50237
|
+
},
|
|
50238
|
+
{
|
|
50239
|
+
name: "per_page",
|
|
50240
|
+
"in": "query",
|
|
50241
|
+
type: "integer",
|
|
50242
|
+
required: false,
|
|
50243
|
+
description: "Items per page"
|
|
50244
|
+
}
|
|
50245
|
+
],
|
|
50246
|
+
responses: {
|
|
50247
|
+
"200": {
|
|
50248
|
+
description: "The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",
|
|
50249
|
+
schema: "any"
|
|
50250
|
+
},
|
|
50251
|
+
"401": {
|
|
50252
|
+
description: "Authentication error",
|
|
50253
|
+
schema: "any"
|
|
50254
|
+
},
|
|
50255
|
+
"403": {
|
|
50256
|
+
description: "Authorization error",
|
|
50257
|
+
schema: "any"
|
|
50258
|
+
},
|
|
50259
|
+
"404": {
|
|
50260
|
+
description: "Not found error",
|
|
50261
|
+
schema: "any"
|
|
50262
|
+
}
|
|
50263
|
+
}
|
|
50264
|
+
},
|
|
50265
|
+
{
|
|
50266
|
+
path: "/v2/alerts/definitions",
|
|
50267
|
+
method: "GET",
|
|
50268
|
+
summary: "List Alert Definitions",
|
|
50269
|
+
tags: [
|
|
50270
|
+
"AlertDefinitions"
|
|
50271
|
+
],
|
|
50272
|
+
parameters: [
|
|
50273
|
+
{
|
|
50274
|
+
name: "type",
|
|
50275
|
+
"in": "query",
|
|
50276
|
+
type: "string",
|
|
50277
|
+
required: false,
|
|
50278
|
+
description: "Filter by type (personal/company)"
|
|
50279
|
+
},
|
|
50280
|
+
{
|
|
50281
|
+
name: "alert_group_id",
|
|
50282
|
+
"in": "query",
|
|
50283
|
+
type: "string",
|
|
50284
|
+
required: false,
|
|
50285
|
+
description: "Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"
|
|
50286
|
+
},
|
|
50287
|
+
{
|
|
50288
|
+
name: "search",
|
|
50289
|
+
"in": "query",
|
|
50290
|
+
type: "string",
|
|
50291
|
+
required: false,
|
|
50292
|
+
description: "Search by name"
|
|
50293
|
+
},
|
|
50294
|
+
{
|
|
50295
|
+
name: "segment",
|
|
50296
|
+
"in": "query",
|
|
50297
|
+
type: "string",
|
|
50298
|
+
required: false,
|
|
50299
|
+
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."
|
|
50300
|
+
},
|
|
50301
|
+
{
|
|
50302
|
+
name: "page",
|
|
50303
|
+
"in": "query",
|
|
50304
|
+
type: "integer",
|
|
50305
|
+
required: false,
|
|
50306
|
+
description: "Page number"
|
|
50307
|
+
},
|
|
50308
|
+
{
|
|
50309
|
+
name: "per_page",
|
|
50310
|
+
"in": "query",
|
|
50311
|
+
type: "integer",
|
|
50312
|
+
required: false,
|
|
50313
|
+
description: "Items per page"
|
|
50314
|
+
}
|
|
50315
|
+
],
|
|
50316
|
+
responses: {
|
|
50317
|
+
"200": {
|
|
50318
|
+
description: "List of alert definitions",
|
|
50319
|
+
schema: "any"
|
|
50320
|
+
},
|
|
50321
|
+
"401": {
|
|
50322
|
+
description: "Authentication error",
|
|
50323
|
+
schema: "any"
|
|
50324
|
+
},
|
|
50325
|
+
"403": {
|
|
50326
|
+
description: "Authorization error",
|
|
50327
|
+
schema: "any"
|
|
50328
|
+
},
|
|
50329
|
+
"404": {
|
|
50330
|
+
description: "Not found error",
|
|
50331
|
+
schema: "any"
|
|
50332
|
+
}
|
|
50333
|
+
}
|
|
50334
|
+
},
|
|
50335
|
+
{
|
|
50336
|
+
path: "/v2/alerts/definitions",
|
|
50337
|
+
method: "POST",
|
|
50338
|
+
summary: "Create Alert Definition",
|
|
50339
|
+
tags: [
|
|
50340
|
+
"AlertDefinitions"
|
|
50341
|
+
],
|
|
50342
|
+
parameters: [
|
|
50343
|
+
],
|
|
50344
|
+
requestBody: {
|
|
50345
|
+
contentType: "application/json",
|
|
50346
|
+
schema: "any",
|
|
50347
|
+
required: true
|
|
50348
|
+
},
|
|
50349
|
+
responses: {
|
|
50350
|
+
"200": {
|
|
50351
|
+
description: "Created alert definition",
|
|
50352
|
+
schema: "any"
|
|
50353
|
+
},
|
|
50354
|
+
"401": {
|
|
50355
|
+
description: "Authentication error",
|
|
50356
|
+
schema: "any"
|
|
50357
|
+
},
|
|
50358
|
+
"403": {
|
|
50359
|
+
description: "Authorization error",
|
|
50360
|
+
schema: "any"
|
|
50361
|
+
},
|
|
50362
|
+
"404": {
|
|
50363
|
+
description: "Not found error",
|
|
50364
|
+
schema: "any"
|
|
50365
|
+
}
|
|
50366
|
+
}
|
|
50367
|
+
},
|
|
48762
50368
|
{
|
|
48763
|
-
path: "v2/
|
|
50369
|
+
path: "/v2/alerts/definitions/{id}",
|
|
48764
50370
|
method: "GET",
|
|
48765
|
-
summary: "
|
|
50371
|
+
summary: "Get Alert Definition",
|
|
48766
50372
|
tags: [
|
|
48767
|
-
"
|
|
50373
|
+
"AlertDefinitions"
|
|
48768
50374
|
],
|
|
48769
50375
|
parameters: [
|
|
48770
50376
|
{
|
|
48771
|
-
name: "
|
|
48772
|
-
"in": "
|
|
48773
|
-
type: "
|
|
50377
|
+
name: "id",
|
|
50378
|
+
"in": "path",
|
|
50379
|
+
type: "integer",
|
|
48774
50380
|
required: true,
|
|
48775
|
-
description: "
|
|
50381
|
+
description: ""
|
|
48776
50382
|
}
|
|
48777
50383
|
],
|
|
48778
50384
|
responses: {
|
|
48779
50385
|
"200": {
|
|
48780
|
-
description: "
|
|
50386
|
+
description: "Alert definition details",
|
|
48781
50387
|
schema: "any"
|
|
48782
50388
|
},
|
|
48783
50389
|
"401": {
|
|
@@ -48795,53 +50401,140 @@ var clientsData = [
|
|
|
48795
50401
|
}
|
|
48796
50402
|
},
|
|
48797
50403
|
{
|
|
48798
|
-
path: "v2/
|
|
48799
|
-
method: "
|
|
48800
|
-
summary: "
|
|
50404
|
+
path: "/v2/alerts/definitions/{id}",
|
|
50405
|
+
method: "PATCH",
|
|
50406
|
+
summary: "Update Alert Definition",
|
|
48801
50407
|
tags: [
|
|
48802
|
-
"
|
|
50408
|
+
"AlertDefinitions"
|
|
48803
50409
|
],
|
|
48804
50410
|
parameters: [
|
|
48805
50411
|
{
|
|
48806
|
-
name: "
|
|
48807
|
-
"in": "
|
|
48808
|
-
type: "
|
|
50412
|
+
name: "id",
|
|
50413
|
+
"in": "path",
|
|
50414
|
+
type: "integer",
|
|
48809
50415
|
required: true,
|
|
48810
|
-
description: "
|
|
50416
|
+
description: ""
|
|
50417
|
+
}
|
|
50418
|
+
],
|
|
50419
|
+
requestBody: {
|
|
50420
|
+
contentType: "application/json",
|
|
50421
|
+
schema: "any",
|
|
50422
|
+
required: true
|
|
50423
|
+
},
|
|
50424
|
+
responses: {
|
|
50425
|
+
"200": {
|
|
50426
|
+
description: "Updated alert definition",
|
|
50427
|
+
schema: "any"
|
|
48811
50428
|
},
|
|
48812
|
-
{
|
|
48813
|
-
|
|
48814
|
-
|
|
48815
|
-
|
|
48816
|
-
|
|
48817
|
-
description: "
|
|
50429
|
+
"401": {
|
|
50430
|
+
description: "Authentication error",
|
|
50431
|
+
schema: "any"
|
|
50432
|
+
},
|
|
50433
|
+
"403": {
|
|
50434
|
+
description: "Authorization error",
|
|
50435
|
+
schema: "any"
|
|
48818
50436
|
},
|
|
50437
|
+
"404": {
|
|
50438
|
+
description: "Not found error",
|
|
50439
|
+
schema: "any"
|
|
50440
|
+
}
|
|
50441
|
+
}
|
|
50442
|
+
},
|
|
50443
|
+
{
|
|
50444
|
+
path: "/v2/alerts/definitions/{id}",
|
|
50445
|
+
method: "DELETE",
|
|
50446
|
+
summary: "Delete Alert Definition",
|
|
50447
|
+
tags: [
|
|
50448
|
+
"AlertDefinitions"
|
|
50449
|
+
],
|
|
50450
|
+
parameters: [
|
|
48819
50451
|
{
|
|
48820
|
-
name: "
|
|
48821
|
-
"in": "
|
|
50452
|
+
name: "id",
|
|
50453
|
+
"in": "path",
|
|
48822
50454
|
type: "integer",
|
|
48823
|
-
required:
|
|
48824
|
-
description: "
|
|
50455
|
+
required: true,
|
|
50456
|
+
description: ""
|
|
50457
|
+
}
|
|
50458
|
+
],
|
|
50459
|
+
responses: {
|
|
50460
|
+
"200": {
|
|
50461
|
+
description: "Deleted"
|
|
50462
|
+
},
|
|
50463
|
+
"401": {
|
|
50464
|
+
description: "Authentication error",
|
|
50465
|
+
schema: "any"
|
|
48825
50466
|
},
|
|
50467
|
+
"403": {
|
|
50468
|
+
description: "Authorization error",
|
|
50469
|
+
schema: "any"
|
|
50470
|
+
},
|
|
50471
|
+
"404": {
|
|
50472
|
+
description: "Not found error",
|
|
50473
|
+
schema: "any"
|
|
50474
|
+
}
|
|
50475
|
+
}
|
|
50476
|
+
},
|
|
50477
|
+
{
|
|
50478
|
+
path: "/v2/alerts/definitions/{id}/subscribe",
|
|
50479
|
+
method: "POST",
|
|
50480
|
+
summary: "Subscribe to Alert Definition",
|
|
50481
|
+
tags: [
|
|
50482
|
+
"AlertDefinitions"
|
|
50483
|
+
],
|
|
50484
|
+
parameters: [
|
|
48826
50485
|
{
|
|
48827
|
-
name: "
|
|
48828
|
-
"in": "
|
|
50486
|
+
name: "id",
|
|
50487
|
+
"in": "path",
|
|
48829
50488
|
type: "integer",
|
|
48830
|
-
required:
|
|
48831
|
-
description: "
|
|
50489
|
+
required: true,
|
|
50490
|
+
description: ""
|
|
50491
|
+
}
|
|
50492
|
+
],
|
|
50493
|
+
requestBody: {
|
|
50494
|
+
contentType: "application/json",
|
|
50495
|
+
schema: "any",
|
|
50496
|
+
required: false
|
|
50497
|
+
},
|
|
50498
|
+
responses: {
|
|
50499
|
+
"200": {
|
|
50500
|
+
description: "Subscription created; activates an inactive definition"
|
|
50501
|
+
},
|
|
50502
|
+
"401": {
|
|
50503
|
+
description: "Authentication error",
|
|
50504
|
+
schema: "any"
|
|
50505
|
+
},
|
|
50506
|
+
"403": {
|
|
50507
|
+
description: "Authorization error",
|
|
50508
|
+
schema: "any"
|
|
50509
|
+
},
|
|
50510
|
+
"404": {
|
|
50511
|
+
description: "Not found error",
|
|
50512
|
+
schema: "any"
|
|
48832
50513
|
},
|
|
50514
|
+
"409": {
|
|
50515
|
+
description: "Subscription already exists"
|
|
50516
|
+
}
|
|
50517
|
+
}
|
|
50518
|
+
},
|
|
50519
|
+
{
|
|
50520
|
+
path: "/v2/alerts/definitions/{id}/unsubscribe",
|
|
50521
|
+
method: "POST",
|
|
50522
|
+
summary: "Unsubscribe from Alert Definition",
|
|
50523
|
+
tags: [
|
|
50524
|
+
"AlertDefinitions"
|
|
50525
|
+
],
|
|
50526
|
+
parameters: [
|
|
48833
50527
|
{
|
|
48834
|
-
name: "
|
|
48835
|
-
"in": "
|
|
50528
|
+
name: "id",
|
|
50529
|
+
"in": "path",
|
|
48836
50530
|
type: "integer",
|
|
48837
|
-
required:
|
|
48838
|
-
description: "
|
|
50531
|
+
required: true,
|
|
50532
|
+
description: ""
|
|
48839
50533
|
}
|
|
48840
50534
|
],
|
|
48841
50535
|
responses: {
|
|
48842
50536
|
"200": {
|
|
48843
|
-
description: "
|
|
48844
|
-
schema: "any"
|
|
50537
|
+
description: "Unsubscribed; deactivates a personal definition left without subscriptions"
|
|
48845
50538
|
},
|
|
48846
50539
|
"401": {
|
|
48847
50540
|
description: "Authentication error",
|
|
@@ -48858,22 +50551,15 @@ var clientsData = [
|
|
|
48858
50551
|
}
|
|
48859
50552
|
}
|
|
48860
50553
|
],
|
|
48861
|
-
|
|
50554
|
+
AlertGroups: [
|
|
48862
50555
|
{
|
|
48863
|
-
path: "/v2/
|
|
50556
|
+
path: "/v2/alert_groups",
|
|
48864
50557
|
method: "GET",
|
|
48865
|
-
summary: "List Alert
|
|
50558
|
+
summary: "List Alert Groups",
|
|
48866
50559
|
tags: [
|
|
48867
|
-
"
|
|
50560
|
+
"AlertGroups"
|
|
48868
50561
|
],
|
|
48869
50562
|
parameters: [
|
|
48870
|
-
{
|
|
48871
|
-
name: "type",
|
|
48872
|
-
"in": "query",
|
|
48873
|
-
type: "string",
|
|
48874
|
-
required: false,
|
|
48875
|
-
description: "Filter by type (personal/company)"
|
|
48876
|
-
},
|
|
48877
50563
|
{
|
|
48878
50564
|
name: "search",
|
|
48879
50565
|
"in": "query",
|
|
@@ -48898,7 +50584,7 @@ var clientsData = [
|
|
|
48898
50584
|
],
|
|
48899
50585
|
responses: {
|
|
48900
50586
|
"200": {
|
|
48901
|
-
description: "List of alert
|
|
50587
|
+
description: "List of alert groups",
|
|
48902
50588
|
schema: "any"
|
|
48903
50589
|
},
|
|
48904
50590
|
"401": {
|
|
@@ -48916,11 +50602,11 @@ var clientsData = [
|
|
|
48916
50602
|
}
|
|
48917
50603
|
},
|
|
48918
50604
|
{
|
|
48919
|
-
path: "/v2/
|
|
50605
|
+
path: "/v2/alert_groups",
|
|
48920
50606
|
method: "POST",
|
|
48921
|
-
summary: "Create Alert
|
|
50607
|
+
summary: "Create Alert Group",
|
|
48922
50608
|
tags: [
|
|
48923
|
-
"
|
|
50609
|
+
"AlertGroups"
|
|
48924
50610
|
],
|
|
48925
50611
|
parameters: [
|
|
48926
50612
|
],
|
|
@@ -48931,7 +50617,7 @@ var clientsData = [
|
|
|
48931
50617
|
},
|
|
48932
50618
|
responses: {
|
|
48933
50619
|
"200": {
|
|
48934
|
-
description: "Created alert
|
|
50620
|
+
description: "Created alert group",
|
|
48935
50621
|
schema: "any"
|
|
48936
50622
|
},
|
|
48937
50623
|
"401": {
|
|
@@ -48949,15 +50635,15 @@ var clientsData = [
|
|
|
48949
50635
|
}
|
|
48950
50636
|
},
|
|
48951
50637
|
{
|
|
48952
|
-
path: "/v2/
|
|
50638
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
48953
50639
|
method: "GET",
|
|
48954
|
-
summary: "
|
|
50640
|
+
summary: "List Group Assets",
|
|
48955
50641
|
tags: [
|
|
48956
|
-
"
|
|
50642
|
+
"AlertGroups"
|
|
48957
50643
|
],
|
|
48958
50644
|
parameters: [
|
|
48959
50645
|
{
|
|
48960
|
-
name: "
|
|
50646
|
+
name: "alert_group_id",
|
|
48961
50647
|
"in": "path",
|
|
48962
50648
|
type: "integer",
|
|
48963
50649
|
required: true,
|
|
@@ -48966,7 +50652,7 @@ var clientsData = [
|
|
|
48966
50652
|
],
|
|
48967
50653
|
responses: {
|
|
48968
50654
|
"200": {
|
|
48969
|
-
description: "
|
|
50655
|
+
description: "List of group assets",
|
|
48970
50656
|
schema: "any"
|
|
48971
50657
|
},
|
|
48972
50658
|
"401": {
|
|
@@ -48984,15 +50670,15 @@ var clientsData = [
|
|
|
48984
50670
|
}
|
|
48985
50671
|
},
|
|
48986
50672
|
{
|
|
48987
|
-
path: "/v2/
|
|
48988
|
-
method: "
|
|
48989
|
-
summary: "
|
|
50673
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets",
|
|
50674
|
+
method: "POST",
|
|
50675
|
+
summary: "Add Asset to Group",
|
|
48990
50676
|
tags: [
|
|
48991
|
-
"
|
|
50677
|
+
"AlertGroups"
|
|
48992
50678
|
],
|
|
48993
50679
|
parameters: [
|
|
48994
50680
|
{
|
|
48995
|
-
name: "
|
|
50681
|
+
name: "alert_group_id",
|
|
48996
50682
|
"in": "path",
|
|
48997
50683
|
type: "integer",
|
|
48998
50684
|
required: true,
|
|
@@ -49006,7 +50692,7 @@ var clientsData = [
|
|
|
49006
50692
|
},
|
|
49007
50693
|
responses: {
|
|
49008
50694
|
"200": {
|
|
49009
|
-
description: "
|
|
50695
|
+
description: "Added asset",
|
|
49010
50696
|
schema: "any"
|
|
49011
50697
|
},
|
|
49012
50698
|
"401": {
|
|
@@ -49024,13 +50710,20 @@ var clientsData = [
|
|
|
49024
50710
|
}
|
|
49025
50711
|
},
|
|
49026
50712
|
{
|
|
49027
|
-
path: "/v2/
|
|
50713
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/{id}",
|
|
49028
50714
|
method: "DELETE",
|
|
49029
|
-
summary: "
|
|
50715
|
+
summary: "Remove Asset from Group",
|
|
49030
50716
|
tags: [
|
|
49031
|
-
"
|
|
50717
|
+
"AlertGroups"
|
|
49032
50718
|
],
|
|
49033
50719
|
parameters: [
|
|
50720
|
+
{
|
|
50721
|
+
name: "alert_group_id",
|
|
50722
|
+
"in": "path",
|
|
50723
|
+
type: "integer",
|
|
50724
|
+
required: true,
|
|
50725
|
+
description: ""
|
|
50726
|
+
},
|
|
49034
50727
|
{
|
|
49035
50728
|
name: "id",
|
|
49036
50729
|
"in": "path",
|
|
@@ -49041,7 +50734,7 @@ var clientsData = [
|
|
|
49041
50734
|
],
|
|
49042
50735
|
responses: {
|
|
49043
50736
|
"200": {
|
|
49044
|
-
description: "
|
|
50737
|
+
description: "Removed"
|
|
49045
50738
|
},
|
|
49046
50739
|
"401": {
|
|
49047
50740
|
description: "Authentication error",
|
|
@@ -49056,42 +50749,196 @@ var clientsData = [
|
|
|
49056
50749
|
schema: "any"
|
|
49057
50750
|
}
|
|
49058
50751
|
}
|
|
49059
|
-
}
|
|
49060
|
-
],
|
|
49061
|
-
AlertGroups: [
|
|
50752
|
+
},
|
|
49062
50753
|
{
|
|
49063
|
-
path: "/v2/alert_groups",
|
|
50754
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_create",
|
|
50755
|
+
method: "POST",
|
|
50756
|
+
summary: "Bulk Add Assets to Group",
|
|
50757
|
+
tags: [
|
|
50758
|
+
"AlertGroups"
|
|
50759
|
+
],
|
|
50760
|
+
parameters: [
|
|
50761
|
+
{
|
|
50762
|
+
name: "alert_group_id",
|
|
50763
|
+
"in": "path",
|
|
50764
|
+
type: "integer",
|
|
50765
|
+
required: true,
|
|
50766
|
+
description: ""
|
|
50767
|
+
}
|
|
50768
|
+
],
|
|
50769
|
+
requestBody: {
|
|
50770
|
+
contentType: "application/json",
|
|
50771
|
+
schema: "any",
|
|
50772
|
+
required: true
|
|
50773
|
+
},
|
|
50774
|
+
responses: {
|
|
50775
|
+
"200": {
|
|
50776
|
+
description: "Assets added (idempotent — assets already in the group are skipped)",
|
|
50777
|
+
schema: "any"
|
|
50778
|
+
},
|
|
50779
|
+
"400": {
|
|
50780
|
+
description: "Validation error; no assets were added"
|
|
50781
|
+
},
|
|
50782
|
+
"401": {
|
|
50783
|
+
description: "Authentication error",
|
|
50784
|
+
schema: "any"
|
|
50785
|
+
},
|
|
50786
|
+
"403": {
|
|
50787
|
+
description: "Authorization error",
|
|
50788
|
+
schema: "any"
|
|
50789
|
+
},
|
|
50790
|
+
"404": {
|
|
50791
|
+
description: "Not found error",
|
|
50792
|
+
schema: "any"
|
|
50793
|
+
}
|
|
50794
|
+
}
|
|
50795
|
+
},
|
|
50796
|
+
{
|
|
50797
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_assets/bulk_destroy",
|
|
50798
|
+
method: "DELETE",
|
|
50799
|
+
summary: "Bulk Remove Assets from Group",
|
|
50800
|
+
tags: [
|
|
50801
|
+
"AlertGroups"
|
|
50802
|
+
],
|
|
50803
|
+
parameters: [
|
|
50804
|
+
{
|
|
50805
|
+
name: "alert_group_id",
|
|
50806
|
+
"in": "path",
|
|
50807
|
+
type: "integer",
|
|
50808
|
+
required: true,
|
|
50809
|
+
description: ""
|
|
50810
|
+
}
|
|
50811
|
+
],
|
|
50812
|
+
requestBody: {
|
|
50813
|
+
contentType: "application/json",
|
|
50814
|
+
schema: "any",
|
|
50815
|
+
required: true
|
|
50816
|
+
},
|
|
50817
|
+
responses: {
|
|
50818
|
+
"200": {
|
|
50819
|
+
description: "Assets removed",
|
|
50820
|
+
schema: "any"
|
|
50821
|
+
},
|
|
50822
|
+
"401": {
|
|
50823
|
+
description: "Authentication error",
|
|
50824
|
+
schema: "any"
|
|
50825
|
+
},
|
|
50826
|
+
"403": {
|
|
50827
|
+
description: "Authorization error",
|
|
50828
|
+
schema: "any"
|
|
50829
|
+
},
|
|
50830
|
+
"404": {
|
|
50831
|
+
description: "Not found error",
|
|
50832
|
+
schema: "any"
|
|
50833
|
+
}
|
|
50834
|
+
}
|
|
50835
|
+
},
|
|
50836
|
+
{
|
|
50837
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
49064
50838
|
method: "GET",
|
|
49065
|
-
summary: "List
|
|
50839
|
+
summary: "List Group Configurations",
|
|
49066
50840
|
tags: [
|
|
49067
50841
|
"AlertGroups"
|
|
49068
50842
|
],
|
|
49069
50843
|
parameters: [
|
|
49070
50844
|
{
|
|
49071
|
-
name: "
|
|
49072
|
-
"in": "
|
|
49073
|
-
type: "
|
|
49074
|
-
required:
|
|
49075
|
-
description: "
|
|
50845
|
+
name: "alert_group_id",
|
|
50846
|
+
"in": "path",
|
|
50847
|
+
type: "integer",
|
|
50848
|
+
required: true,
|
|
50849
|
+
description: ""
|
|
50850
|
+
}
|
|
50851
|
+
],
|
|
50852
|
+
responses: {
|
|
50853
|
+
"200": {
|
|
50854
|
+
description: "List of configurations",
|
|
50855
|
+
schema: "any"
|
|
50856
|
+
},
|
|
50857
|
+
"401": {
|
|
50858
|
+
description: "Authentication error",
|
|
50859
|
+
schema: "any"
|
|
50860
|
+
},
|
|
50861
|
+
"403": {
|
|
50862
|
+
description: "Authorization error",
|
|
50863
|
+
schema: "any"
|
|
49076
50864
|
},
|
|
50865
|
+
"404": {
|
|
50866
|
+
description: "Not found error",
|
|
50867
|
+
schema: "any"
|
|
50868
|
+
}
|
|
50869
|
+
}
|
|
50870
|
+
},
|
|
50871
|
+
{
|
|
50872
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations",
|
|
50873
|
+
method: "POST",
|
|
50874
|
+
summary: "Create Group Configuration",
|
|
50875
|
+
tags: [
|
|
50876
|
+
"AlertGroups"
|
|
50877
|
+
],
|
|
50878
|
+
parameters: [
|
|
49077
50879
|
{
|
|
49078
|
-
name: "
|
|
49079
|
-
"in": "
|
|
50880
|
+
name: "alert_group_id",
|
|
50881
|
+
"in": "path",
|
|
49080
50882
|
type: "integer",
|
|
49081
|
-
required:
|
|
49082
|
-
description: "
|
|
50883
|
+
required: true,
|
|
50884
|
+
description: ""
|
|
50885
|
+
}
|
|
50886
|
+
],
|
|
50887
|
+
requestBody: {
|
|
50888
|
+
contentType: "application/json",
|
|
50889
|
+
schema: "any",
|
|
50890
|
+
required: true
|
|
50891
|
+
},
|
|
50892
|
+
responses: {
|
|
50893
|
+
"200": {
|
|
50894
|
+
description: "Created configuration",
|
|
50895
|
+
schema: "any"
|
|
50896
|
+
},
|
|
50897
|
+
"401": {
|
|
50898
|
+
description: "Authentication error",
|
|
50899
|
+
schema: "any"
|
|
50900
|
+
},
|
|
50901
|
+
"403": {
|
|
50902
|
+
description: "Authorization error",
|
|
50903
|
+
schema: "any"
|
|
50904
|
+
},
|
|
50905
|
+
"404": {
|
|
50906
|
+
description: "Not found error",
|
|
50907
|
+
schema: "any"
|
|
50908
|
+
}
|
|
50909
|
+
}
|
|
50910
|
+
},
|
|
50911
|
+
{
|
|
50912
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
50913
|
+
method: "PATCH",
|
|
50914
|
+
summary: "Update Group Configuration",
|
|
50915
|
+
tags: [
|
|
50916
|
+
"AlertGroups"
|
|
50917
|
+
],
|
|
50918
|
+
parameters: [
|
|
50919
|
+
{
|
|
50920
|
+
name: "alert_group_id",
|
|
50921
|
+
"in": "path",
|
|
50922
|
+
type: "integer",
|
|
50923
|
+
required: true,
|
|
50924
|
+
description: ""
|
|
49083
50925
|
},
|
|
49084
50926
|
{
|
|
49085
|
-
name: "
|
|
49086
|
-
"in": "
|
|
50927
|
+
name: "id",
|
|
50928
|
+
"in": "path",
|
|
49087
50929
|
type: "integer",
|
|
49088
|
-
required:
|
|
49089
|
-
description: "
|
|
50930
|
+
required: true,
|
|
50931
|
+
description: ""
|
|
49090
50932
|
}
|
|
49091
50933
|
],
|
|
50934
|
+
requestBody: {
|
|
50935
|
+
contentType: "application/json",
|
|
50936
|
+
schema: "any",
|
|
50937
|
+
required: true
|
|
50938
|
+
},
|
|
49092
50939
|
responses: {
|
|
49093
50940
|
"200": {
|
|
49094
|
-
description: "
|
|
50941
|
+
description: "Updated configuration",
|
|
49095
50942
|
schema: "any"
|
|
49096
50943
|
},
|
|
49097
50944
|
"401": {
|
|
@@ -49109,13 +50956,61 @@ var clientsData = [
|
|
|
49109
50956
|
}
|
|
49110
50957
|
},
|
|
49111
50958
|
{
|
|
49112
|
-
path: "/v2/alert_groups",
|
|
50959
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",
|
|
50960
|
+
method: "DELETE",
|
|
50961
|
+
summary: "Delete Group Configuration",
|
|
50962
|
+
tags: [
|
|
50963
|
+
"AlertGroups"
|
|
50964
|
+
],
|
|
50965
|
+
parameters: [
|
|
50966
|
+
{
|
|
50967
|
+
name: "alert_group_id",
|
|
50968
|
+
"in": "path",
|
|
50969
|
+
type: "integer",
|
|
50970
|
+
required: true,
|
|
50971
|
+
description: ""
|
|
50972
|
+
},
|
|
50973
|
+
{
|
|
50974
|
+
name: "id",
|
|
50975
|
+
"in": "path",
|
|
50976
|
+
type: "integer",
|
|
50977
|
+
required: true,
|
|
50978
|
+
description: ""
|
|
50979
|
+
}
|
|
50980
|
+
],
|
|
50981
|
+
responses: {
|
|
50982
|
+
"200": {
|
|
50983
|
+
description: "Deleted"
|
|
50984
|
+
},
|
|
50985
|
+
"401": {
|
|
50986
|
+
description: "Authentication error",
|
|
50987
|
+
schema: "any"
|
|
50988
|
+
},
|
|
50989
|
+
"403": {
|
|
50990
|
+
description: "Authorization error",
|
|
50991
|
+
schema: "any"
|
|
50992
|
+
},
|
|
50993
|
+
"404": {
|
|
50994
|
+
description: "Not found error",
|
|
50995
|
+
schema: "any"
|
|
50996
|
+
}
|
|
50997
|
+
}
|
|
50998
|
+
},
|
|
50999
|
+
{
|
|
51000
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",
|
|
49113
51001
|
method: "POST",
|
|
49114
|
-
summary: "Create
|
|
51002
|
+
summary: "Bulk Create Group Configurations",
|
|
49115
51003
|
tags: [
|
|
49116
51004
|
"AlertGroups"
|
|
49117
51005
|
],
|
|
49118
51006
|
parameters: [
|
|
51007
|
+
{
|
|
51008
|
+
name: "alert_group_id",
|
|
51009
|
+
"in": "path",
|
|
51010
|
+
type: "integer",
|
|
51011
|
+
required: true,
|
|
51012
|
+
description: ""
|
|
51013
|
+
}
|
|
49119
51014
|
],
|
|
49120
51015
|
requestBody: {
|
|
49121
51016
|
contentType: "application/json",
|
|
@@ -49124,9 +51019,12 @@ var clientsData = [
|
|
|
49124
51019
|
},
|
|
49125
51020
|
responses: {
|
|
49126
51021
|
"200": {
|
|
49127
|
-
description: "
|
|
51022
|
+
description: "Configurations created (all-or-nothing — none created if any is invalid)",
|
|
49128
51023
|
schema: "any"
|
|
49129
51024
|
},
|
|
51025
|
+
"400": {
|
|
51026
|
+
description: "Validation error; no configurations were created"
|
|
51027
|
+
},
|
|
49130
51028
|
"401": {
|
|
49131
51029
|
description: "Authentication error",
|
|
49132
51030
|
schema: "any"
|
|
@@ -49142,9 +51040,49 @@ var clientsData = [
|
|
|
49142
51040
|
}
|
|
49143
51041
|
},
|
|
49144
51042
|
{
|
|
49145
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
51043
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",
|
|
51044
|
+
method: "DELETE",
|
|
51045
|
+
summary: "Bulk Delete Group Configurations",
|
|
51046
|
+
tags: [
|
|
51047
|
+
"AlertGroups"
|
|
51048
|
+
],
|
|
51049
|
+
parameters: [
|
|
51050
|
+
{
|
|
51051
|
+
name: "alert_group_id",
|
|
51052
|
+
"in": "path",
|
|
51053
|
+
type: "integer",
|
|
51054
|
+
required: true,
|
|
51055
|
+
description: ""
|
|
51056
|
+
}
|
|
51057
|
+
],
|
|
51058
|
+
requestBody: {
|
|
51059
|
+
contentType: "application/json",
|
|
51060
|
+
schema: "any",
|
|
51061
|
+
required: true
|
|
51062
|
+
},
|
|
51063
|
+
responses: {
|
|
51064
|
+
"200": {
|
|
51065
|
+
description: "Configurations removed",
|
|
51066
|
+
schema: "any"
|
|
51067
|
+
},
|
|
51068
|
+
"401": {
|
|
51069
|
+
description: "Authentication error",
|
|
51070
|
+
schema: "any"
|
|
51071
|
+
},
|
|
51072
|
+
"403": {
|
|
51073
|
+
description: "Authorization error",
|
|
51074
|
+
schema: "any"
|
|
51075
|
+
},
|
|
51076
|
+
"404": {
|
|
51077
|
+
description: "Not found error",
|
|
51078
|
+
schema: "any"
|
|
51079
|
+
}
|
|
51080
|
+
}
|
|
51081
|
+
},
|
|
51082
|
+
{
|
|
51083
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
49146
51084
|
method: "GET",
|
|
49147
|
-
summary: "List Group
|
|
51085
|
+
summary: "List Group Members",
|
|
49148
51086
|
tags: [
|
|
49149
51087
|
"AlertGroups"
|
|
49150
51088
|
],
|
|
@@ -49159,7 +51097,7 @@ var clientsData = [
|
|
|
49159
51097
|
],
|
|
49160
51098
|
responses: {
|
|
49161
51099
|
"200": {
|
|
49162
|
-
description: "List of group
|
|
51100
|
+
description: "List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",
|
|
49163
51101
|
schema: "any"
|
|
49164
51102
|
},
|
|
49165
51103
|
"401": {
|
|
@@ -49177,9 +51115,9 @@ var clientsData = [
|
|
|
49177
51115
|
}
|
|
49178
51116
|
},
|
|
49179
51117
|
{
|
|
49180
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
51118
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users",
|
|
49181
51119
|
method: "POST",
|
|
49182
|
-
summary: "Add
|
|
51120
|
+
summary: "Add Member to Group",
|
|
49183
51121
|
tags: [
|
|
49184
51122
|
"AlertGroups"
|
|
49185
51123
|
],
|
|
@@ -49199,7 +51137,7 @@ var clientsData = [
|
|
|
49199
51137
|
},
|
|
49200
51138
|
responses: {
|
|
49201
51139
|
"200": {
|
|
49202
|
-
description: "Added
|
|
51140
|
+
description: "Added member",
|
|
49203
51141
|
schema: "any"
|
|
49204
51142
|
},
|
|
49205
51143
|
"401": {
|
|
@@ -49217,9 +51155,9 @@ var clientsData = [
|
|
|
49217
51155
|
}
|
|
49218
51156
|
},
|
|
49219
51157
|
{
|
|
49220
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
51158
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",
|
|
49221
51159
|
method: "DELETE",
|
|
49222
|
-
summary: "Remove
|
|
51160
|
+
summary: "Remove Member from Group",
|
|
49223
51161
|
tags: [
|
|
49224
51162
|
"AlertGroups"
|
|
49225
51163
|
],
|
|
@@ -49258,9 +51196,9 @@ var clientsData = [
|
|
|
49258
51196
|
}
|
|
49259
51197
|
},
|
|
49260
51198
|
{
|
|
49261
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
49262
|
-
method: "
|
|
49263
|
-
summary: "
|
|
51199
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",
|
|
51200
|
+
method: "POST",
|
|
51201
|
+
summary: "Bulk Add Members to Group",
|
|
49264
51202
|
tags: [
|
|
49265
51203
|
"AlertGroups"
|
|
49266
51204
|
],
|
|
@@ -49273,11 +51211,19 @@ var clientsData = [
|
|
|
49273
51211
|
description: ""
|
|
49274
51212
|
}
|
|
49275
51213
|
],
|
|
51214
|
+
requestBody: {
|
|
51215
|
+
contentType: "application/json",
|
|
51216
|
+
schema: "any",
|
|
51217
|
+
required: true
|
|
51218
|
+
},
|
|
49276
51219
|
responses: {
|
|
49277
51220
|
"200": {
|
|
49278
|
-
description: "
|
|
51221
|
+
description: "Members added (idempotent — users already in the group are skipped)",
|
|
49279
51222
|
schema: "any"
|
|
49280
51223
|
},
|
|
51224
|
+
"400": {
|
|
51225
|
+
description: "Validation error; no members were added"
|
|
51226
|
+
},
|
|
49281
51227
|
"401": {
|
|
49282
51228
|
description: "Authentication error",
|
|
49283
51229
|
schema: "any"
|
|
@@ -49293,9 +51239,9 @@ var clientsData = [
|
|
|
49293
51239
|
}
|
|
49294
51240
|
},
|
|
49295
51241
|
{
|
|
49296
|
-
path: "/v2/alert_groups/{alert_group_id}/
|
|
49297
|
-
method: "
|
|
49298
|
-
summary: "
|
|
51242
|
+
path: "/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",
|
|
51243
|
+
method: "DELETE",
|
|
51244
|
+
summary: "Bulk Remove Members from Group",
|
|
49299
51245
|
tags: [
|
|
49300
51246
|
"AlertGroups"
|
|
49301
51247
|
],
|
|
@@ -49315,7 +51261,7 @@ var clientsData = [
|
|
|
49315
51261
|
},
|
|
49316
51262
|
responses: {
|
|
49317
51263
|
"200": {
|
|
49318
|
-
description: "
|
|
51264
|
+
description: "Members removed",
|
|
49319
51265
|
schema: "any"
|
|
49320
51266
|
},
|
|
49321
51267
|
"401": {
|
|
@@ -49333,20 +51279,48 @@ var clientsData = [
|
|
|
49333
51279
|
}
|
|
49334
51280
|
},
|
|
49335
51281
|
{
|
|
49336
|
-
path: "/v2/alert_groups/{
|
|
49337
|
-
method: "
|
|
49338
|
-
summary: "
|
|
51282
|
+
path: "/v2/alert_groups/{id}",
|
|
51283
|
+
method: "GET",
|
|
51284
|
+
summary: "Get Alert Group",
|
|
49339
51285
|
tags: [
|
|
49340
51286
|
"AlertGroups"
|
|
49341
51287
|
],
|
|
49342
51288
|
parameters: [
|
|
49343
51289
|
{
|
|
49344
|
-
name: "
|
|
51290
|
+
name: "id",
|
|
49345
51291
|
"in": "path",
|
|
49346
51292
|
type: "integer",
|
|
49347
51293
|
required: true,
|
|
49348
51294
|
description: ""
|
|
51295
|
+
}
|
|
51296
|
+
],
|
|
51297
|
+
responses: {
|
|
51298
|
+
"200": {
|
|
51299
|
+
description: "Alert group details",
|
|
51300
|
+
schema: "any"
|
|
51301
|
+
},
|
|
51302
|
+
"401": {
|
|
51303
|
+
description: "Authentication error",
|
|
51304
|
+
schema: "any"
|
|
51305
|
+
},
|
|
51306
|
+
"403": {
|
|
51307
|
+
description: "Authorization error",
|
|
51308
|
+
schema: "any"
|
|
49349
51309
|
},
|
|
51310
|
+
"404": {
|
|
51311
|
+
description: "Not found error",
|
|
51312
|
+
schema: "any"
|
|
51313
|
+
}
|
|
51314
|
+
}
|
|
51315
|
+
},
|
|
51316
|
+
{
|
|
51317
|
+
path: "/v2/alert_groups/{id}",
|
|
51318
|
+
method: "PATCH",
|
|
51319
|
+
summary: "Update Alert Group",
|
|
51320
|
+
tags: [
|
|
51321
|
+
"AlertGroups"
|
|
51322
|
+
],
|
|
51323
|
+
parameters: [
|
|
49350
51324
|
{
|
|
49351
51325
|
name: "id",
|
|
49352
51326
|
"in": "path",
|
|
@@ -49362,7 +51336,7 @@ var clientsData = [
|
|
|
49362
51336
|
},
|
|
49363
51337
|
responses: {
|
|
49364
51338
|
"200": {
|
|
49365
|
-
description: "Updated
|
|
51339
|
+
description: "Updated alert group",
|
|
49366
51340
|
schema: "any"
|
|
49367
51341
|
},
|
|
49368
51342
|
"401": {
|
|
@@ -49380,20 +51354,13 @@ var clientsData = [
|
|
|
49380
51354
|
}
|
|
49381
51355
|
},
|
|
49382
51356
|
{
|
|
49383
|
-
path: "/v2/alert_groups/{
|
|
51357
|
+
path: "/v2/alert_groups/{id}",
|
|
49384
51358
|
method: "DELETE",
|
|
49385
|
-
summary: "Delete Group
|
|
51359
|
+
summary: "Delete Alert Group",
|
|
49386
51360
|
tags: [
|
|
49387
51361
|
"AlertGroups"
|
|
49388
51362
|
],
|
|
49389
51363
|
parameters: [
|
|
49390
|
-
{
|
|
49391
|
-
name: "alert_group_id",
|
|
49392
|
-
"in": "path",
|
|
49393
|
-
type: "integer",
|
|
49394
|
-
required: true,
|
|
49395
|
-
description: ""
|
|
49396
|
-
},
|
|
49397
51364
|
{
|
|
49398
51365
|
name: "id",
|
|
49399
51366
|
"in": "path",
|
|
@@ -49419,26 +51386,29 @@ var clientsData = [
|
|
|
49419
51386
|
schema: "any"
|
|
49420
51387
|
}
|
|
49421
51388
|
}
|
|
49422
|
-
}
|
|
51389
|
+
}
|
|
51390
|
+
],
|
|
51391
|
+
AlertRBAC: [
|
|
49423
51392
|
{
|
|
49424
|
-
path: "/v2/
|
|
51393
|
+
path: "/v2/alert_abilities",
|
|
49425
51394
|
method: "GET",
|
|
49426
|
-
summary: "List
|
|
51395
|
+
summary: "List Assignable Alert Abilities",
|
|
51396
|
+
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.",
|
|
49427
51397
|
tags: [
|
|
49428
|
-
"
|
|
51398
|
+
"AlertRBAC"
|
|
49429
51399
|
],
|
|
49430
51400
|
parameters: [
|
|
49431
51401
|
{
|
|
49432
|
-
name: "
|
|
49433
|
-
"in": "
|
|
49434
|
-
type: "
|
|
49435
|
-
required:
|
|
49436
|
-
description: ""
|
|
51402
|
+
name: "locale",
|
|
51403
|
+
"in": "query",
|
|
51404
|
+
type: "string",
|
|
51405
|
+
required: false,
|
|
51406
|
+
description: "Display-name language; unknown/unsupported locales fall back to English"
|
|
49437
51407
|
}
|
|
49438
51408
|
],
|
|
49439
51409
|
responses: {
|
|
49440
51410
|
"200": {
|
|
49441
|
-
description: "
|
|
51411
|
+
description: "Ability catalog",
|
|
49442
51412
|
schema: "any"
|
|
49443
51413
|
},
|
|
49444
51414
|
"401": {
|
|
@@ -49456,29 +51426,25 @@ var clientsData = [
|
|
|
49456
51426
|
}
|
|
49457
51427
|
},
|
|
49458
51428
|
{
|
|
49459
|
-
path: "/v2/
|
|
51429
|
+
path: "/v2/companies/{company_id}/alert_rbac/disable",
|
|
49460
51430
|
method: "POST",
|
|
49461
|
-
summary: "
|
|
51431
|
+
summary: "Disable Alert RBAC",
|
|
51432
|
+
description: "Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",
|
|
49462
51433
|
tags: [
|
|
49463
|
-
"
|
|
51434
|
+
"AlertRBAC"
|
|
49464
51435
|
],
|
|
49465
51436
|
parameters: [
|
|
49466
51437
|
{
|
|
49467
|
-
name: "
|
|
51438
|
+
name: "company_id",
|
|
49468
51439
|
"in": "path",
|
|
49469
51440
|
type: "integer",
|
|
49470
51441
|
required: true,
|
|
49471
|
-
description: ""
|
|
51442
|
+
description: "Company ID"
|
|
49472
51443
|
}
|
|
49473
51444
|
],
|
|
49474
|
-
requestBody: {
|
|
49475
|
-
contentType: "application/json",
|
|
49476
|
-
schema: "any",
|
|
49477
|
-
required: true
|
|
49478
|
-
},
|
|
49479
51445
|
responses: {
|
|
49480
51446
|
"200": {
|
|
49481
|
-
description: "
|
|
51447
|
+
description: "RBAC disabled",
|
|
49482
51448
|
schema: "any"
|
|
49483
51449
|
},
|
|
49484
51450
|
"401": {
|
|
@@ -49486,8 +51452,7 @@ var clientsData = [
|
|
|
49486
51452
|
schema: "any"
|
|
49487
51453
|
},
|
|
49488
51454
|
"403": {
|
|
49489
|
-
description: "
|
|
49490
|
-
schema: "any"
|
|
51455
|
+
description: "Caller is not a company admin"
|
|
49491
51456
|
},
|
|
49492
51457
|
"404": {
|
|
49493
51458
|
description: "Not found error",
|
|
@@ -49496,40 +51461,128 @@ var clientsData = [
|
|
|
49496
51461
|
}
|
|
49497
51462
|
},
|
|
49498
51463
|
{
|
|
49499
|
-
path: "/v2/
|
|
49500
|
-
method: "
|
|
49501
|
-
summary: "
|
|
51464
|
+
path: "/v2/companies/{company_id}/alert_rbac/enable",
|
|
51465
|
+
method: "POST",
|
|
51466
|
+
summary: "Enable Alert RBAC",
|
|
51467
|
+
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.",
|
|
49502
51468
|
tags: [
|
|
49503
|
-
"
|
|
51469
|
+
"AlertRBAC"
|
|
49504
51470
|
],
|
|
49505
51471
|
parameters: [
|
|
49506
51472
|
{
|
|
49507
|
-
name: "
|
|
51473
|
+
name: "company_id",
|
|
49508
51474
|
"in": "path",
|
|
49509
51475
|
type: "integer",
|
|
49510
51476
|
required: true,
|
|
49511
|
-
description: ""
|
|
51477
|
+
description: "Company ID"
|
|
51478
|
+
}
|
|
51479
|
+
],
|
|
51480
|
+
responses: {
|
|
51481
|
+
"200": {
|
|
51482
|
+
description: "RBAC enabled",
|
|
51483
|
+
schema: "any"
|
|
51484
|
+
},
|
|
51485
|
+
"401": {
|
|
51486
|
+
description: "Authentication error",
|
|
51487
|
+
schema: "any"
|
|
51488
|
+
},
|
|
51489
|
+
"403": {
|
|
51490
|
+
description: "Caller is not a company admin"
|
|
49512
51491
|
},
|
|
51492
|
+
"404": {
|
|
51493
|
+
description: "Not found error",
|
|
51494
|
+
schema: "any"
|
|
51495
|
+
},
|
|
51496
|
+
"422": {
|
|
51497
|
+
description: "No alert role exists yet"
|
|
51498
|
+
}
|
|
51499
|
+
}
|
|
51500
|
+
},
|
|
51501
|
+
{
|
|
51502
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
51503
|
+
method: "GET",
|
|
51504
|
+
summary: "List Alert Roles",
|
|
51505
|
+
description: "Company-defined alert roles. Gated by `update Company` (company admins only).",
|
|
51506
|
+
tags: [
|
|
51507
|
+
"AlertRBAC"
|
|
51508
|
+
],
|
|
51509
|
+
parameters: [
|
|
49513
51510
|
{
|
|
49514
|
-
name: "
|
|
51511
|
+
name: "company_id",
|
|
49515
51512
|
"in": "path",
|
|
49516
51513
|
type: "integer",
|
|
49517
51514
|
required: true,
|
|
49518
|
-
description: ""
|
|
51515
|
+
description: "Company ID"
|
|
51516
|
+
},
|
|
51517
|
+
{
|
|
51518
|
+
name: "page",
|
|
51519
|
+
"in": "query",
|
|
51520
|
+
type: "integer",
|
|
51521
|
+
required: false,
|
|
51522
|
+
description: "Page number"
|
|
51523
|
+
},
|
|
51524
|
+
{
|
|
51525
|
+
name: "per_page",
|
|
51526
|
+
"in": "query",
|
|
51527
|
+
type: "integer",
|
|
51528
|
+
required: false,
|
|
51529
|
+
description: "Items per page"
|
|
49519
51530
|
}
|
|
49520
51531
|
],
|
|
49521
51532
|
responses: {
|
|
49522
51533
|
"200": {
|
|
49523
|
-
description: "
|
|
51534
|
+
description: "List of alert roles",
|
|
51535
|
+
schema: "any"
|
|
49524
51536
|
},
|
|
49525
51537
|
"401": {
|
|
49526
51538
|
description: "Authentication error",
|
|
49527
51539
|
schema: "any"
|
|
49528
51540
|
},
|
|
49529
51541
|
"403": {
|
|
49530
|
-
description: "
|
|
51542
|
+
description: "Caller is not a company admin"
|
|
51543
|
+
},
|
|
51544
|
+
"404": {
|
|
51545
|
+
description: "Not found error",
|
|
51546
|
+
schema: "any"
|
|
51547
|
+
}
|
|
51548
|
+
}
|
|
51549
|
+
},
|
|
51550
|
+
{
|
|
51551
|
+
path: "/v2/companies/{company_id}/alert_roles",
|
|
51552
|
+
method: "POST",
|
|
51553
|
+
summary: "Create Alert Role",
|
|
51554
|
+
tags: [
|
|
51555
|
+
"AlertRBAC"
|
|
51556
|
+
],
|
|
51557
|
+
parameters: [
|
|
51558
|
+
{
|
|
51559
|
+
name: "company_id",
|
|
51560
|
+
"in": "path",
|
|
51561
|
+
type: "integer",
|
|
51562
|
+
required: true,
|
|
51563
|
+
description: "Company ID"
|
|
51564
|
+
}
|
|
51565
|
+
],
|
|
51566
|
+
requestBody: {
|
|
51567
|
+
contentType: "application/json",
|
|
51568
|
+
schema: "any",
|
|
51569
|
+
required: true
|
|
51570
|
+
},
|
|
51571
|
+
responses: {
|
|
51572
|
+
"200": {
|
|
51573
|
+
description: "Created alert role",
|
|
51574
|
+
schema: "any"
|
|
51575
|
+
},
|
|
51576
|
+
"400": {
|
|
51577
|
+
description: "Validation error (e.g. blank or duplicate name)"
|
|
51578
|
+
},
|
|
51579
|
+
"401": {
|
|
51580
|
+
description: "Authentication error",
|
|
49531
51581
|
schema: "any"
|
|
49532
51582
|
},
|
|
51583
|
+
"403": {
|
|
51584
|
+
description: "Caller is not a company admin"
|
|
51585
|
+
},
|
|
49533
51586
|
"404": {
|
|
49534
51587
|
description: "Not found error",
|
|
49535
51588
|
schema: "any"
|
|
@@ -49537,24 +51590,31 @@ var clientsData = [
|
|
|
49537
51590
|
}
|
|
49538
51591
|
},
|
|
49539
51592
|
{
|
|
49540
|
-
path: "/v2/
|
|
51593
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
49541
51594
|
method: "GET",
|
|
49542
|
-
summary: "Get Alert
|
|
51595
|
+
summary: "Get Alert Role",
|
|
49543
51596
|
tags: [
|
|
49544
|
-
"
|
|
51597
|
+
"AlertRBAC"
|
|
49545
51598
|
],
|
|
49546
51599
|
parameters: [
|
|
51600
|
+
{
|
|
51601
|
+
name: "company_id",
|
|
51602
|
+
"in": "path",
|
|
51603
|
+
type: "integer",
|
|
51604
|
+
required: true,
|
|
51605
|
+
description: "Company ID"
|
|
51606
|
+
},
|
|
49547
51607
|
{
|
|
49548
51608
|
name: "id",
|
|
49549
51609
|
"in": "path",
|
|
49550
51610
|
type: "integer",
|
|
49551
51611
|
required: true,
|
|
49552
|
-
description: ""
|
|
51612
|
+
description: "Alert role ID"
|
|
49553
51613
|
}
|
|
49554
51614
|
],
|
|
49555
51615
|
responses: {
|
|
49556
51616
|
"200": {
|
|
49557
|
-
description: "Alert
|
|
51617
|
+
description: "Alert role details",
|
|
49558
51618
|
schema: "any"
|
|
49559
51619
|
},
|
|
49560
51620
|
"401": {
|
|
@@ -49562,29 +51622,34 @@ var clientsData = [
|
|
|
49562
51622
|
schema: "any"
|
|
49563
51623
|
},
|
|
49564
51624
|
"403": {
|
|
49565
|
-
description: "
|
|
49566
|
-
schema: "any"
|
|
51625
|
+
description: "Caller is not a company admin"
|
|
49567
51626
|
},
|
|
49568
51627
|
"404": {
|
|
49569
|
-
description: "
|
|
49570
|
-
schema: "any"
|
|
51628
|
+
description: "Role not found in this company"
|
|
49571
51629
|
}
|
|
49572
51630
|
}
|
|
49573
51631
|
},
|
|
49574
51632
|
{
|
|
49575
|
-
path: "/v2/
|
|
51633
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
49576
51634
|
method: "PATCH",
|
|
49577
|
-
summary: "Update Alert
|
|
51635
|
+
summary: "Update Alert Role",
|
|
49578
51636
|
tags: [
|
|
49579
|
-
"
|
|
51637
|
+
"AlertRBAC"
|
|
49580
51638
|
],
|
|
49581
51639
|
parameters: [
|
|
51640
|
+
{
|
|
51641
|
+
name: "company_id",
|
|
51642
|
+
"in": "path",
|
|
51643
|
+
type: "integer",
|
|
51644
|
+
required: true,
|
|
51645
|
+
description: "Company ID"
|
|
51646
|
+
},
|
|
49582
51647
|
{
|
|
49583
51648
|
name: "id",
|
|
49584
51649
|
"in": "path",
|
|
49585
51650
|
type: "integer",
|
|
49586
51651
|
required: true,
|
|
49587
|
-
description: ""
|
|
51652
|
+
description: "Alert role ID"
|
|
49588
51653
|
}
|
|
49589
51654
|
],
|
|
49590
51655
|
requestBody: {
|
|
@@ -49594,16 +51659,18 @@ var clientsData = [
|
|
|
49594
51659
|
},
|
|
49595
51660
|
responses: {
|
|
49596
51661
|
"200": {
|
|
49597
|
-
description: "Updated alert
|
|
51662
|
+
description: "Updated alert role",
|
|
49598
51663
|
schema: "any"
|
|
49599
51664
|
},
|
|
51665
|
+
"400": {
|
|
51666
|
+
description: "Validation error"
|
|
51667
|
+
},
|
|
49600
51668
|
"401": {
|
|
49601
51669
|
description: "Authentication error",
|
|
49602
51670
|
schema: "any"
|
|
49603
51671
|
},
|
|
49604
51672
|
"403": {
|
|
49605
|
-
description: "
|
|
49606
|
-
schema: "any"
|
|
51673
|
+
description: "Caller is not a company admin"
|
|
49607
51674
|
},
|
|
49608
51675
|
"404": {
|
|
49609
51676
|
description: "Not found error",
|
|
@@ -49612,19 +51679,27 @@ var clientsData = [
|
|
|
49612
51679
|
}
|
|
49613
51680
|
},
|
|
49614
51681
|
{
|
|
49615
|
-
path: "/v2/
|
|
51682
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}",
|
|
49616
51683
|
method: "DELETE",
|
|
49617
|
-
summary: "Delete Alert
|
|
51684
|
+
summary: "Delete Alert Role",
|
|
51685
|
+
description: "Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",
|
|
49618
51686
|
tags: [
|
|
49619
|
-
"
|
|
51687
|
+
"AlertRBAC"
|
|
49620
51688
|
],
|
|
49621
51689
|
parameters: [
|
|
51690
|
+
{
|
|
51691
|
+
name: "company_id",
|
|
51692
|
+
"in": "path",
|
|
51693
|
+
type: "integer",
|
|
51694
|
+
required: true,
|
|
51695
|
+
description: "Company ID"
|
|
51696
|
+
},
|
|
49622
51697
|
{
|
|
49623
51698
|
name: "id",
|
|
49624
51699
|
"in": "path",
|
|
49625
51700
|
type: "integer",
|
|
49626
51701
|
required: true,
|
|
49627
|
-
description: ""
|
|
51702
|
+
description: "Alert role ID"
|
|
49628
51703
|
}
|
|
49629
51704
|
],
|
|
49630
51705
|
responses: {
|
|
@@ -49636,9 +51711,58 @@ var clientsData = [
|
|
|
49636
51711
|
schema: "any"
|
|
49637
51712
|
},
|
|
49638
51713
|
"403": {
|
|
49639
|
-
description: "
|
|
51714
|
+
description: "Caller is not a company admin, or the role is still assigned to members"
|
|
51715
|
+
},
|
|
51716
|
+
"404": {
|
|
51717
|
+
description: "Not found error",
|
|
51718
|
+
schema: "any"
|
|
51719
|
+
}
|
|
51720
|
+
}
|
|
51721
|
+
},
|
|
51722
|
+
{
|
|
51723
|
+
path: "/v2/companies/{company_id}/alert_roles/{id}/abilities",
|
|
51724
|
+
method: "PUT",
|
|
51725
|
+
summary: "Replace Alert Role Abilities",
|
|
51726
|
+
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.",
|
|
51727
|
+
tags: [
|
|
51728
|
+
"AlertRBAC"
|
|
51729
|
+
],
|
|
51730
|
+
parameters: [
|
|
51731
|
+
{
|
|
51732
|
+
name: "company_id",
|
|
51733
|
+
"in": "path",
|
|
51734
|
+
type: "integer",
|
|
51735
|
+
required: true,
|
|
51736
|
+
description: "Company ID"
|
|
51737
|
+
},
|
|
51738
|
+
{
|
|
51739
|
+
name: "id",
|
|
51740
|
+
"in": "path",
|
|
51741
|
+
type: "integer",
|
|
51742
|
+
required: true,
|
|
51743
|
+
description: "Alert role ID"
|
|
51744
|
+
}
|
|
51745
|
+
],
|
|
51746
|
+
requestBody: {
|
|
51747
|
+
contentType: "application/json",
|
|
51748
|
+
schema: "any",
|
|
51749
|
+
required: true
|
|
51750
|
+
},
|
|
51751
|
+
responses: {
|
|
51752
|
+
"200": {
|
|
51753
|
+
description: "Role with its updated abilities",
|
|
51754
|
+
schema: "any"
|
|
51755
|
+
},
|
|
51756
|
+
"400": {
|
|
51757
|
+
description: "Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"
|
|
51758
|
+
},
|
|
51759
|
+
"401": {
|
|
51760
|
+
description: "Authentication error",
|
|
49640
51761
|
schema: "any"
|
|
49641
51762
|
},
|
|
51763
|
+
"403": {
|
|
51764
|
+
description: "Caller is not a company admin"
|
|
51765
|
+
},
|
|
49642
51766
|
"404": {
|
|
49643
51767
|
description: "Not found error",
|
|
49644
51768
|
schema: "any"
|
|
@@ -49740,6 +51864,20 @@ var clientsData = [
|
|
|
49740
51864
|
required: false,
|
|
49741
51865
|
description: "Timestamp to end alert at"
|
|
49742
51866
|
},
|
|
51867
|
+
{
|
|
51868
|
+
name: "last_alert_start",
|
|
51869
|
+
"in": "query",
|
|
51870
|
+
type: "integer",
|
|
51871
|
+
required: false,
|
|
51872
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
51873
|
+
},
|
|
51874
|
+
{
|
|
51875
|
+
name: "last_alert_end",
|
|
51876
|
+
"in": "query",
|
|
51877
|
+
type: "integer",
|
|
51878
|
+
required: false,
|
|
51879
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
51880
|
+
},
|
|
49743
51881
|
{
|
|
49744
51882
|
name: "page",
|
|
49745
51883
|
"in": "query",
|
|
@@ -50812,6 +52950,20 @@ var clientsData = [
|
|
|
50812
52950
|
required: false,
|
|
50813
52951
|
description: "Timestamp to end alert at"
|
|
50814
52952
|
},
|
|
52953
|
+
{
|
|
52954
|
+
name: "last_alert_start",
|
|
52955
|
+
"in": "query",
|
|
52956
|
+
type: "integer",
|
|
52957
|
+
required: false,
|
|
52958
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
52959
|
+
},
|
|
52960
|
+
{
|
|
52961
|
+
name: "last_alert_end",
|
|
52962
|
+
"in": "query",
|
|
52963
|
+
type: "integer",
|
|
52964
|
+
required: false,
|
|
52965
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
52966
|
+
},
|
|
50815
52967
|
{
|
|
50816
52968
|
name: "page",
|
|
50817
52969
|
"in": "query",
|
|
@@ -50952,6 +53104,20 @@ var clientsData = [
|
|
|
50952
53104
|
required: false,
|
|
50953
53105
|
description: "Timestamp to end alert at"
|
|
50954
53106
|
},
|
|
53107
|
+
{
|
|
53108
|
+
name: "last_alert_start",
|
|
53109
|
+
"in": "query",
|
|
53110
|
+
type: "integer",
|
|
53111
|
+
required: false,
|
|
53112
|
+
description: "Timestamp (ms) lower bound for last_alert_at"
|
|
53113
|
+
},
|
|
53114
|
+
{
|
|
53115
|
+
name: "last_alert_end",
|
|
53116
|
+
"in": "query",
|
|
53117
|
+
type: "integer",
|
|
53118
|
+
required: false,
|
|
53119
|
+
description: "Timestamp (ms) upper bound for last_alert_at"
|
|
53120
|
+
},
|
|
50955
53121
|
{
|
|
50956
53122
|
name: "created_after",
|
|
50957
53123
|
"in": "query",
|
|
@@ -51127,12 +53293,19 @@ var clientsData = [
|
|
|
51127
53293
|
required: true,
|
|
51128
53294
|
description: "Alert ID"
|
|
51129
53295
|
},
|
|
53296
|
+
{
|
|
53297
|
+
name: "sort",
|
|
53298
|
+
"in": "query",
|
|
53299
|
+
type: "string",
|
|
53300
|
+
required: false,
|
|
53301
|
+
description: "Field to sort by: start_at (default) or severity"
|
|
53302
|
+
},
|
|
51130
53303
|
{
|
|
51131
53304
|
name: "order",
|
|
51132
53305
|
"in": "query",
|
|
51133
53306
|
type: "string",
|
|
51134
53307
|
required: false,
|
|
51135
|
-
description: "Sort
|
|
53308
|
+
description: "Sort direction: asc (default) or desc"
|
|
51136
53309
|
},
|
|
51137
53310
|
{
|
|
51138
53311
|
name: "page",
|
|
@@ -77305,6 +79478,178 @@ var clientsData = [
|
|
|
77305
79478
|
}
|
|
77306
79479
|
}
|
|
77307
79480
|
],
|
|
79481
|
+
"Well Plan Checklists": [
|
|
79482
|
+
{
|
|
79483
|
+
path: "/v2/well_plan_checklists",
|
|
79484
|
+
method: "GET",
|
|
79485
|
+
summary: "List well plan checklists",
|
|
79486
|
+
tags: [
|
|
79487
|
+
"Well Plan Checklists"
|
|
79488
|
+
],
|
|
79489
|
+
parameters: [
|
|
79490
|
+
{
|
|
79491
|
+
name: "company_id",
|
|
79492
|
+
"in": "query",
|
|
79493
|
+
type: "integer",
|
|
79494
|
+
required: false,
|
|
79495
|
+
description: "Filter by company ID"
|
|
79496
|
+
},
|
|
79497
|
+
{
|
|
79498
|
+
name: "per_page",
|
|
79499
|
+
"in": "query",
|
|
79500
|
+
type: "integer",
|
|
79501
|
+
required: false,
|
|
79502
|
+
description: "Number of items to list per page"
|
|
79503
|
+
},
|
|
79504
|
+
{
|
|
79505
|
+
name: "page",
|
|
79506
|
+
"in": "query",
|
|
79507
|
+
type: "integer",
|
|
79508
|
+
required: false,
|
|
79509
|
+
description: "Page number"
|
|
79510
|
+
}
|
|
79511
|
+
],
|
|
79512
|
+
responses: {
|
|
79513
|
+
"200": {
|
|
79514
|
+
description: "Successful response",
|
|
79515
|
+
schema: "any"
|
|
79516
|
+
},
|
|
79517
|
+
"401": {
|
|
79518
|
+
description: "Authentication error",
|
|
79519
|
+
schema: "any"
|
|
79520
|
+
},
|
|
79521
|
+
"403": {
|
|
79522
|
+
description: "Authorization error",
|
|
79523
|
+
schema: "any"
|
|
79524
|
+
},
|
|
79525
|
+
"404": {
|
|
79526
|
+
description: "Not found error",
|
|
79527
|
+
schema: "any"
|
|
79528
|
+
}
|
|
79529
|
+
}
|
|
79530
|
+
},
|
|
79531
|
+
{
|
|
79532
|
+
path: "/v2/well_plan_checklists/{id}",
|
|
79533
|
+
method: "GET",
|
|
79534
|
+
summary: "Show well plan checklist",
|
|
79535
|
+
tags: [
|
|
79536
|
+
"Well Plan Checklists"
|
|
79537
|
+
],
|
|
79538
|
+
parameters: [
|
|
79539
|
+
{
|
|
79540
|
+
name: "id",
|
|
79541
|
+
"in": "path",
|
|
79542
|
+
type: "integer",
|
|
79543
|
+
required: true,
|
|
79544
|
+
description: "Well Plan Checklist ID"
|
|
79545
|
+
}
|
|
79546
|
+
],
|
|
79547
|
+
responses: {
|
|
79548
|
+
"200": {
|
|
79549
|
+
description: "Successful response",
|
|
79550
|
+
schema: "any"
|
|
79551
|
+
},
|
|
79552
|
+
"401": {
|
|
79553
|
+
description: "Authentication error",
|
|
79554
|
+
schema: "any"
|
|
79555
|
+
},
|
|
79556
|
+
"403": {
|
|
79557
|
+
description: "Authorization error",
|
|
79558
|
+
schema: "any"
|
|
79559
|
+
},
|
|
79560
|
+
"404": {
|
|
79561
|
+
description: "Not found error",
|
|
79562
|
+
schema: "any"
|
|
79563
|
+
}
|
|
79564
|
+
}
|
|
79565
|
+
}
|
|
79566
|
+
],
|
|
79567
|
+
"Well Plan Tabs": [
|
|
79568
|
+
{
|
|
79569
|
+
path: "/v2/well_plan_tabs",
|
|
79570
|
+
method: "GET",
|
|
79571
|
+
summary: "List well plan tabs",
|
|
79572
|
+
tags: [
|
|
79573
|
+
"Well Plan Tabs"
|
|
79574
|
+
],
|
|
79575
|
+
parameters: [
|
|
79576
|
+
{
|
|
79577
|
+
name: "company_id",
|
|
79578
|
+
"in": "query",
|
|
79579
|
+
type: "integer",
|
|
79580
|
+
required: false,
|
|
79581
|
+
description: "Filter by company ID"
|
|
79582
|
+
},
|
|
79583
|
+
{
|
|
79584
|
+
name: "per_page",
|
|
79585
|
+
"in": "query",
|
|
79586
|
+
type: "integer",
|
|
79587
|
+
required: false,
|
|
79588
|
+
description: "Number of items to list per page"
|
|
79589
|
+
},
|
|
79590
|
+
{
|
|
79591
|
+
name: "page",
|
|
79592
|
+
"in": "query",
|
|
79593
|
+
type: "integer",
|
|
79594
|
+
required: false,
|
|
79595
|
+
description: "Page number"
|
|
79596
|
+
}
|
|
79597
|
+
],
|
|
79598
|
+
responses: {
|
|
79599
|
+
"200": {
|
|
79600
|
+
description: "Successful response",
|
|
79601
|
+
schema: "any"
|
|
79602
|
+
},
|
|
79603
|
+
"401": {
|
|
79604
|
+
description: "Authentication error",
|
|
79605
|
+
schema: "any"
|
|
79606
|
+
},
|
|
79607
|
+
"403": {
|
|
79608
|
+
description: "Authorization error",
|
|
79609
|
+
schema: "any"
|
|
79610
|
+
},
|
|
79611
|
+
"404": {
|
|
79612
|
+
description: "Not found error",
|
|
79613
|
+
schema: "any"
|
|
79614
|
+
}
|
|
79615
|
+
}
|
|
79616
|
+
},
|
|
79617
|
+
{
|
|
79618
|
+
path: "/v2/well_plan_tabs/{id}",
|
|
79619
|
+
method: "GET",
|
|
79620
|
+
summary: "Show well plan tab",
|
|
79621
|
+
tags: [
|
|
79622
|
+
"Well Plan Tabs"
|
|
79623
|
+
],
|
|
79624
|
+
parameters: [
|
|
79625
|
+
{
|
|
79626
|
+
name: "id",
|
|
79627
|
+
"in": "path",
|
|
79628
|
+
type: "integer",
|
|
79629
|
+
required: true,
|
|
79630
|
+
description: "Well Plan Tab ID"
|
|
79631
|
+
}
|
|
79632
|
+
],
|
|
79633
|
+
responses: {
|
|
79634
|
+
"200": {
|
|
79635
|
+
description: "Successful response",
|
|
79636
|
+
schema: "any"
|
|
79637
|
+
},
|
|
79638
|
+
"401": {
|
|
79639
|
+
description: "Authentication error",
|
|
79640
|
+
schema: "any"
|
|
79641
|
+
},
|
|
79642
|
+
"403": {
|
|
79643
|
+
description: "Authorization error",
|
|
79644
|
+
schema: "any"
|
|
79645
|
+
},
|
|
79646
|
+
"404": {
|
|
79647
|
+
description: "Not found error",
|
|
79648
|
+
schema: "any"
|
|
79649
|
+
}
|
|
79650
|
+
}
|
|
79651
|
+
}
|
|
79652
|
+
],
|
|
77308
79653
|
"Well Planning Dashboards": [
|
|
77309
79654
|
{
|
|
77310
79655
|
path: "/v2/well_planning_dashboards",
|
|
@@ -77424,19 +79769,230 @@ var clientsData = [
|
|
|
77424
79769
|
}
|
|
77425
79770
|
},
|
|
77426
79771
|
{
|
|
77427
|
-
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
79772
|
+
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
79773
|
+
method: "PATCH",
|
|
79774
|
+
summary: "Update a well planning dashboard",
|
|
79775
|
+
tags: [
|
|
79776
|
+
"Well Planning Dashboards"
|
|
79777
|
+
],
|
|
79778
|
+
parameters: [
|
|
79779
|
+
{
|
|
79780
|
+
name: "id_or_slug",
|
|
79781
|
+
"in": "path",
|
|
79782
|
+
type: "string",
|
|
79783
|
+
required: true,
|
|
79784
|
+
description: "Well Planning Dashboard ID or slug"
|
|
79785
|
+
}
|
|
79786
|
+
],
|
|
79787
|
+
requestBody: {
|
|
79788
|
+
contentType: "application/json",
|
|
79789
|
+
schema: "any",
|
|
79790
|
+
required: true
|
|
79791
|
+
},
|
|
79792
|
+
responses: {
|
|
79793
|
+
"200": {
|
|
79794
|
+
description: "Updated well planning dashboard",
|
|
79795
|
+
schema: "any"
|
|
79796
|
+
},
|
|
79797
|
+
"401": {
|
|
79798
|
+
description: "Authentication error",
|
|
79799
|
+
schema: "any"
|
|
79800
|
+
},
|
|
79801
|
+
"403": {
|
|
79802
|
+
description: "Authorization error",
|
|
79803
|
+
schema: "any"
|
|
79804
|
+
},
|
|
79805
|
+
"404": {
|
|
79806
|
+
description: "Not found error",
|
|
79807
|
+
schema: "any"
|
|
79808
|
+
}
|
|
79809
|
+
}
|
|
79810
|
+
},
|
|
79811
|
+
{
|
|
79812
|
+
path: "/v2/well_planning_dashboards/{id_or_slug}",
|
|
79813
|
+
method: "DELETE",
|
|
79814
|
+
summary: "Delete a well planning dashboard",
|
|
79815
|
+
tags: [
|
|
79816
|
+
"Well Planning Dashboards"
|
|
79817
|
+
],
|
|
79818
|
+
parameters: [
|
|
79819
|
+
{
|
|
79820
|
+
name: "id_or_slug",
|
|
79821
|
+
"in": "path",
|
|
79822
|
+
type: "string",
|
|
79823
|
+
required: true,
|
|
79824
|
+
description: "Well Planning Dashboard ID or slug"
|
|
79825
|
+
}
|
|
79826
|
+
],
|
|
79827
|
+
responses: {
|
|
79828
|
+
"200": {
|
|
79829
|
+
description: "Well planning dashboard deleted",
|
|
79830
|
+
schema: "any"
|
|
79831
|
+
},
|
|
79832
|
+
"401": {
|
|
79833
|
+
description: "Authentication error",
|
|
79834
|
+
schema: "any"
|
|
79835
|
+
},
|
|
79836
|
+
"403": {
|
|
79837
|
+
description: "Authorization error",
|
|
79838
|
+
schema: "any"
|
|
79839
|
+
},
|
|
79840
|
+
"404": {
|
|
79841
|
+
description: "Not found error",
|
|
79842
|
+
schema: "any"
|
|
79843
|
+
}
|
|
79844
|
+
}
|
|
79845
|
+
},
|
|
79846
|
+
{
|
|
79847
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
79848
|
+
method: "POST",
|
|
79849
|
+
summary: "Create a dashboard app on a well planning dashboard",
|
|
79850
|
+
tags: [
|
|
79851
|
+
"Well Planning Dashboards"
|
|
79852
|
+
],
|
|
79853
|
+
parameters: [
|
|
79854
|
+
{
|
|
79855
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
79856
|
+
"in": "path",
|
|
79857
|
+
type: "string",
|
|
79858
|
+
required: true,
|
|
79859
|
+
description: "Well Planning Dashboard ID or slug"
|
|
79860
|
+
}
|
|
79861
|
+
],
|
|
79862
|
+
requestBody: {
|
|
79863
|
+
contentType: "application/json",
|
|
79864
|
+
schema: "any",
|
|
79865
|
+
required: true
|
|
79866
|
+
},
|
|
79867
|
+
responses: {
|
|
79868
|
+
"200": {
|
|
79869
|
+
description: "Created dashboard app",
|
|
79870
|
+
schema: "any"
|
|
79871
|
+
},
|
|
79872
|
+
"401": {
|
|
79873
|
+
description: "Authentication error",
|
|
79874
|
+
schema: "any"
|
|
79875
|
+
},
|
|
79876
|
+
"403": {
|
|
79877
|
+
description: "Authorization error",
|
|
79878
|
+
schema: "any"
|
|
79879
|
+
},
|
|
79880
|
+
"404": {
|
|
79881
|
+
description: "Not found error",
|
|
79882
|
+
schema: "any"
|
|
79883
|
+
}
|
|
79884
|
+
}
|
|
79885
|
+
},
|
|
79886
|
+
{
|
|
79887
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
79888
|
+
method: "PUT",
|
|
79889
|
+
summary: "Batch update dashboard apps on a well planning dashboard",
|
|
79890
|
+
tags: [
|
|
79891
|
+
"Well Planning Dashboards"
|
|
79892
|
+
],
|
|
79893
|
+
parameters: [
|
|
79894
|
+
{
|
|
79895
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
79896
|
+
"in": "path",
|
|
79897
|
+
type: "string",
|
|
79898
|
+
required: true,
|
|
79899
|
+
description: "Well Planning Dashboard ID or slug"
|
|
79900
|
+
}
|
|
79901
|
+
],
|
|
79902
|
+
requestBody: {
|
|
79903
|
+
contentType: "application/json",
|
|
79904
|
+
schema: "any",
|
|
79905
|
+
required: true
|
|
79906
|
+
},
|
|
79907
|
+
responses: {
|
|
79908
|
+
"200": {
|
|
79909
|
+
description: "Updated dashboard apps",
|
|
79910
|
+
schema: "any"
|
|
79911
|
+
},
|
|
79912
|
+
"401": {
|
|
79913
|
+
description: "Authentication error",
|
|
79914
|
+
schema: "any"
|
|
79915
|
+
},
|
|
79916
|
+
"403": {
|
|
79917
|
+
description: "Authorization error",
|
|
79918
|
+
schema: "any"
|
|
79919
|
+
},
|
|
79920
|
+
"404": {
|
|
79921
|
+
description: "Not found error",
|
|
79922
|
+
schema: "any"
|
|
79923
|
+
}
|
|
79924
|
+
}
|
|
79925
|
+
},
|
|
79926
|
+
{
|
|
79927
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
79928
|
+
method: "GET",
|
|
79929
|
+
summary: "Show dashboard app on a well planning dashboard",
|
|
79930
|
+
tags: [
|
|
79931
|
+
"Well Planning Dashboards"
|
|
79932
|
+
],
|
|
79933
|
+
parameters: [
|
|
79934
|
+
{
|
|
79935
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
79936
|
+
"in": "path",
|
|
79937
|
+
type: "string",
|
|
79938
|
+
required: true,
|
|
79939
|
+
description: "Well Planning Dashboard ID or slug"
|
|
79940
|
+
},
|
|
79941
|
+
{
|
|
79942
|
+
name: "id",
|
|
79943
|
+
"in": "path",
|
|
79944
|
+
type: "integer",
|
|
79945
|
+
required: true,
|
|
79946
|
+
description: "Dashboard App ID"
|
|
79947
|
+
},
|
|
79948
|
+
{
|
|
79949
|
+
name: "filter_asset_id",
|
|
79950
|
+
"in": "query",
|
|
79951
|
+
type: "integer",
|
|
79952
|
+
required: false,
|
|
79953
|
+
description: "Data filter's Asset ID"
|
|
79954
|
+
}
|
|
79955
|
+
],
|
|
79956
|
+
responses: {
|
|
79957
|
+
"200": {
|
|
79958
|
+
description: "Successful response",
|
|
79959
|
+
schema: "any"
|
|
79960
|
+
},
|
|
79961
|
+
"401": {
|
|
79962
|
+
description: "Authentication error",
|
|
79963
|
+
schema: "any"
|
|
79964
|
+
},
|
|
79965
|
+
"403": {
|
|
79966
|
+
description: "Authorization error",
|
|
79967
|
+
schema: "any"
|
|
79968
|
+
},
|
|
79969
|
+
"404": {
|
|
79970
|
+
description: "Not found error",
|
|
79971
|
+
schema: "any"
|
|
79972
|
+
}
|
|
79973
|
+
}
|
|
79974
|
+
},
|
|
79975
|
+
{
|
|
79976
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
77428
79977
|
method: "PATCH",
|
|
77429
|
-
summary: "Update a well planning dashboard",
|
|
79978
|
+
summary: "Update dashboard app on a well planning dashboard",
|
|
77430
79979
|
tags: [
|
|
77431
79980
|
"Well Planning Dashboards"
|
|
77432
79981
|
],
|
|
77433
79982
|
parameters: [
|
|
77434
79983
|
{
|
|
77435
|
-
name: "
|
|
79984
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
77436
79985
|
"in": "path",
|
|
77437
79986
|
type: "string",
|
|
77438
79987
|
required: true,
|
|
77439
79988
|
description: "Well Planning Dashboard ID or slug"
|
|
79989
|
+
},
|
|
79990
|
+
{
|
|
79991
|
+
name: "id",
|
|
79992
|
+
"in": "path",
|
|
79993
|
+
type: "integer",
|
|
79994
|
+
required: true,
|
|
79995
|
+
description: "Dashboard App ID"
|
|
77440
79996
|
}
|
|
77441
79997
|
],
|
|
77442
79998
|
requestBody: {
|
|
@@ -77446,7 +80002,7 @@ var clientsData = [
|
|
|
77446
80002
|
},
|
|
77447
80003
|
responses: {
|
|
77448
80004
|
"200": {
|
|
77449
|
-
description: "Updated
|
|
80005
|
+
description: "Updated dashboard app",
|
|
77450
80006
|
schema: "any"
|
|
77451
80007
|
},
|
|
77452
80008
|
"401": {
|
|
@@ -77464,25 +80020,31 @@ var clientsData = [
|
|
|
77464
80020
|
}
|
|
77465
80021
|
},
|
|
77466
80022
|
{
|
|
77467
|
-
path: "/v2/well_planning_dashboards/{
|
|
80023
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",
|
|
77468
80024
|
method: "DELETE",
|
|
77469
|
-
summary: "Delete a well planning dashboard",
|
|
80025
|
+
summary: "Delete dashboard app from a well planning dashboard",
|
|
77470
80026
|
tags: [
|
|
77471
80027
|
"Well Planning Dashboards"
|
|
77472
80028
|
],
|
|
77473
80029
|
parameters: [
|
|
77474
80030
|
{
|
|
77475
|
-
name: "
|
|
80031
|
+
name: "well_planning_dashboard_id_or_slug",
|
|
77476
80032
|
"in": "path",
|
|
77477
80033
|
type: "string",
|
|
77478
80034
|
required: true,
|
|
77479
80035
|
description: "Well Planning Dashboard ID or slug"
|
|
80036
|
+
},
|
|
80037
|
+
{
|
|
80038
|
+
name: "id",
|
|
80039
|
+
"in": "path",
|
|
80040
|
+
type: "integer",
|
|
80041
|
+
required: true,
|
|
80042
|
+
description: "Dashboard App ID"
|
|
77480
80043
|
}
|
|
77481
80044
|
],
|
|
77482
80045
|
responses: {
|
|
77483
80046
|
"200": {
|
|
77484
|
-
description: "
|
|
77485
|
-
schema: "any"
|
|
80047
|
+
description: "Dashboard app deleted"
|
|
77486
80048
|
},
|
|
77487
80049
|
"401": {
|
|
77488
80050
|
description: "Authentication error",
|
|
@@ -77499,9 +80061,9 @@ var clientsData = [
|
|
|
77499
80061
|
}
|
|
77500
80062
|
},
|
|
77501
80063
|
{
|
|
77502
|
-
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",
|
|
80064
|
+
path: "/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/bulk_create",
|
|
77503
80065
|
method: "POST",
|
|
77504
|
-
summary: "
|
|
80066
|
+
summary: "Bulk create dashboard apps on a well planning dashboard",
|
|
77505
80067
|
tags: [
|
|
77506
80068
|
"Well Planning Dashboards"
|
|
77507
80069
|
],
|
|
@@ -77521,7 +80083,7 @@ var clientsData = [
|
|
|
77521
80083
|
},
|
|
77522
80084
|
responses: {
|
|
77523
80085
|
"200": {
|
|
77524
|
-
description: "Created dashboard
|
|
80086
|
+
description: "Created dashboard apps",
|
|
77525
80087
|
schema: "any"
|
|
77526
80088
|
},
|
|
77527
80089
|
"401": {
|
|
@@ -77537,23 +80099,88 @@ var clientsData = [
|
|
|
77537
80099
|
schema: "any"
|
|
77538
80100
|
}
|
|
77539
80101
|
}
|
|
77540
|
-
}
|
|
80102
|
+
}
|
|
80103
|
+
],
|
|
80104
|
+
"Well Plans": [
|
|
77541
80105
|
{
|
|
77542
|
-
path: "/v2/
|
|
77543
|
-
method: "
|
|
77544
|
-
summary: "
|
|
80106
|
+
path: "/v2/well_plans",
|
|
80107
|
+
method: "GET",
|
|
80108
|
+
summary: "List well plans",
|
|
77545
80109
|
tags: [
|
|
77546
|
-
"Well
|
|
80110
|
+
"Well Plans"
|
|
77547
80111
|
],
|
|
77548
80112
|
parameters: [
|
|
77549
80113
|
{
|
|
77550
|
-
name: "
|
|
77551
|
-
"in": "
|
|
80114
|
+
name: "company_id",
|
|
80115
|
+
"in": "query",
|
|
80116
|
+
type: "integer",
|
|
80117
|
+
required: false,
|
|
80118
|
+
description: "Filter by company ID"
|
|
80119
|
+
},
|
|
80120
|
+
{
|
|
80121
|
+
name: "well_id",
|
|
80122
|
+
"in": "query",
|
|
80123
|
+
type: "integer",
|
|
80124
|
+
required: false,
|
|
80125
|
+
description: "Filter by well ID"
|
|
80126
|
+
},
|
|
80127
|
+
{
|
|
80128
|
+
name: "source_well_id",
|
|
80129
|
+
"in": "query",
|
|
80130
|
+
type: "integer",
|
|
80131
|
+
required: false,
|
|
80132
|
+
description: "Filter by source well ID"
|
|
80133
|
+
},
|
|
80134
|
+
{
|
|
80135
|
+
name: "status",
|
|
80136
|
+
"in": "query",
|
|
77552
80137
|
type: "string",
|
|
77553
|
-
required:
|
|
77554
|
-
description: "
|
|
80138
|
+
required: false,
|
|
80139
|
+
description: "Filter by status"
|
|
80140
|
+
},
|
|
80141
|
+
{
|
|
80142
|
+
name: "per_page",
|
|
80143
|
+
"in": "query",
|
|
80144
|
+
type: "integer",
|
|
80145
|
+
required: false,
|
|
80146
|
+
description: "Number of items to list per page"
|
|
80147
|
+
},
|
|
80148
|
+
{
|
|
80149
|
+
name: "page",
|
|
80150
|
+
"in": "query",
|
|
80151
|
+
type: "integer",
|
|
80152
|
+
required: false,
|
|
80153
|
+
description: "Page number"
|
|
77555
80154
|
}
|
|
77556
80155
|
],
|
|
80156
|
+
responses: {
|
|
80157
|
+
"200": {
|
|
80158
|
+
description: "Successful response",
|
|
80159
|
+
schema: "any"
|
|
80160
|
+
},
|
|
80161
|
+
"401": {
|
|
80162
|
+
description: "Authentication error",
|
|
80163
|
+
schema: "any"
|
|
80164
|
+
},
|
|
80165
|
+
"403": {
|
|
80166
|
+
description: "Authorization error",
|
|
80167
|
+
schema: "any"
|
|
80168
|
+
},
|
|
80169
|
+
"404": {
|
|
80170
|
+
description: "Not found error",
|
|
80171
|
+
schema: "any"
|
|
80172
|
+
}
|
|
80173
|
+
}
|
|
80174
|
+
},
|
|
80175
|
+
{
|
|
80176
|
+
path: "/v2/well_plans",
|
|
80177
|
+
method: "POST",
|
|
80178
|
+
summary: "Create a well plan",
|
|
80179
|
+
tags: [
|
|
80180
|
+
"Well Plans"
|
|
80181
|
+
],
|
|
80182
|
+
parameters: [
|
|
80183
|
+
],
|
|
77557
80184
|
requestBody: {
|
|
77558
80185
|
contentType: "application/json",
|
|
77559
80186
|
schema: "any",
|
|
@@ -77561,7 +80188,7 @@ var clientsData = [
|
|
|
77561
80188
|
},
|
|
77562
80189
|
responses: {
|
|
77563
80190
|
"200": {
|
|
77564
|
-
description: "
|
|
80191
|
+
description: "Created well plan",
|
|
77565
80192
|
schema: "any"
|
|
77566
80193
|
},
|
|
77567
80194
|
"401": {
|
|
@@ -77579,33 +80206,19 @@ var clientsData = [
|
|
|
77579
80206
|
}
|
|
77580
80207
|
},
|
|
77581
80208
|
{
|
|
77582
|
-
path: "/v2/
|
|
80209
|
+
path: "/v2/well_plans/{id}",
|
|
77583
80210
|
method: "GET",
|
|
77584
|
-
summary: "Show
|
|
80211
|
+
summary: "Show well plan",
|
|
77585
80212
|
tags: [
|
|
77586
|
-
"Well
|
|
80213
|
+
"Well Plans"
|
|
77587
80214
|
],
|
|
77588
80215
|
parameters: [
|
|
77589
|
-
{
|
|
77590
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
77591
|
-
"in": "path",
|
|
77592
|
-
type: "string",
|
|
77593
|
-
required: true,
|
|
77594
|
-
description: "Well Planning Dashboard ID or slug"
|
|
77595
|
-
},
|
|
77596
80216
|
{
|
|
77597
80217
|
name: "id",
|
|
77598
80218
|
"in": "path",
|
|
77599
80219
|
type: "integer",
|
|
77600
80220
|
required: true,
|
|
77601
|
-
description: "
|
|
77602
|
-
},
|
|
77603
|
-
{
|
|
77604
|
-
name: "filter_asset_id",
|
|
77605
|
-
"in": "query",
|
|
77606
|
-
type: "integer",
|
|
77607
|
-
required: false,
|
|
77608
|
-
description: "Data filter's Asset ID"
|
|
80221
|
+
description: "Well Plan ID"
|
|
77609
80222
|
}
|
|
77610
80223
|
],
|
|
77611
80224
|
responses: {
|
|
@@ -77628,26 +80241,19 @@ var clientsData = [
|
|
|
77628
80241
|
}
|
|
77629
80242
|
},
|
|
77630
80243
|
{
|
|
77631
|
-
path: "/v2/
|
|
80244
|
+
path: "/v2/well_plans/{id}",
|
|
77632
80245
|
method: "PATCH",
|
|
77633
|
-
summary: "Update
|
|
80246
|
+
summary: "Update well plan",
|
|
77634
80247
|
tags: [
|
|
77635
|
-
"Well
|
|
80248
|
+
"Well Plans"
|
|
77636
80249
|
],
|
|
77637
80250
|
parameters: [
|
|
77638
|
-
{
|
|
77639
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
77640
|
-
"in": "path",
|
|
77641
|
-
type: "string",
|
|
77642
|
-
required: true,
|
|
77643
|
-
description: "Well Planning Dashboard ID or slug"
|
|
77644
|
-
},
|
|
77645
80251
|
{
|
|
77646
80252
|
name: "id",
|
|
77647
80253
|
"in": "path",
|
|
77648
80254
|
type: "integer",
|
|
77649
80255
|
required: true,
|
|
77650
|
-
description: "
|
|
80256
|
+
description: "Well Plan ID"
|
|
77651
80257
|
}
|
|
77652
80258
|
],
|
|
77653
80259
|
requestBody: {
|
|
@@ -77657,7 +80263,7 @@ var clientsData = [
|
|
|
77657
80263
|
},
|
|
77658
80264
|
responses: {
|
|
77659
80265
|
"200": {
|
|
77660
|
-
description: "Updated
|
|
80266
|
+
description: "Updated well plan",
|
|
77661
80267
|
schema: "any"
|
|
77662
80268
|
},
|
|
77663
80269
|
"401": {
|
|
@@ -77675,31 +80281,25 @@ var clientsData = [
|
|
|
77675
80281
|
}
|
|
77676
80282
|
},
|
|
77677
80283
|
{
|
|
77678
|
-
path: "/v2/
|
|
80284
|
+
path: "/v2/well_plans/{id}",
|
|
77679
80285
|
method: "DELETE",
|
|
77680
|
-
summary: "Delete
|
|
80286
|
+
summary: "Delete well plan",
|
|
77681
80287
|
tags: [
|
|
77682
|
-
"Well
|
|
80288
|
+
"Well Plans"
|
|
77683
80289
|
],
|
|
77684
80290
|
parameters: [
|
|
77685
|
-
{
|
|
77686
|
-
name: "well_planning_dashboard_id_or_slug",
|
|
77687
|
-
"in": "path",
|
|
77688
|
-
type: "string",
|
|
77689
|
-
required: true,
|
|
77690
|
-
description: "Well Planning Dashboard ID or slug"
|
|
77691
|
-
},
|
|
77692
80291
|
{
|
|
77693
80292
|
name: "id",
|
|
77694
80293
|
"in": "path",
|
|
77695
80294
|
type: "integer",
|
|
77696
80295
|
required: true,
|
|
77697
|
-
description: "
|
|
80296
|
+
description: "Well Plan ID"
|
|
77698
80297
|
}
|
|
77699
80298
|
],
|
|
77700
80299
|
responses: {
|
|
77701
80300
|
"200": {
|
|
77702
|
-
description: "
|
|
80301
|
+
description: "Well plan deleted",
|
|
80302
|
+
schema: "any"
|
|
77703
80303
|
},
|
|
77704
80304
|
"401": {
|
|
77705
80305
|
description: "Authentication error",
|
|
@@ -77714,31 +80314,35 @@ var clientsData = [
|
|
|
77714
80314
|
schema: "any"
|
|
77715
80315
|
}
|
|
77716
80316
|
}
|
|
77717
|
-
}
|
|
80317
|
+
}
|
|
80318
|
+
],
|
|
80319
|
+
WellCache: [
|
|
77718
80320
|
{
|
|
77719
|
-
path: "/
|
|
77720
|
-
method: "
|
|
77721
|
-
summary: "
|
|
80321
|
+
path: "/v1/data/corva/well_cache",
|
|
80322
|
+
method: "GET",
|
|
80323
|
+
summary: "List WellCache Records",
|
|
77722
80324
|
tags: [
|
|
77723
|
-
"
|
|
80325
|
+
"WellCache"
|
|
77724
80326
|
],
|
|
77725
80327
|
parameters: [
|
|
77726
80328
|
{
|
|
77727
|
-
name: "
|
|
77728
|
-
"in": "
|
|
77729
|
-
type: "
|
|
77730
|
-
required:
|
|
77731
|
-
description: "
|
|
80329
|
+
name: "asset_id",
|
|
80330
|
+
"in": "query",
|
|
80331
|
+
type: "integer",
|
|
80332
|
+
required: false,
|
|
80333
|
+
description: "Search by Asset ID"
|
|
80334
|
+
},
|
|
80335
|
+
{
|
|
80336
|
+
name: "company_id",
|
|
80337
|
+
"in": "query",
|
|
80338
|
+
type: "integer",
|
|
80339
|
+
required: false,
|
|
80340
|
+
description: "Search by Company ID"
|
|
77732
80341
|
}
|
|
77733
80342
|
],
|
|
77734
|
-
requestBody: {
|
|
77735
|
-
contentType: "application/json",
|
|
77736
|
-
schema: "any",
|
|
77737
|
-
required: true
|
|
77738
|
-
},
|
|
77739
80343
|
responses: {
|
|
77740
80344
|
"200": {
|
|
77741
|
-
description: "
|
|
80345
|
+
description: "Successful response",
|
|
77742
80346
|
schema: "any"
|
|
77743
80347
|
},
|
|
77744
80348
|
"401": {
|
|
@@ -77756,33 +80360,103 @@ var clientsData = [
|
|
|
77756
80360
|
}
|
|
77757
80361
|
}
|
|
77758
80362
|
],
|
|
77759
|
-
|
|
80363
|
+
WellDrilloutUnitRuns: [
|
|
77760
80364
|
{
|
|
77761
|
-
path: "/
|
|
80365
|
+
path: "/v2/well_drillout_unit_runs",
|
|
77762
80366
|
method: "GET",
|
|
77763
|
-
summary: "List
|
|
80367
|
+
summary: "List well drillout unit runs",
|
|
77764
80368
|
tags: [
|
|
77765
|
-
"
|
|
80369
|
+
"WellDrilloutUnitRuns"
|
|
77766
80370
|
],
|
|
77767
80371
|
parameters: [
|
|
77768
80372
|
{
|
|
77769
|
-
name: "
|
|
80373
|
+
name: "company_id",
|
|
77770
80374
|
"in": "query",
|
|
77771
80375
|
type: "integer",
|
|
77772
80376
|
required: false,
|
|
77773
|
-
description: "
|
|
80377
|
+
description: "Filter by company ID"
|
|
77774
80378
|
},
|
|
77775
80379
|
{
|
|
77776
|
-
name: "
|
|
80380
|
+
name: "well_id",
|
|
77777
80381
|
"in": "query",
|
|
77778
80382
|
type: "integer",
|
|
77779
80383
|
required: false,
|
|
77780
|
-
description: "
|
|
80384
|
+
description: "Filter by well ID"
|
|
80385
|
+
},
|
|
80386
|
+
{
|
|
80387
|
+
name: "drillout_unit_id",
|
|
80388
|
+
"in": "query",
|
|
80389
|
+
type: "integer",
|
|
80390
|
+
required: false,
|
|
80391
|
+
description: "Filter by drillout unit ID"
|
|
80392
|
+
},
|
|
80393
|
+
{
|
|
80394
|
+
name: "fields",
|
|
80395
|
+
"in": "query",
|
|
80396
|
+
type: "any",
|
|
80397
|
+
required: false,
|
|
80398
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
80399
|
+
},
|
|
80400
|
+
{
|
|
80401
|
+
name: "per_page",
|
|
80402
|
+
"in": "query",
|
|
80403
|
+
type: "integer",
|
|
80404
|
+
required: false,
|
|
80405
|
+
description: "Number of well drillout unit runs per page"
|
|
80406
|
+
},
|
|
80407
|
+
{
|
|
80408
|
+
name: "page",
|
|
80409
|
+
"in": "query",
|
|
80410
|
+
type: "integer",
|
|
80411
|
+
required: false,
|
|
80412
|
+
description: "Page number"
|
|
77781
80413
|
}
|
|
77782
80414
|
],
|
|
77783
80415
|
responses: {
|
|
77784
80416
|
"200": {
|
|
77785
|
-
description: "
|
|
80417
|
+
description: "List well drillout unit runs",
|
|
80418
|
+
schema: "any"
|
|
80419
|
+
},
|
|
80420
|
+
"401": {
|
|
80421
|
+
description: "Authentication error",
|
|
80422
|
+
schema: "any"
|
|
80423
|
+
},
|
|
80424
|
+
"403": {
|
|
80425
|
+
description: "Authorization error",
|
|
80426
|
+
schema: "any"
|
|
80427
|
+
},
|
|
80428
|
+
"404": {
|
|
80429
|
+
description: "Not found error",
|
|
80430
|
+
schema: "any"
|
|
80431
|
+
}
|
|
80432
|
+
}
|
|
80433
|
+
},
|
|
80434
|
+
{
|
|
80435
|
+
path: "/v2/well_drillout_unit_runs/{id}",
|
|
80436
|
+
method: "GET",
|
|
80437
|
+
summary: "Get a single well drillout unit run",
|
|
80438
|
+
tags: [
|
|
80439
|
+
"WellDrilloutUnitRuns"
|
|
80440
|
+
],
|
|
80441
|
+
parameters: [
|
|
80442
|
+
{
|
|
80443
|
+
name: "id",
|
|
80444
|
+
"in": "path",
|
|
80445
|
+
type: "integer",
|
|
80446
|
+
required: true,
|
|
80447
|
+
description: "Well Drillout Unit Run ID"
|
|
80448
|
+
},
|
|
80449
|
+
{
|
|
80450
|
+
name: "fields",
|
|
80451
|
+
"in": "query",
|
|
80452
|
+
type: "any",
|
|
80453
|
+
required: false,
|
|
80454
|
+
description: "Respond with only the given list of fields, like well_drillout_unit_run.well_id"
|
|
80455
|
+
}
|
|
80456
|
+
],
|
|
80457
|
+
responses: {
|
|
80458
|
+
"200": {
|
|
80459
|
+
description: "Get well drillout unit run",
|
|
77786
80460
|
schema: "any"
|
|
77787
80461
|
},
|
|
77788
80462
|
"401": {
|
|
@@ -91597,16 +94271,18 @@ var entries = [
|
|
|
91597
94271
|
id: "component-v1-VirtualizedTable",
|
|
91598
94272
|
type: "component",
|
|
91599
94273
|
name: "VirtualizedTable",
|
|
91600
|
-
description: "",
|
|
94274
|
+
description: "Virtualized table.",
|
|
91601
94275
|
keywords: [
|
|
91602
|
-
"virtualizedtable"
|
|
94276
|
+
"virtualizedtable",
|
|
94277
|
+
"virtualized",
|
|
94278
|
+
"table."
|
|
91603
94279
|
],
|
|
91604
94280
|
tags: [
|
|
91605
94281
|
"v1"
|
|
91606
94282
|
],
|
|
91607
94283
|
category: "components-v1",
|
|
91608
94284
|
importPath: "@corva/ui/components",
|
|
91609
|
-
searchText: "virtualizedtable
|
|
94285
|
+
searchText: "virtualizedtable virtualized table. virtualizedtable virtualized table."
|
|
91610
94286
|
},
|
|
91611
94287
|
{
|
|
91612
94288
|
id: "component-v1-WellSummary",
|
|
@@ -92392,11 +95068,22 @@ var entries = [
|
|
|
92392
95068
|
"enable",
|
|
92393
95069
|
"disable",
|
|
92394
95070
|
"alertdefinitions",
|
|
92395
|
-
"
|
|
95071
|
+
"subscribe",
|
|
95072
|
+
"unsubscribe",
|
|
92396
95073
|
"alert_groups",
|
|
95074
|
+
"alert_definitions",
|
|
95075
|
+
"alertgroups",
|
|
92397
95076
|
"alert_group_users",
|
|
92398
95077
|
"alert_group_assets",
|
|
92399
95078
|
"alert_group_configurations",
|
|
95079
|
+
"bulk_create",
|
|
95080
|
+
"bulk_destroy",
|
|
95081
|
+
"alertrbac",
|
|
95082
|
+
"alert_abilities",
|
|
95083
|
+
"companies",
|
|
95084
|
+
"alert_roles",
|
|
95085
|
+
"abilities",
|
|
95086
|
+
"alert_rbac",
|
|
92400
95087
|
"occurrences",
|
|
92401
95088
|
"acknowledge",
|
|
92402
95089
|
"classify",
|
|
@@ -92440,7 +95127,6 @@ var entries = [
|
|
|
92440
95127
|
"dashboards",
|
|
92441
95128
|
"users",
|
|
92442
95129
|
"dashboard_apps",
|
|
92443
|
-
"bulk_create",
|
|
92444
95130
|
"batch_update",
|
|
92445
95131
|
"dashboard_folders",
|
|
92446
95132
|
"dashboard_shares",
|
|
@@ -92449,6 +95135,12 @@ var entries = [
|
|
|
92449
95135
|
"clone",
|
|
92450
95136
|
"use_template",
|
|
92451
95137
|
"available_timezones",
|
|
95138
|
+
"well plan checklists",
|
|
95139
|
+
"well_plan_checklists",
|
|
95140
|
+
"well plans",
|
|
95141
|
+
"well_plans",
|
|
95142
|
+
"well plan tabs",
|
|
95143
|
+
"well_plan_tabs",
|
|
92452
95144
|
"well planning dashboards",
|
|
92453
95145
|
"well_planning_dashboards",
|
|
92454
95146
|
"data",
|
|
@@ -92484,9 +95176,7 @@ var entries = [
|
|
|
92484
95176
|
"count",
|
|
92485
95177
|
"unread",
|
|
92486
95178
|
"security_policies",
|
|
92487
|
-
"companies",
|
|
92488
95179
|
"permissions",
|
|
92489
|
-
"bulk_destroy",
|
|
92490
95180
|
"grouped",
|
|
92491
95181
|
"picklists",
|
|
92492
95182
|
"items",
|
|
@@ -92593,8 +95283,6 @@ var entries = [
|
|
|
92593
95283
|
"update_package",
|
|
92594
95284
|
"apperroralert",
|
|
92595
95285
|
"app_error_alerts",
|
|
92596
|
-
"subscribe",
|
|
92597
|
-
"unsubscribe",
|
|
92598
95286
|
"usage",
|
|
92599
95287
|
"summaries",
|
|
92600
95288
|
"workflows",
|
|
@@ -92676,6 +95364,8 @@ var entries = [
|
|
|
92676
95364
|
"test_connection",
|
|
92677
95365
|
"api_key_audits",
|
|
92678
95366
|
"typewells",
|
|
95367
|
+
"welldrilloutunitruns",
|
|
95368
|
+
"well_drillout_unit_runs",
|
|
92679
95369
|
"padfracfleets",
|
|
92680
95370
|
"pad_frac_fleets",
|
|
92681
95371
|
"fracfleetcontracts",
|
|
@@ -92702,7 +95392,7 @@ var entries = [
|
|
|
92702
95392
|
],
|
|
92703
95393
|
category: "clients",
|
|
92704
95394
|
importPath: "@corva/ui/clients",
|
|
92705
|
-
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
|
|
95395
|
+
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"
|
|
92706
95396
|
},
|
|
92707
95397
|
{
|
|
92708
95398
|
id: "client-corvaDataAPI",
|