@corva/ui 3.71.0-9 → 3.72.0-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs-bundle/components/AddComment/Popover.js +1 -1
- package/cjs-bundle/components/AddComment/Popover.js.map +1 -1
- package/cjs-bundle/components/AddComment/components/Content.js +1 -1
- package/cjs-bundle/components/AddComment/components/Content.js.map +1 -1
- package/cjs-bundle/components/AttachFileButton/AttachFileButton.js +1 -1
- package/cjs-bundle/components/AttachFileButton/AttachFileButton.js.map +1 -1
- package/cjs-bundle/components/AttachmentPreview/AttachmentPreview.js +1 -1
- package/cjs-bundle/components/AttachmentPreview/AttachmentPreview.js.map +1 -1
- package/cjs-bundle/components/AttachmentPreview/AttachmentPreview.scss.js +1 -1
- package/cjs-bundle/components/AttachmentPreview/AttachmentRow.js +2 -0
- package/cjs-bundle/components/AttachmentPreview/AttachmentRow.js.map +1 -0
- package/cjs-bundle/components/AttachmentPreview/AttachmentTile.js +2 -0
- package/cjs-bundle/components/AttachmentPreview/AttachmentTile.js.map +1 -0
- package/cjs-bundle/components/AttachmentPreview/SortableAttachments.js +2 -0
- package/cjs-bundle/components/AttachmentPreview/SortableAttachments.js.map +1 -0
- package/cjs-bundle/components/AttachmentPreview/StoredAttachmentPreview.js +1 -1
- package/cjs-bundle/components/AttachmentPreview/StoredAttachmentPreview.js.map +1 -1
- package/cjs-bundle/components/AttachmentPreview/useStoredAttachments.js +2 -0
- package/cjs-bundle/components/AttachmentPreview/useStoredAttachments.js.map +1 -0
- package/cjs-bundle/components/BICOffsetPickerDialog/index.js +1 -1
- package/cjs-bundle/components/BICOffsetPickerDialog/index.js.map +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/CasingJoints/Editor.js +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/CasingJoints/Editor.js.map +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/Component.js +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/Component.js.map +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/DrillPipe/Editor.js +1 -1
- package/cjs-bundle/components/Casing/CasingTableV2/components/DrillPipe/Editor.js.map +1 -1
- package/cjs-bundle/components/CommentCard/CommentCard.js +1 -1
- package/cjs-bundle/components/CommentCard/CommentCard.js.map +1 -1
- package/cjs-bundle/components/CommentCard/CommentCardReplies.js +1 -1
- package/cjs-bundle/components/CommentCard/CommentCardReplies.js.map +1 -1
- package/cjs-bundle/components/CommentCard/buildCommentReply.js +1 -1
- package/cjs-bundle/components/CommentCard/buildCommentReply.js.map +1 -1
- package/cjs-bundle/components/CommentComposer/CommentComposer.js +1 -1
- package/cjs-bundle/components/CommentComposer/CommentComposer.js.map +1 -1
- package/cjs-bundle/components/CommentComposer/CommentReplyInput.js +1 -1
- package/cjs-bundle/components/CommentComposer/CommentReplyInput.js.map +1 -1
- package/cjs-bundle/components/CommentComposer/useAttachmentUpload.js +1 -1
- package/cjs-bundle/components/CommentComposer/useAttachmentUpload.js.map +1 -1
- package/cjs-bundle/components/CommentInputNext/CommentInputNext.js +1 -1
- package/cjs-bundle/components/CommentInputNext/CommentInputNext.js.map +1 -1
- package/cjs-bundle/components/CommentInputNext/CommentInputNext.scss.js +1 -1
- package/cjs-bundle/components/CommentInputNext/useFileDrop.js +2 -0
- package/cjs-bundle/components/CommentInputNext/useFileDrop.js.map +1 -0
- package/cjs-bundle/components/DocumentViewer/DocumentViewer.js +1 -1
- package/cjs-bundle/components/DocumentViewer/DocumentViewer.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Agitator/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Agitator/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Bit/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Bit/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Component.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Component.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/DrillCollar/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/DrillCollar/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/DrillPipe/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/DrillPipe/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Jar/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Jar/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Lwd/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Lwd/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Mwd/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Mwd/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Pdm/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Pdm/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Rss/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Rss/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Stabilizer/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Stabilizer/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Sub/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Sub/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Ur/Editor.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/Ur/Editor.js.map +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/shared/ConfirmationPopup.js +1 -1
- package/cjs-bundle/components/Drillstring/BHAComponentsTable/components/shared/ConfirmationPopup.js.map +1 -1
- package/cjs-bundle/components/FeedCard/useActivityInteractions.js +1 -1
- package/cjs-bundle/components/FeedCard/useActivityInteractions.js.map +1 -1
- package/cjs-bundle/components/FeedCard/useFeedActivity.js +1 -1
- package/cjs-bundle/components/FeedCard/useFeedActivity.js.map +1 -1
- package/cjs-bundle/components/IconMenu/index.js +1 -1
- package/cjs-bundle/components/IconMenu/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Filter/ToggleMapButton.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Filter/ToggleMapButton.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Table/MetricsAddMenu.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV2/components/Table/MetricsAddMenu.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/MetricsAddMenu.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/MetricsAddMenu.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/CustomSelectionView/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/OffsetWellSelectionView/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/OffsetWellSelectionView/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/TabSelection/ToggleMapButton.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/TabSelection/ToggleMapButton.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/TabSelection/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/TabSelection/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/WellHubView/index.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/WellHubView/index.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/shared/OffsetWellTableHead.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV3/components/shared/OffsetWellTableHead.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/Filter/components/CustomDateFields/CustomDateFields.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/Filter/components/CustomDateFields/CustomDateFields.js.map +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.js +1 -1
- package/cjs-bundle/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.js.map +1 -1
- package/cjs-bundle/components/PadOffsetsPicker/StagesSelector.js +1 -1
- package/cjs-bundle/components/PadOffsetsPicker/StagesSelector.js.map +1 -1
- package/cjs-bundle/components/PadOffsetsPickerV2/PadOffsetsPickerV2.js +1 -1
- package/cjs-bundle/components/PadOffsetsPickerV2/PadOffsetsPickerV2.js.map +1 -1
- package/cjs-bundle/components/index.js +1 -1
- package/cjs-bundle/componentsV2/AppContainer/AppContainer.scss.js +1 -1
- package/cjs-bundle/componentsV2/AppHeader/V3/Actions/Actions.scss.js +1 -1
- package/cjs-bundle/componentsV2/AppHeader/V3/AppTitle/AppTitle.js +1 -1
- package/cjs-bundle/componentsV2/AppHeader/V3/AppTitle/AppTitle.js.map +1 -1
- package/cjs-bundle/componentsV2/AppHeader/V3/AppTitle/AppTitle.scss.js +1 -1
- package/cjs-bundle/componentsV2/Autocomplete/Autocomplete.js +1 -1
- package/cjs-bundle/componentsV2/Autocomplete/Autocomplete.js.map +1 -1
- package/cjs-bundle/componentsV2/Autocomplete/Autocomplete.scss.js +1 -1
- package/cjs-bundle/componentsV2/Autocomplete/AutocompleteMenuItem.js +1 -1
- package/cjs-bundle/componentsV2/Autocomplete/AutocompleteMenuItem.js.map +1 -1
- package/cjs-bundle/componentsV2/Checkbox/Checkbox.js +1 -1
- package/cjs-bundle/componentsV2/Checkbox/Checkbox.js.map +1 -1
- package/cjs-bundle/componentsV2/ColorPicker/ColorPicker.scss.js +1 -1
- package/cjs-bundle/componentsV2/Menu/Menu.scss.js +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuDivider/MenuDivider.scss.js +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuGroup/MenuGroup.js +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuGroup/MenuGroup.js.map +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuGroup/MenuGroup.scss.js +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuItem/MenuItem.js +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuItem/MenuItem.js.map +1 -1
- package/cjs-bundle/componentsV2/Menu/MenuItem/MenuItem.scss.js +1 -1
- package/cjs-bundle/componentsV2/PadModeSelect/PadModeSelect.scss.js +1 -1
- package/cjs-bundle/componentsV2/Paper/Paper.js +1 -1
- package/cjs-bundle/componentsV2/Paper/Paper.js.map +1 -1
- package/cjs-bundle/componentsV2/Paper/Paper.scss.js +1 -1
- package/cjs-bundle/componentsV2/Popover/Popover.js +1 -1
- package/cjs-bundle/componentsV2/Popover/Popover.js.map +1 -1
- package/cjs-bundle/componentsV2/Radio/Radio.js +1 -1
- package/cjs-bundle/componentsV2/Radio/Radio.js.map +1 -1
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.js +2 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.js.map +1 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.scss.js +2 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.scss.js.map +1 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/RadioIcon.js +2 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/RadioIcon.js.map +1 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/RadioIcon.scss.js +2 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxIcons/RadioIcon.scss.js.map +1 -0
- package/cjs-bundle/componentsV2/RadioAndCheckboxLabel/RadioAndCheckboxLabel.scss.js +1 -1
- package/cjs-bundle/componentsV2/Tabs/Tabs.js +1 -1
- package/cjs-bundle/componentsV2/Tabs/Tabs.js.map +1 -1
- package/cjs-bundle/componentsV2/Tabs/Tabs.scss.js +1 -1
- package/cjs-bundle/componentsV2/TemplatesControl/ShareModal/ShareModal.js +1 -1
- package/cjs-bundle/componentsV2/TemplatesControl/ShareModal/ShareModal.js.map +1 -1
- package/cjs-bundle/componentsV2/TemplatesControl/ShareModal/ShareModal.scss.js +1 -1
- package/cjs-bundle/componentsV2/TemplatesControl/TemplatesTreeMenuHeader/TemplatesTreeMenuHeader.scss.js +1 -1
- package/cjs-bundle/componentsV2/TemplatesControl/Toggle/Toggle.scss.js +1 -1
- package/cjs-bundle/config/theme/checkboxOverrides.js +1 -1
- package/cjs-bundle/config/theme/checkboxOverrides.js.map +1 -1
- package/cjs-bundle/config/theme/index.js +1 -1
- package/cjs-bundle/config/theme/index.js.map +1 -1
- package/cjs-bundle/config/theme/radioOverrides.js +1 -1
- package/cjs-bundle/config/theme/radioOverrides.js.map +1 -1
- package/cjs-bundle/constants/attachments.js +2 -0
- package/cjs-bundle/constants/attachments.js.map +1 -0
- package/cjs-bundle/constants/index.js +1 -1
- package/components/AddComment/Popover.js +1 -1
- package/components/AddComment/Popover.js.map +1 -1
- package/components/AddComment/components/Content.js +1 -1
- package/components/AddComment/components/Content.js.map +1 -1
- package/components/AttachFileButton/AttachFileButton.d.ts +2 -1
- package/components/AttachFileButton/AttachFileButton.d.ts.map +1 -1
- package/components/AttachFileButton/AttachFileButton.js +1 -1
- package/components/AttachFileButton/AttachFileButton.js.map +1 -1
- package/components/AttachmentPreview/AttachmentPreview.d.ts +4 -0
- package/components/AttachmentPreview/AttachmentPreview.d.ts.map +1 -1
- package/components/AttachmentPreview/AttachmentPreview.js +1 -1
- package/components/AttachmentPreview/AttachmentPreview.js.map +1 -1
- package/components/AttachmentPreview/AttachmentPreview.scss.js +1 -1
- package/components/AttachmentPreview/AttachmentPreview.types.d.ts +2 -0
- package/components/AttachmentPreview/AttachmentPreview.types.d.ts.map +1 -1
- package/components/AttachmentPreview/AttachmentRow.d.ts +5 -0
- package/components/AttachmentPreview/AttachmentRow.d.ts.map +1 -0
- package/components/AttachmentPreview/AttachmentRow.js +2 -0
- package/components/AttachmentPreview/AttachmentRow.js.map +1 -0
- package/components/AttachmentPreview/AttachmentTile.d.ts +9 -0
- package/components/AttachmentPreview/AttachmentTile.d.ts.map +1 -0
- package/components/AttachmentPreview/AttachmentTile.js +2 -0
- package/components/AttachmentPreview/AttachmentTile.js.map +1 -0
- package/components/AttachmentPreview/SortableAttachments.d.ts +8 -0
- package/components/AttachmentPreview/SortableAttachments.d.ts.map +1 -0
- package/components/AttachmentPreview/SortableAttachments.js +2 -0
- package/components/AttachmentPreview/SortableAttachments.js.map +1 -0
- package/components/AttachmentPreview/StoredAttachmentPreview.d.ts +3 -3
- package/components/AttachmentPreview/StoredAttachmentPreview.d.ts.map +1 -1
- package/components/AttachmentPreview/StoredAttachmentPreview.js +1 -1
- package/components/AttachmentPreview/StoredAttachmentPreview.js.map +1 -1
- package/components/AttachmentPreview/index.d.ts +3 -0
- package/components/AttachmentPreview/index.d.ts.map +1 -1
- package/components/AttachmentPreview/useStoredAttachments.d.ts +8 -0
- package/components/AttachmentPreview/useStoredAttachments.d.ts.map +1 -0
- package/components/AttachmentPreview/useStoredAttachments.js +2 -0
- package/components/AttachmentPreview/useStoredAttachments.js.map +1 -0
- package/components/BICOffsetPickerDialog/index.js +1 -1
- package/components/BICOffsetPickerDialog/index.js.map +1 -1
- package/components/Casing/CasingTableV2/components/CasingJoints/Editor.js +1 -1
- package/components/Casing/CasingTableV2/components/CasingJoints/Editor.js.map +1 -1
- package/components/Casing/CasingTableV2/components/Component.js +1 -1
- package/components/Casing/CasingTableV2/components/Component.js.map +1 -1
- package/components/Casing/CasingTableV2/components/DrillPipe/Editor.js +1 -1
- package/components/Casing/CasingTableV2/components/DrillPipe/Editor.js.map +1 -1
- package/components/CommentCard/CommentCard.d.ts.map +1 -1
- package/components/CommentCard/CommentCard.js +1 -1
- package/components/CommentCard/CommentCard.js.map +1 -1
- package/components/CommentCard/CommentCard.types.d.ts +5 -1
- package/components/CommentCard/CommentCard.types.d.ts.map +1 -1
- package/components/CommentCard/CommentCardReplies.js +1 -1
- package/components/CommentCard/CommentCardReplies.js.map +1 -1
- package/components/CommentCard/__tests__/buildCommentReply.test.d.ts +2 -0
- package/components/CommentCard/__tests__/buildCommentReply.test.d.ts.map +1 -0
- package/components/CommentCard/buildCommentReply.d.ts +15 -7
- package/components/CommentCard/buildCommentReply.d.ts.map +1 -1
- package/components/CommentCard/buildCommentReply.js +1 -1
- package/components/CommentCard/buildCommentReply.js.map +1 -1
- package/components/CommentComposer/CommentComposer.d.ts +8 -3
- package/components/CommentComposer/CommentComposer.d.ts.map +1 -1
- package/components/CommentComposer/CommentComposer.js +1 -1
- package/components/CommentComposer/CommentComposer.js.map +1 -1
- package/components/CommentComposer/CommentReplyInput.d.ts +6 -2
- package/components/CommentComposer/CommentReplyInput.d.ts.map +1 -1
- package/components/CommentComposer/CommentReplyInput.js +1 -1
- package/components/CommentComposer/CommentReplyInput.js.map +1 -1
- package/components/CommentComposer/useAttachmentUpload.d.ts +15 -6
- package/components/CommentComposer/useAttachmentUpload.d.ts.map +1 -1
- package/components/CommentComposer/useAttachmentUpload.js +1 -1
- package/components/CommentComposer/useAttachmentUpload.js.map +1 -1
- package/components/CommentInputNext/CommentInputNext.d.ts +6 -0
- package/components/CommentInputNext/CommentInputNext.d.ts.map +1 -1
- package/components/CommentInputNext/CommentInputNext.js +1 -1
- package/components/CommentInputNext/CommentInputNext.js.map +1 -1
- package/components/CommentInputNext/CommentInputNext.scss.js +1 -1
- package/components/CommentInputNext/useFileDrop.d.ts +17 -0
- package/components/CommentInputNext/useFileDrop.d.ts.map +1 -0
- package/components/CommentInputNext/useFileDrop.js +2 -0
- package/components/CommentInputNext/useFileDrop.js.map +1 -0
- package/components/DocumentViewer/DocumentViewer.js +1 -1
- package/components/DocumentViewer/DocumentViewer.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Agitator/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Agitator/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Bit/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Bit/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Component.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Component.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/DrillCollar/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/DrillCollar/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/DrillPipe/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/DrillPipe/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Jar/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Jar/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Lwd/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Lwd/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Mwd/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Mwd/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Pdm/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Pdm/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Rss/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Rss/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Stabilizer/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Stabilizer/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Sub/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Sub/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Ur/Editor.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/Ur/Editor.js.map +1 -1
- package/components/Drillstring/BHAComponentsTable/components/shared/ConfirmationPopup.js +1 -1
- package/components/Drillstring/BHAComponentsTable/components/shared/ConfirmationPopup.js.map +1 -1
- package/components/FeedCard/useActivityInteractions.d.ts +9 -2
- package/components/FeedCard/useActivityInteractions.d.ts.map +1 -1
- package/components/FeedCard/useActivityInteractions.js +1 -1
- package/components/FeedCard/useActivityInteractions.js.map +1 -1
- package/components/FeedCard/useFeedActivity.d.ts.map +1 -1
- package/components/FeedCard/useFeedActivity.js +1 -1
- package/components/FeedCard/useFeedActivity.js.map +1 -1
- package/components/IconMenu/index.d.ts +1 -1
- package/components/IconMenu/index.js +1 -1
- package/components/IconMenu/index.js.map +1 -1
- package/components/OffsetWellPickerV2/components/Filter/ToggleMapButton.js +1 -1
- package/components/OffsetWellPickerV2/components/Filter/ToggleMapButton.js.map +1 -1
- package/components/OffsetWellPickerV2/components/Table/MetricsAddMenu.js +1 -1
- package/components/OffsetWellPickerV2/components/Table/MetricsAddMenu.js.map +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/MetricsAddMenu.js +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/components/Table/MetricsAddMenu.js.map +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/index.js +1 -1
- package/components/OffsetWellPickerV3/components/CustomSelectionView/index.js.map +1 -1
- package/components/OffsetWellPickerV3/components/OffsetWellSelectionView/index.js +1 -1
- package/components/OffsetWellPickerV3/components/OffsetWellSelectionView/index.js.map +1 -1
- package/components/OffsetWellPickerV3/components/TabSelection/ToggleMapButton.js +1 -1
- package/components/OffsetWellPickerV3/components/TabSelection/ToggleMapButton.js.map +1 -1
- package/components/OffsetWellPickerV3/components/TabSelection/index.js +1 -1
- package/components/OffsetWellPickerV3/components/TabSelection/index.js.map +1 -1
- package/components/OffsetWellPickerV3/components/WellHubView/index.js +1 -1
- package/components/OffsetWellPickerV3/components/WellHubView/index.js.map +1 -1
- package/components/OffsetWellPickerV3/components/shared/OffsetWellTableHead.js +1 -1
- package/components/OffsetWellPickerV3/components/shared/OffsetWellTableHead.js.map +1 -1
- package/components/OffsetWellPickerV5/components/Filter/components/CustomDateFields/CustomDateFields.js +1 -1
- package/components/OffsetWellPickerV5/components/Filter/components/CustomDateFields/CustomDateFields.js.map +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.js +1 -1
- package/components/OffsetWellPickerV5/components/OffsetWellPickerContent/OffsetWellPickerContent.js.map +1 -1
- package/components/PadOffsetsPicker/StagesSelector.js +1 -1
- package/components/PadOffsetsPicker/StagesSelector.js.map +1 -1
- package/components/PadOffsetsPickerV2/PadOffsetsPickerV2.js +1 -1
- package/components/PadOffsetsPickerV2/PadOffsetsPickerV2.js.map +1 -1
- package/components/index.d.ts +2 -0
- package/components/index.d.ts.map +1 -1
- package/components/index.js +1 -1
- package/componentsV2/AppContainer/AppContainer.scss.js +1 -1
- package/componentsV2/AppHeader/V3/Actions/Actions.scss.js +1 -1
- package/componentsV2/AppHeader/V3/AppTitle/AppTitle.d.ts.map +1 -1
- package/componentsV2/AppHeader/V3/AppTitle/AppTitle.js +1 -1
- package/componentsV2/AppHeader/V3/AppTitle/AppTitle.js.map +1 -1
- package/componentsV2/AppHeader/V3/AppTitle/AppTitle.scss.js +1 -1
- package/componentsV2/Autocomplete/Autocomplete.d.ts +5 -1
- package/componentsV2/Autocomplete/Autocomplete.d.ts.map +1 -1
- package/componentsV2/Autocomplete/Autocomplete.js +1 -1
- package/componentsV2/Autocomplete/Autocomplete.js.map +1 -1
- package/componentsV2/Autocomplete/Autocomplete.scss.js +1 -1
- package/componentsV2/Autocomplete/AutocompleteMenuItem.d.ts +7 -3
- package/componentsV2/Autocomplete/AutocompleteMenuItem.d.ts.map +1 -1
- package/componentsV2/Autocomplete/AutocompleteMenuItem.js +1 -1
- package/componentsV2/Autocomplete/AutocompleteMenuItem.js.map +1 -1
- package/componentsV2/Autocomplete/AutocompleteNext.stories.d.ts.map +1 -1
- package/componentsV2/Checkbox/Checkbox.d.ts.map +1 -1
- package/componentsV2/Checkbox/Checkbox.js +1 -1
- package/componentsV2/Checkbox/Checkbox.js.map +1 -1
- package/componentsV2/ColorPicker/ColorPicker.scss.js +1 -1
- package/componentsV2/Menu/Menu.scss.js +1 -1
- package/componentsV2/Menu/Menu.stories.d.ts +1 -0
- package/componentsV2/Menu/Menu.stories.d.ts.map +1 -1
- package/componentsV2/Menu/MenuDivider/MenuDivider.scss.js +1 -1
- package/componentsV2/Menu/MenuGroup/MenuGroup.js +1 -1
- package/componentsV2/Menu/MenuGroup/MenuGroup.js.map +1 -1
- package/componentsV2/Menu/MenuGroup/MenuGroup.scss.js +1 -1
- package/componentsV2/Menu/MenuItem/MenuItem.d.ts +2 -0
- package/componentsV2/Menu/MenuItem/MenuItem.d.ts.map +1 -1
- package/componentsV2/Menu/MenuItem/MenuItem.js +1 -1
- package/componentsV2/Menu/MenuItem/MenuItem.js.map +1 -1
- package/componentsV2/Menu/MenuItem/MenuItem.scss.js +1 -1
- package/componentsV2/PadModeSelect/PadModeSelect.scss.js +1 -1
- package/componentsV2/Paper/Paper.d.ts.map +1 -1
- package/componentsV2/Paper/Paper.js +1 -1
- package/componentsV2/Paper/Paper.js.map +1 -1
- package/componentsV2/Paper/Paper.scss.js +1 -1
- package/componentsV2/Popover/Popover.d.ts.map +1 -1
- package/componentsV2/Popover/Popover.js +1 -1
- package/componentsV2/Popover/Popover.js.map +1 -1
- package/componentsV2/Radio/Radio.d.ts.map +1 -1
- package/componentsV2/Radio/Radio.js +1 -1
- package/componentsV2/Radio/Radio.js.map +1 -1
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.d.ts +5 -0
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.d.ts.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.js +2 -0
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.js.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.scss.js +2 -0
- package/componentsV2/RadioAndCheckboxIcons/CheckboxIcon.scss.js.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.d.ts +2 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.d.ts.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.js +2 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.js.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.scss.js +2 -0
- package/componentsV2/RadioAndCheckboxIcons/RadioIcon.scss.js.map +1 -0
- package/componentsV2/RadioAndCheckboxIcons/index.d.ts +3 -0
- package/componentsV2/RadioAndCheckboxIcons/index.d.ts.map +1 -0
- package/componentsV2/RadioAndCheckboxLabel/RadioAndCheckboxLabel.scss.js +1 -1
- package/componentsV2/Tabs/Tabs.d.ts +1 -0
- package/componentsV2/Tabs/Tabs.d.ts.map +1 -1
- package/componentsV2/Tabs/Tabs.js +1 -1
- package/componentsV2/Tabs/Tabs.js.map +1 -1
- package/componentsV2/Tabs/Tabs.scss.js +1 -1
- package/componentsV2/Tabs/Tabs.stories.d.ts +1 -1
- package/componentsV2/Tabs/Tabs.stories.d.ts.map +1 -1
- package/componentsV2/TemplatesControl/ShareModal/ShareModal.d.ts.map +1 -1
- package/componentsV2/TemplatesControl/ShareModal/ShareModal.js +1 -1
- package/componentsV2/TemplatesControl/ShareModal/ShareModal.js.map +1 -1
- package/componentsV2/TemplatesControl/ShareModal/ShareModal.scss.js +1 -1
- package/componentsV2/TemplatesControl/TemplatesTreeMenuHeader/TemplatesTreeMenuHeader.scss.js +1 -1
- package/componentsV2/TemplatesControl/Toggle/Toggle.scss.js +1 -1
- package/config/theme/checkboxOverrides.d.ts +0 -9
- package/config/theme/checkboxOverrides.d.ts.map +1 -1
- package/config/theme/checkboxOverrides.js +1 -1
- package/config/theme/checkboxOverrides.js.map +1 -1
- package/config/theme/index.d.ts.map +1 -1
- package/config/theme/index.js +1 -1
- package/config/theme/index.js.map +1 -1
- package/config/theme/radioOverrides.d.ts +3 -15
- package/config/theme/radioOverrides.d.ts.map +1 -1
- package/config/theme/radioOverrides.js +1 -1
- package/config/theme/radioOverrides.js.map +1 -1
- package/constants/attachments.d.ts +2 -0
- package/constants/attachments.d.ts.map +1 -0
- package/constants/attachments.js +2 -0
- package/constants/attachments.js.map +1 -0
- package/constants/index.d.ts +2 -1
- package/constants/index.d.ts.map +1 -1
- package/constants/index.js +1 -1
- package/mcp-server/server.mjs +79 -11
- package/package.json +5 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/cjs-bundle/components/AttachmentPreview/useStoredAttachment.js +0 -2
- package/cjs-bundle/components/AttachmentPreview/useStoredAttachment.js.map +0 -1
- package/components/AttachmentPreview/useStoredAttachment.js +0 -2
- package/components/AttachmentPreview/useStoredAttachment.js.map +0 -1
package/mcp-server/server.mjs
CHANGED
|
@@ -248,7 +248,7 @@ const validateDsn = dsn => {
|
|
|
248
248
|
|
|
249
249
|
const MCP_SERVER_VERSION = '1.4.1';
|
|
250
250
|
|
|
251
|
-
var version = "3.
|
|
251
|
+
var version = "3.72.0-0";
|
|
252
252
|
|
|
253
253
|
const CORVA_UI_VERSION = version;
|
|
254
254
|
|
|
@@ -4230,7 +4230,7 @@ var componentsV2Data = [{
|
|
|
4230
4230
|
}, {
|
|
4231
4231
|
name: "PrefixAndSuffix",
|
|
4232
4232
|
description: "You can display arbitrary content as prefix and/or suffix by using `prefix` and `suffix` props. Note that if those are [valid React elements](https://react.dev/reference/react/isValidElement), `size` and `className` props will be injected",
|
|
4233
|
-
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const anchorRef = useRef<HTMLButtonElement>(null);\n\n const affixes = [SettingTwoIcon, BubbleChartIcon, AlarmClockIcon, ApplicationIcon];\n\n return (\n <>\n <Button ref={anchorRef} onClick={() => setIsOpen(true)}>\n Open Menu\n </Button>\n <Menu open={isOpen} anchorEl={anchorRef.current} onClose={() => setIsOpen(false)}>\n {affixes.map((Icon, index) => (\n <Menu.Item key={index} prefix={<Icon />} size=\"large\">\n {options[index]}\n </Menu.Item>\n ))}\n
|
|
4233
|
+
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const anchorRef = useRef<HTMLButtonElement>(null);\n\n const affixes = [SettingTwoIcon, BubbleChartIcon, AlarmClockIcon, ApplicationIcon];\n\n return (\n <>\n <Button ref={anchorRef} onClick={() => setIsOpen(true)}>\n Open Menu\n </Button>\n <Menu open={isOpen} anchorEl={anchorRef.current} onClose={() => setIsOpen(false)}>\n {affixes.map((Icon, index) => (\n <Menu.Item key={index} prefix={<Icon />} size=\"large\">\n {options[index]}\n </Menu.Item>\n ))}\n <Menu.Divider />\n {affixes.map((Icon, index) => (\n <Menu.Item key={index} suffix={<Icon />} size=\"large\">\n {options[index]}\n </Menu.Item>\n ))}\n <Menu.Divider />\n {affixes.map((Icon, index) => (\n <Menu.Item key={index} prefix={<Icon />} size=\"medium\">\n {options[index]}\n </Menu.Item>\n ))}\n <Menu.Divider />\n {affixes.map((I\n// ... (truncated)"
|
|
4234
4234
|
}, {
|
|
4235
4235
|
name: "Checkboxes",
|
|
4236
4236
|
description: "Component has a special integration with `<Checkbox/>` component to allow \"multi-select\" menus. Use `<Menu.Divider/>` to separate the \"Select All\" option from the rest",
|
|
@@ -4239,6 +4239,10 @@ var componentsV2Data = [{
|
|
|
4239
4239
|
name: "Groups",
|
|
4240
4240
|
description: "You can separate menu items into groups by using the `<Menu.Group/>` component",
|
|
4241
4241
|
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const anchorRef = useRef<HTMLButtonElement>(null);\n return (\n <>\n <Button ref={anchorRef} onClick={() => setIsOpen(true)}>\n Open Menu\n </Button>\n <Menu open={isOpen} anchorEl={anchorRef.current} onClose={() => setIsOpen(false)}>\n <Menu.Group label=\"Some Group\">\n {options.map(item => (\n <Menu.Item key={item} onClick={() => setIsOpen(false)}>\n {item}\n </Menu.Item>\n ))}\n </Menu.Group>\n <Menu.Group label=\"Other Group\">\n {options.map(item => (\n <Menu.Item key={item} onClick={() => setIsOpen(false)}>\n {item}\n </Menu.Item>\n ))}\n </Menu.Group>\n </Menu>\n </>\n );\n}"
|
|
4242
|
+
}, {
|
|
4243
|
+
name: "Dividers",
|
|
4244
|
+
description: "You can separate menu items with a line by using the `<Menu.Divider/>` component",
|
|
4245
|
+
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const anchorRef = useRef<HTMLButtonElement>(null);\n return (\n <>\n <Button ref={anchorRef} onClick={() => setIsOpen(true)}>\n Open Menu\n </Button>\n <Menu open={isOpen} anchorEl={anchorRef.current} onClose={() => setIsOpen(false)}>\n {options.map((item, i) => (\n <Fragment key={item}>\n {i === 3 && <Menu.Divider />}\n <Menu.Item onClick={() => setIsOpen(false)}>{item}</Menu.Item>\n </Fragment>\n ))}\n </Menu>\n </>\n );\n}"
|
|
4242
4246
|
}, {
|
|
4243
4247
|
name: "ConstrainedMenu",
|
|
4244
4248
|
description: "This example demonstrates a very common usecase: when menu has a fixed width and may have a scroll. In this case, menu size is controlled with `className` prop. It is recommended to use `<TextMiddleTruncated/>` to truncate menu items' text content",
|
|
@@ -4250,7 +4254,7 @@ var componentsV2Data = [{
|
|
|
4250
4254
|
}, {
|
|
4251
4255
|
name: "SubMenus",
|
|
4252
4256
|
description: "This example illustrates a basic case of \"nested\" Menus",
|
|
4253
|
-
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const [isSubMenuOpen, setIsSubMenuOpen] = useState(false);\n const
|
|
4257
|
+
code: "{\n const [isOpen, setIsOpen] = useState(false);\n const anchorRef = useRef<HTMLButtonElement>(null);\n const subMenuAnchorRef = useRef<HTMLLIElement>(null);\n const [isSubMenuOpen, setIsSubMenuOpen] = useState(false);\n const closeTimerRef = useRef<NodeJS.Timeout>();\n\n const close = useCallback(() => {\n setIsOpen(false);\n setIsSubMenuOpen(false);\n }, []);\n\n const onMouseEnter = useCallback(() => {\n clearTimeout(closeTimerRef.current);\n setIsSubMenuOpen(true);\n }, []);\n\n const onMouseLeave = useCallback(() => {\n clearTimeout(closeTimerRef.current);\n closeTimerRef.current = setTimeout(() => {\n setIsSubMenuOpen(false);\n }, 500);\n }, []);\n\n return (\n <>\n <Button ref={anchorRef} onClick={() => setIsOpen(true)}>\n Open Menu\n </Button>\n\n <Menu open={isOpen} anchorEl={anchorRef.current} onClose={close}>\n <Menu.Item>Menu Item</Menu.Item>\n <Menu.Item\n onClick={() => setIsSubMenuOpen(true)}\n ref={subMenuAnch\n// ... (truncated)"
|
|
4254
4258
|
}],
|
|
4255
4259
|
sourceUrl: "https://github.com/corva-ai/corva-ui/blob/develop/src/componentsV2/Menu.tsx",
|
|
4256
4260
|
figmaUrl: "https://www.figma.com/file/PUgBxjNswqqG1yyU6OQERZ/Corva-Design-System?node-id=9597-17471",
|
|
@@ -4912,6 +4916,18 @@ var componentsV2Data = [{
|
|
|
4912
4916
|
examples: [],
|
|
4913
4917
|
sourceUrl: "https://github.com/corva-ai/corva-ui/blob/develop/src/componentsV2/RadioAndCheckboxGroup/RadioAndCheckboxGroup.tsx",
|
|
4914
4918
|
keywords: ["radioandcheckboxgroup"]
|
|
4919
|
+
}, {
|
|
4920
|
+
name: "RadioAndCheckboxIcons",
|
|
4921
|
+
modulePath: "componentsV2/RadioAndCheckboxIcons",
|
|
4922
|
+
importPath: "@corva/ui/componentsV2",
|
|
4923
|
+
category: "v2",
|
|
4924
|
+
description: "",
|
|
4925
|
+
isExperimental: false,
|
|
4926
|
+
isDeprecated: false,
|
|
4927
|
+
props: [],
|
|
4928
|
+
examples: [],
|
|
4929
|
+
sourceUrl: "https://github.com/corva-ai/corva-ui/blob/develop/src/componentsV2/RadioAndCheckboxIcons/RadioAndCheckboxIcons.tsx",
|
|
4930
|
+
keywords: ["radioandcheckboxicons"]
|
|
4915
4931
|
}, {
|
|
4916
4932
|
name: "RadioAndCheckboxLabel",
|
|
4917
4933
|
modulePath: "componentsV2/RadioAndCheckboxLabel",
|
|
@@ -5605,15 +5621,15 @@ var componentsV2Data = [{
|
|
|
5605
5621
|
examples: [{
|
|
5606
5622
|
name: "Default",
|
|
5607
5623
|
description: "",
|
|
5608
|
-
code: "{\n const [value, setValue] = useState(items[1].value);\n return (\n <Tabs\n {...props}\n items={items}\n value={value}\n onChange={(
|
|
5624
|
+
code: "{\n const [value, setValue] = useState(items[1].value);\n return (\n <Tabs\n {...props}\n items={items}\n value={value}\n onChange={(newValue: string) => {\n props.onChange?.(newValue);\n setValue(newValue);\n }}\n />\n );\n}"
|
|
5609
5625
|
}, {
|
|
5610
5626
|
name: "Sizes",
|
|
5611
5627
|
description: "Component supports different sizes through its `size` prop\n\n- `medium` (default)\n- `small`",
|
|
5612
5628
|
code: "<SbColumn alignItems=\"stretch\">\n <Tabs size=\"medium\" value={items[1].value} items={shortItems} type=\"primary\" />\n <Tabs size=\"small\" value={items[1].value} items={shortItems} type=\"primary\" />\n </SbColumn>"
|
|
5613
5629
|
}, {
|
|
5614
|
-
name: "
|
|
5615
|
-
description: "You can add prefixes to tabs by providing the `prefix`
|
|
5616
|
-
code: "{\n const itemsPrefixed = shortItems.map(item => ({ ...item, prefix: <ChartLineIcon /> }));\n return (\n <SbColumn alignItems=\"stretch\">\n <Tabs value={
|
|
5630
|
+
name: "WithPrefixAndSuffix",
|
|
5631
|
+
description: "You can add prefixes and/or suffixes to tabs by providing the `prefix` and/or `suffix` properties in `items`' item",
|
|
5632
|
+
code: "{\n const itemsPrefixed = shortItems.map(item => ({ ...item, prefix: <ChartLineIcon /> }));\n const itemsSuffixed = shortItems.map(item => ({ ...item, suffix: <ChartLineIcon /> }));\n return (\n <SbColumn alignItems=\"stretch\">\n <Tabs value={itemsPrefixed[1].value} items={itemsPrefixed} type=\"secondary\" size=\"medium\" />\n <Tabs value={itemsPrefixed[1].value} items={itemsPrefixed} type=\"secondary\" size=\"small\" />\n\n <Tabs value={itemsSuffixed[1].value} items={itemsSuffixed} type=\"secondary\" size=\"medium\" />\n <Tabs value={itemsSuffixed[1].value} items={itemsSuffixed} type=\"secondary\" size=\"small\" />\n </SbColumn>\n );\n}"
|
|
5617
5633
|
}, {
|
|
5618
5634
|
name: "Types",
|
|
5619
5635
|
description: "Component supports different types through its `type` prop\n\n- `primary` (default)\n- `secondary`\n- `tertiary`\n",
|
|
@@ -7148,6 +7164,11 @@ var componentsV1Data = [{
|
|
|
7148
7164
|
type: "string",
|
|
7149
7165
|
required: false,
|
|
7150
7166
|
description: ""
|
|
7167
|
+
}, {
|
|
7168
|
+
name: "multiple",
|
|
7169
|
+
type: "boolean",
|
|
7170
|
+
required: false,
|
|
7171
|
+
description: ""
|
|
7151
7172
|
}, {
|
|
7152
7173
|
name: "testId",
|
|
7153
7174
|
type: "string",
|
|
@@ -7244,6 +7265,10 @@ var componentsV1Data = [{
|
|
|
7244
7265
|
name: "Default",
|
|
7245
7266
|
description: "",
|
|
7246
7267
|
code: "<div style={{ background: '#1c1c1c', padding: 24, width: 420 }}>\n <AttachmentPreview\n onRemove={() => {}}\n items={[\n { id: 1, name: 'log.png', kind: 'image', src: img },\n { id: 2, name: 'run.mp4', kind: 'video', src: img },\n { id: 3, name: 'Corva report.xls', kind: 'file' },\n { id: 4, name: 'notes.pdf', kind: 'file' },\n ]}\n />\n </div>"
|
|
7268
|
+
}, {
|
|
7269
|
+
name: "Reorderable",
|
|
7270
|
+
description: "",
|
|
7271
|
+
code: "{\n const [items, setItems] = useState(REORDERABLE);\n\n return (\n <div style={{ background: '#1c1c1c', padding: 24, width: 420 }}>\n <AttachmentPreview\n items={items}\n onRemove={id => setItems(prev => prev.filter(item => item.id !== id))}\n onReorder={orderedIds =>\n setItems(prev =>\n orderedIds.map(\n id => prev.find(item => String(item.id) === String(id)) as Props['items'][number]\n )\n )\n }\n />\n </div>\n );\n}"
|
|
7247
7272
|
}, {
|
|
7248
7273
|
name: "Uploading",
|
|
7249
7274
|
description: "",
|
|
@@ -8988,15 +9013,30 @@ var componentsV1Data = [{
|
|
|
8988
9013
|
type: "CommentComposerUser",
|
|
8989
9014
|
required: true,
|
|
8990
9015
|
description: ""
|
|
9016
|
+
}, {
|
|
9017
|
+
name: "attachments",
|
|
9018
|
+
type: "UploadedAttachment[]",
|
|
9019
|
+
required: false,
|
|
9020
|
+
description: ""
|
|
9021
|
+
}, {
|
|
9022
|
+
name: "onAttachmentsChange",
|
|
9023
|
+
type: "(attachments: UploadedAttachment[]) => void",
|
|
9024
|
+
required: false,
|
|
9025
|
+
description: ""
|
|
9026
|
+
}, {
|
|
9027
|
+
name: "maxAttachments",
|
|
9028
|
+
type: "number",
|
|
9029
|
+
required: false,
|
|
9030
|
+
description: ""
|
|
8991
9031
|
}, {
|
|
8992
9032
|
name: "attachment",
|
|
8993
9033
|
type: "UploadedAttachment | null",
|
|
8994
|
-
required:
|
|
9034
|
+
required: false,
|
|
8995
9035
|
description: ""
|
|
8996
9036
|
}, {
|
|
8997
9037
|
name: "onAttachmentChange",
|
|
8998
9038
|
type: "(attachment: UploadedAttachment | null) => void",
|
|
8999
|
-
required:
|
|
9039
|
+
required: false,
|
|
9000
9040
|
description: ""
|
|
9001
9041
|
}, {
|
|
9002
9042
|
name: "attachmentError",
|
|
@@ -15414,6 +15454,13 @@ var constantsData = [{
|
|
|
15414
15454
|
description: "Common CSS class names used across components",
|
|
15415
15455
|
type: "constant",
|
|
15416
15456
|
keywords: ["classnames", "constant", "config"]
|
|
15457
|
+
}, {
|
|
15458
|
+
name: "DRAGGING_ATTRIBUTE",
|
|
15459
|
+
modulePath: "constants/attachments",
|
|
15460
|
+
importPath: "@corva/ui/constants",
|
|
15461
|
+
description: "Constant exported from attachments",
|
|
15462
|
+
type: "constant",
|
|
15463
|
+
keywords: ["dragging_attribute", "g_", "dragging", "attribute", "constant", "config"]
|
|
15417
15464
|
}];
|
|
15418
15465
|
|
|
15419
15466
|
var clientsData = [{name:"corvaAPI",modulePath:"clients",importPath:"@corva/ui/clients",description:"Main API client for Corva platform. Provides methods for GET, PUT, PATCH, POST, DELETE requests.",methods:[{name:"get",signature:"(path: string, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a GET request"},{name:"getWithHeaders",signature:"(path: string, queryParams?: object, requestOptions?: object) => Promise<{ data: any, headers: Headers }>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<{ data: any, headers: Headers }>",description:"Perform a GET request and return response with headers"},{name:"put",signature:"(path: string, content: any, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"content",type:"any",required:true,description:"Request body content"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a PUT request"},{name:"patch",signature:"(path: string, content: any, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"content",type:"any",required:true,description:"Request body content"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a PATCH request"},{name:"post",signature:"(path: string, entity: any, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"entity",type:"any",required:true,description:"Request body entity"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a POST request"},{name:"del",signature:"(path: string, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a DELETE request"}],keywords:["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","save_as_template","enable","disable","alertdefinitions","subscribe","unsubscribe","alert_groups","alert_definitions","alertgroups","alert_group_users","alert_group_scopes","alert_group_configurations","bulk_create","bulk_destroy","bulk_replace","metrics","alertrbac","alert_abilities","companies","alert_roles","abilities","alert_rbac","occurrences","series","acknowledge","classify","transition","escalate","deescalate","totals","details","alerttags","alert_tags","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","copy","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","notificationpolicies","notification_policies","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","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","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","reset_data_schedules","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","tool ordering","tool_ordering","orders","submit","components","final_specs","proposals","specifications","vendors","memberships","vendor_contacts","vendor_directory","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"],endpoints:[{path:"v2/ability_check/check_feature",method:"GET",summary:"Check feature status for user",tags:["AbilityCheck"],parameters:[{name:"feature_name","in":"query",type:"string",required:true,description:"Name of Feature"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"v2/ability_check/check_permission",method:"GET",summary:"Check permission status for user",tags:["AbilityCheck"],parameters:[{name:"ability","in":"query",type:"string",required:true,description:"Ability to check"},{name:"resource_class","in":"query",type:"string",required:true,description:"Class of resource"},{name:"resource_id","in":"query",type:"integer",required:false,description:"Id of resource if checking permission for particular entity"},{name:"name","in":"query",type:"integer",required:false,description:"Dataset name"},{name:"provider","in":"query",type:"integer",required:false,description:"Dataset provider"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities",method:"GET",summary:"List activities",tags:["Feed"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"type","in":"query",type:"any",required:false,description:"List of asset types"},{name:"rigs","in":"query",type:"any",required:false,description:"Ids of rigs to search for"},{name:"assets","in":"query",type:"any",required:false,description:"Ids of assets to search for"},{name:"users","in":"query",type:"any",required:false,description:"Ids of users to search for"},{name:"apps","in":"query",type:"any",required:false,description:"Ids of apps to search for"},{name:"is_recommendation","in":"query",type:"boolean",required:false,description:"Search geosteering_comments based on isRecommendation field"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"List activities",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities",method:"POST",summary:"Create an activity",tags:["Feed"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created activity",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"GET",summary:"Show activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"PATCH",summary:"Update an activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated activity",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"DELETE",summary:"Delete an activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],responses:{"200":{description:"Activity deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/{alert_id}/activities",method:"GET",summary:"List Alert Activities",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"order","in":"query",type:"string",required:false,description:"Sort order by created_at (started_at is an alias): desc (default) or asc"},{name:"activity","in":"query",type:"string",required:false,description:"Filter by activity type"},{name:"user_id","in":"query",type:"integer",required:false,description:"Filter by user ID"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page, default 25, max 100"}],responses:{"200":{description:"Successful response",schema:"{ data: { id: string, type: string, attributes: any }[] }"},"400":{description:"Invalid activity filter"},"401":{description:"Unauthorized"},"403":{description:"Forbidden"},"404":{description:"Alert not found"}}},{path:"/v1/alerts/{alert_id}/comments/",method:"GET",summary:"List comments for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/",method:"POST",summary:"Create a comment for alert",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"GET",summary:"Show comment for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"PATCH",summary:"Update an alert comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"DELETE",summary:"Delete an alert comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Alert comment deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{comment_id}/likes",method:"GET",summary:"List likes for alert's comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{comment_id}/likes/toggle",method:"POST",summary:"Toggle a like for alert's comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Created/deleted alert like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/likes",method:"GET",summary:"List likes for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/likes/toggle",method:"POST",summary:"Toggle a like for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Created/deleted alert like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions",method:"GET",summary:"List Alert Definitions",tags:["Alerts"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"template_type","in":"query",type:"string",required:false,description:"Filter by template type: standard or preset"},{name:"topic","in":"query",type:"string",required:false,description:"Filter by topic"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/context",method:"GET",summary:"Gather Alert Definition Context",tags:["Alerts"],parameters:[{name:"asset_id","in":"query",type:"any",required:false,description:"Asset to gather context from"},{name:"identifier","in":"query",type:"any",required:false,description:"Alert definition identifier to check against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/trigger",method:"POST",summary:"Trigger Alert",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/close",method:"POST",summary:"Close Open Alerts",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/check",method:"POST",summary:"Check Alert Definition in point of time",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"any",required:false,description:"Alert definition to check"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/templates/{template_type}",method:"GET",summary:"List Alert Definition Templates",tags:["Alerts"],parameters:[{name:"template_type","in":"path",type:"string",required:true,description:"Template type: standard or preset"},{name:"scope","in":"query",type:"string",required:false,description:"Library shelf to list. \"corva\" (default) lists Corva-owned templates, swapping in the caller's copy where one exists. \"company\" lists templates owned by the current company. \"user\" lists the current user's personal templates."}],responses:{"200":{description:"Successful response - returns templates or their overrides",schema:"any[]"},"400":{description:"Invalid template_type or scope parameter"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/{id}/save_as_template",method:"POST",summary:"Save Alert Definition as Library Template",tags:["Alerts"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Source alert definition id"},{name:"template_type","in":"query",type:"string",required:true,description:"Template type: standard or preset"},{name:"scope","in":"query",type:"string",required:false,description:"Target library shelf. \"company\" (default) saves a company-owned template, \"user\" saves a personal template for the current user, \"corva\" saves to the Corva library (Corva principals only). The source definition is unaffected."}],responses:{"200":{description:"The created template",schema:"any"},"400":{description:"Invalid template_type or scope parameter"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not allowed to create templates on the target shelf"},"404":{description:"Alert definition not found"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/enable",method:"POST",summary:"Enable Alert Definition Template",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"integer",required:true,description:"Template alert definition ID to enable"},{name:"alert_group_id","in":"query",type:"integer",required:false,description:"Optional alert group to associate the enabled alert with"}],responses:{"200":{description:"Successful response - returns enabled alerts (new copy or existing overrides)",schema:"any"},"400":{description:"Enabled alert is not valid for the given alert group"},"401":{description:"Authentication error",schema:"any"},"403":{description:"User is not authorized to update the given alert group"},"404":{description:"Alert definition not found or is not a template, or alert group not found"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/disable",method:"POST",summary:"Disable Alert Definition Template",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"integer",required:true,description:"Template alert definition ID to disable"}],responses:{"200":{description:"Successful response - returns disabled alert override",schema:"any"},"400":{description:"No enabled alert definition found for this template"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Alert definition not found or is not a template"}}},{path:"/v2/alerts/definitions",method:"GET",summary:"List Alert Definitions",tags:["AlertDefinitions"],parameters:[{name:"type","in":"query",type:"string",required:false,description:"Filter by type (personal/company)"},{name:"alert_group_id","in":"query",type:"string",required:false,description:"Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"segment","in":"query",type:"string",required:false,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."},{name:"alert_tag_ids","in":"query",type:"string",required:false,description:"Filter by alert tag: a single value or a comma-separated list of tag ids and/or names (numeric values are treated as ids, names match case-insensitively). Matches definitions tagged with any of the given tags."},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert definitions",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions",method:"POST",summary:"Create Alert Definition",tags:["AlertDefinitions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert definition",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"GET",summary:"Get Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Alert definition details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"PATCH",summary:"Update Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert definition",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"DELETE",summary:"Delete Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}/subscribe",method:"POST",summary:"Subscribe to Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Subscription created; activates an inactive definition"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Subscription already exists"}}},{path:"/v2/alerts/definitions/{id}/unsubscribe",method:"POST",summary:"Unsubscribe from Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Unsubscribed; deactivates a personal definition left without subscriptions"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_definitions",method:"GET",summary:"List an Alert Group's Definitions",tags:["AlertDefinitions"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:"Alert group ID"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type (personal/company)"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"alert_tag_ids","in":"query",type:"string",required:false,description:"Filter by alert tag: a single value or a comma-separated list of tag ids and/or names (numeric values are treated as ids, names match case-insensitively). Matches definitions tagged with any of the given tags."},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups",method:"GET",summary:"List Alert Groups",tags:["AlertGroups"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups",method:"POST",summary:"Create Alert Group",tags:["AlertGroups"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"GET",summary:"Get Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Alert group details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"PATCH",summary:"Update Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert group",schema:"any"},"400":{description:"Validation error, including changing segment while the group has scopes or configuration overrides whose type is invalid for the new segment"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"DELETE",summary:"Delete Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users",method:"GET",summary:"List Group Members",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users",method:"POST",summary:"Add Member to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added member",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",method:"DELETE",summary:"Remove Member from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes",method:"GET",summary:"List Group Scopes",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of group scope targets",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes",method:"POST",summary:"Add Scope Target to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added scope target",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/{id}",method:"DELETE",summary:"Remove Scope Target from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations",method:"GET",summary:"List Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of configurations",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations",method:"POST",summary:"Create Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created configuration",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",method:"PATCH",summary:"Update Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated configuration",schema:"any"},"400":{description:"Validation error, or scope_type/scope_id provided without the other — the pair must always be updated together"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",method:"DELETE",summary:"Delete Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",method:"POST",summary:"Bulk Add Members to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Members added (idempotent — users already in the group are skipped)",schema:"any"},"400":{description:"Validation error; no members were added"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",method:"DELETE",summary:"Bulk Remove Members from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Members removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_create",method:"POST",summary:"Bulk Add Scope Targets to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope targets added (idempotent — targets already in the group are skipped)",schema:"any"},"400":{description:"Validation error; no scope targets were added"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_destroy",method:"DELETE",summary:"Bulk Remove Scope Targets from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope targets removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_replace",method:"PUT",summary:"Replace Group Scope Targets",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope set replaced with the payload: targets not in the payload are removed, new ones added, targets already in the group are kept unchanged. An explicit empty scopes array removes all scope targets",schema:"any"},"400":{description:"Missing scopes key or validation error; no changes were made"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",method:"POST",summary:"Bulk Create Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Configurations created (all-or-nothing — none created if any is invalid)",schema:"any"},"400":{description:"Validation error; no configurations were created"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",method:"DELETE",summary:"Bulk Delete Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Configurations removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/metrics",method:"GET",summary:"Alert Occurrence Metrics",tags:["Alerts"],parameters:[{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Occurrence window lower bound (ms); defaults to 7 days ago"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Occurrence window upper bound (ms); defaults to now"},{name:"top","in":"query",type:"integer",required:false,description:"Number of top alert definitions to return; defaults to 10, max 50"},{name:"levels","in":"query",type:"string",required:false,description:"Filter by per-fire level; comma-separated"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID; comma-separated"},{name:"name","in":"query",type:"string",required:false,description:"Filter by Alert Definition name"},{name:"assets","in":"query",type:"string",required:false,description:"Filter by asset IDs; comma-separated"},{name:"rigs","in":"query",type:"string",required:false,description:"Filter by rig (parent asset) IDs; comma-separated"},{name:"interventions","in":"query",type:"string",required:false,description:"Filter by intervention unit IDs; comma-separated"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment; comma-separated"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status; comma-separated"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Restrict to the caller's subscriptions"}],responses:{"200":{description:"Successful response",schema:"{ total_occurrences: number, levels: object, alert_definitions: { alert_definition_id: number, alert_definition_name: string, count: number }[] }"},"400":{description:"Invalid timestamp, range, or top"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_abilities",method:"GET",summary:"List Assignable Alert Abilities",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.",tags:["AlertRBAC"],parameters:[{name:"locale","in":"query",type:"string",required:false,description:"Display-name language; unknown/unsupported locales fall back to English"}],responses:{"200":{description:"Ability catalog",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles",method:"GET",summary:"List Alert Roles",description:"Company-defined alert roles. Gated by `update Company` (company admins only).",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert roles",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles",method:"POST",summary:"Create Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert role",schema:"any"},"400":{description:"Validation error (e.g. blank or duplicate name)"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"GET",summary:"Get Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],responses:{"200":{description:"Alert role details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Role not found in this company"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"PATCH",summary:"Update Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert role",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"DELETE",summary:"Delete Alert Role",description:"Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin, or the role is still assigned to members"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}/abilities",method:"PUT",summary:"Replace Alert Role Abilities",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.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Role with its updated abilities",schema:"any"},"400":{description:"Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_rbac/enable",method:"POST",summary:"Enable Alert RBAC",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.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"RBAC enabled",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"},"422":{description:"No alert role exists yet"}}},{path:"/v2/companies/{company_id}/alert_rbac/disable",method:"POST",summary:"Disable Alert RBAC",description:"Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"RBAC disabled",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/{alert_id}/occurrences",method:"GET",summary:"List Alert Occurrences",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by: start_at (default) or severity"},{name:"order","in":"query",type:"string",required:false,description:"Sort direction: asc (default) or desc"},{name:"page","in":"query",type:"integer",required:false,description:"Page number (enables pagination)"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page, max 1000 (enables pagination)"}],responses:{"200":{description:"Successful response",schema:"{ data: { id: string, type: string, attributes: any }[] }"},"401":{description:"Unauthorized"},"403":{description:"Forbidden"},"404":{description:"Alert not found"}}},{path:"/v2/alerts/occurrences/series",method:"GET",summary:"Alert Occurrence Time-Series",tags:["Alerts"],parameters:[{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Occurrence window lower bound (ms); defaults to 7 days ago"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Occurrence window upper bound (ms); defaults to now"},{name:"timezone","in":"query",type:"string",required:false,description:"IANA timezone for bucketing; defaults to UTC"},{name:"interval","in":"query",type:"string",required:false,description:"Bucket size; auto-selected from the range if omitted"},{name:"levels","in":"query",type:"string",required:false,description:"Filter by per-fire level; comma-separated"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID; comma-separated"},{name:"name","in":"query",type:"string",required:false,description:"Filter by Alert Definition name"},{name:"assets","in":"query",type:"string",required:false,description:"Filter by asset IDs; comma-separated"},{name:"rigs","in":"query",type:"string",required:false,description:"Filter by rig (parent asset) IDs; comma-separated"},{name:"interventions","in":"query",type:"string",required:false,description:"Filter by intervention unit IDs; comma-separated"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment; comma-separated"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status; comma-separated"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Restrict to the caller's subscriptions"}],responses:{"200":{description:"Successful response",schema:"{ interval: \"hour\" | \"day\" | \"month\", timezone: string, data: { bucket: string, groups: object[] }[] }"},"400":{description:"Invalid timezone, timestamp, range, or interval"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts",method:"GET",summary:"List Alerts",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"alert_definition_id","in":"query",type:"integer",required:false,description:"Filter by Alert Definition ID"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status. Supports comma-separated values for multiple statuses (e.g. open,acknowledged)"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"},{name:"sort","in":"query",type:"string",required:false,description:"Column to sort by, one of [alert_at, last_alert_at, created_at, status, status_changed_at, level, occurrences, acknowledged, validated, alert_classification, name]. Unrecognized values fall back to the default sort (alert_at descending)."},{name:"order","in":"query",type:"string",required:false,description:"Sort direction, asc or desc. Applies only when sort is provided and defaults to asc; without sort, results are returned alert_at descending."},{name:"serializer","in":"query",type:"string",required:false,description:"Select serializer to be used with the returned records"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{id}",method:"GET",summary:"Get Alert",tags:["Alerts"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Alert not found"}}},{path:"/v1/alerts/{alert_id}/acknowledge",method:"POST",summary:"Add acknowledgement to alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated acknowledgement",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/acknowledge",method:"POST",summary:"Bulk acknowledge multiple alerts",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"List of alerts with updated acknowledgement",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/classify",method:"POST",summary:"Add alert_classification to alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated alert_classification",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/transition",method:"POST",summary:"Transition alert status",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated status and new activity entry",schema:"any"},"400":{description:"Invalid request (e.g. missing or blank status)"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Unauthorized"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/escalate",method:"POST",summary:"Escalate alert to specific users",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with new active escalation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Invalid request (empty user_ids, users outside company, or alert in terminal state)"}}},{path:"/v1/alerts/{alert_id}/deescalate",method:"POST",summary:"Close active escalation on alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Alert with escalation closed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Only the escalated user or an admin can de-escalate"},"404":{description:"Not found error",schema:"any"},"422":{description:"Alert is not escalated"}}},{path:"/v1/alerts/totals",method:"GET",summary:"Alerts Counts",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"top_alerts_count","in":"query",type:"integer",required:false,description:"Number of Total Alerts, default is 5"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/details",method:"GET",summary:"Alerts Details for given period of time",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"top_alerts_count","in":"query",type:"integer",required:false,description:"Number of Total Alerts, default is 5"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"},{name:"sort","in":"query",type:"string",required:false,description:"Column to sort by, one of [alert_at, last_alert_at, created_at, status, status_changed_at, level, occurrences, acknowledged, validated, alert_classification, name]. Unrecognized values fall back to the default sort (alert_at descending)."},{name:"order","in":"query",type:"string",required:false,description:"Sort direction, asc or desc. Applies only when sort is provided and defaults to asc; without sort, results are returned alert_at descending."}],responses:{"200":{description:"Successful response",schema:"{ data: { alert_definition_id: number, alert_definition_name: string, active: boolean, segment: string, subscription: boolean, ... }[] }"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags",method:"GET",summary:"List Alert Tags",tags:["AlertTags"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert tags for the current company",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags",method:"POST",summary:"Create Alert Tag",tags:["AlertTags"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert tag",schema:"any"},"400":{description:"Validation error, including a name already used in the company, a parent in another company, or a parent that is not a top-level tag"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags/{id}",method:"PATCH",summary:"Update Alert Tag",tags:["AlertTags"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert tag",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags/{id}",method:"DELETE",summary:"Delete Alert Tag",tags:["AlertTags"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted. Child tags and definition taggings are removed as well"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alert_workflows",method:"GET",summary:"List Alert Workflows",tags:["AlertWorkflows"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID (must be nil/current company or a company accessible to the user)"}],responses:{"200":{description:"Returns global workflows and workflows belonging to the current company, optionally filtered by company_id",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alert_workflows/{id}",method:"GET",summary:"Get Alert Workflow",tags:["AlertWorkflows"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AlertWorkflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Workflow not found or not accessible by current company"}}},{path:"/v2/app_reviews",method:"GET",summary:"List accesible App Reviews",tags:["AppReviews"],parameters:[{name:"status","in":"query",type:"any",required:false,description:"Filter by status"},{name:"app_ids","in":"query",type:"any",required:false,description:"Filter by App Ids"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_reviews/{id}/approve",method:"POST",summary:"Approve App Review",tags:["AppReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Review ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_reviews/{id}/decline",method:"POST",summary:"Approve App Review",tags:["AppReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Review ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/favorites",method:"GET",summary:"List favorites",description:"Returns all of the favorites that are saved in a user's settings.favorites key.",tags:["Assets"],parameters:[{name:"fields","in":"query",type:"string",required:false,description:"Filter response fields, example: fields=rig.name,rig.active_well,well.name"}],responses:{"200":{description:"List user favorites",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets",method:"GET",summary:"List assets",tags:["Assets"],parameters:[{name:"types","in":"query",type:"string",required:false,description:"List of asset types"},{name:"status","in":"query",type:"string",required:false,description:"Search by asset status (wells only; status is null for other asset types)"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by asset visibility"},{name:"ids","in":"query",type:"any",required:false,description:"List of asset IDs to filter by"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"parent_asset_id","in":"query",type:"integer",required:false,description:"Search by parent asset ID"},{name:"api_number","in":"query",type:"string",required:false,description:"Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored"},{name:"search","in":"query",type:"string",required:false,description:"Search by asset ID, asset name, api_number or customer_well_id"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"long_start","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"long_end","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"lat_start","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"lat_end","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"company_id","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"api_number","in":"query",type:"string",required:false,description:"Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like asset.asset_type. See example response for fields."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-last_active_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"range_filter_field","in":"query",type:"string",required:false,description:"Filtering datetime with start/end"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than or equal to the given timestamp"},{name:"last_active_drilling_before","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is smaller than the given timestamp"},{name:"last_active_drilling_after","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is greater than or equal to the given timestamp"},{name:"include_rig_id","in":"query",type:"boolean",required:false,description:"Add rig_id to response(only works with Asset::Rig)"},{name:"include_type_wells","in":"query",type:"boolean",required:false,description:"Add type wells to response(only works with Asset::Well)"},{name:"include_intervention_units","in":"query",type:"boolean",required:false,description:"Add intervention units to response"},{name:"polygon_coords","in":"query",type:"array",required:false,description:"Filter by assets within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed."}],responses:{"200":{description:"List assets",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}",method:"GET",summary:"Get asset by ID",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like asset.asset_type"}],responses:{"200":{description:"Show asset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/settings",method:"GET",summary:"Get asset settings",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"app_key","in":"query",type:"string",required:false,description:"App Key"},{name:"segment","in":"query",type:"string",required:false,description:"Used with app_key"},{name:"source_type","in":"query",type:"string",required:false,description:"Used with app_key"},{name:"log_type","in":"query",type:"string",required:false,description:"Used with source_type and app_key"},{name:"app_connection_id","in":"query",type:"integer",required:false,description:"App Connection ID"},{name:"app_stream_id","in":"query",type:"integer",required:false,description:"App Stream ID, used with app_key"}],responses:{"200":{description:"Asset settings, merged with optional connection settings",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_wells",method:"GET",summary:"List type well assets",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Type well assets",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_well",method:"POST",summary:"Create a new type_well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],requestBody:{contentType:"application/json",schema:"number",required:true},responses:{"200":{description:"Newly created type well object",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_wells/{type_well_id}",method:"DELETE",summary:"Delete type_well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"type_well_id","in":"path",type:"integer",required:true,description:"Type Well Id"}],responses:{"200":{description:"Delete type well object",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/reruns",method:"GET",summary:"Return reruns for the asset",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Reruns",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/ancestor_ids",method:"GET",summary:"Return the ancestor_ids for the asset",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Ancestors",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/resolve",method:"POST",summary:"Resolve old-style assets to new-style assets",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Resolution results",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/autocomplete",method:"GET",summary:"Return autocompletion tokens",tags:["Assets"],parameters:[{name:"field","in":"query",type:"string",required:true,description:""},{name:"search","in":"query",type:"string",required:false,description:"Filter by a wildcard search"},{name:"company_id","in":"query",type:"integer",required:false,description:"Corva admins only. Scope to a particular company."}],responses:{"200":{description:"Search results",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs",method:"GET",summary:"List programs",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of program IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"name","in":"query",type:"string",required:false,description:"Search by program name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like program.name"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of programs to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List programs",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs",method:"POST",summary:"Create a program",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"GET",summary:"Get a single program",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Program ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like program.name"}],responses:{"200":{description:"Get program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"PATCH",summary:"Update a program",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"DELETE",summary:"Delete a program",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Program ID"}],responses:{"200":{description:"Program deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/clusters",method:"GET",summary:"Get programs clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of program IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads",method:"GET",operationId:"pads",summary:"List pads",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of pad IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"current_frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID where it is the current Frac Fleet on the Pad"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by pad name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like pad.name"},{name:"active","in":"query",type:"boolean",required:false,description:"Return records that have an active well"},{name:"current","in":"query",type:"boolean",required:false,description:"Return records that are current based on PadFracFleet"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"well_ids","in":"query",type:"any",required:false,description:"Filter by array of well ids"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of pads to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List pads",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads",method:"POST",summary:"Create a pad",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"GET",summary:"Get a single pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Pad ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like pad.name"}],responses:{"200":{description:"Get pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"PATCH",summary:"Update a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"DELETE",summary:"Delete a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad ID"}],responses:{"200":{description:"Pad deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/frac_fleets",method:"POST",summary:"Add a frac fleet to a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/frac_fleets/{id}",method:"DELETE",summary:"Delete a frac fleet from a pad",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Frac Fleet ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/app_wells",method:"GET",summary:"Retrieve wells and app stream details for a pad filtered by app.source_type",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"integer",required:"true",description:"Pad ID"},{name:"dashboard_app_id","in":"query",type:"integer",required:false,description:"Find app by Dashboard app id"},{name:"app_id","in":"query",type:"integer",required:false,description:"Find app by app id"},{name:"app_key","in":"query",type:"string",required:false,description:"Find app by app key"}],responses:{"200":{description:"Pad Details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/wells",method:"GET",summary:"Retrieve well and app stream details for a pad",description:"Retrieve the wells and nested app streams for a pad.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"segment","in":"query",type:"string",required:false,description:"Segments to filter the wells and app streams by"},{name:"source_type","in":"query",type:"string",required:false,description:"Source Types to filter the wells and app streams by"},{name:"log_type","in":"query",type:"string",required:false,description:"Log Types to filter the wells and app streams by"},{name:"status","in":"query",type:"string",required:false,description:"Statuses to filter app streams by"},{name:"include_intervention_units","in":"query",type:"any",required:false,description:"Include intervention units in the response"}],responses:{"200":{description:"Pad Details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/wells",method:"POST",summary:"Add a well to a pad",description:"Set one or more wells so that they belong to a pad.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/wells/{id}",method:"DELETE",summary:"Delete a well from a pad",description:"Remove a well from a pad. Also removes the well from the pad.active_wells list, if found.",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Well ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/active_wells",method:"POST",summary:"Add an active well to a pad",description:"Set one or more wells on a pad so that they are part of the active_wells list. Also adds the wells to the pad.wells list, if not found.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/active_wells/{id}",method:"DELETE",summary:"Delete an active well from a pad",description:"Remove a well from a pad.active_wells list.",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Well ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/clusters",method:"GET",summary:"Get pads clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of pad IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"current_frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID where it is the current Frac Fleet on the Pad"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs",method:"GET",summary:"List rigs",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of rig IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"active_well","in":"query",type:"integer",required:false,description:"Search by active well ID"},{name:"has_active_well","in":"query",type:"integer",required:false,description:"Return rigs that have an active well"},{name:"search","in":"query",type:"string",required:false,description:"Search by rig name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return rigs that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like rig.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of rigs to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: program,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List rigs",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs",method:"POST",summary:"Create a rig",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"GET",summary:"Get a single rig",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Rig ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like rig.name"}],responses:{"200":{description:"Get rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"PATCH",summary:"Update a rig",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"DELETE",summary:"Delete a rig",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig ID"}],responses:{"200":{description:"Rig deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/clusters",method:"GET",summary:"Get rigs clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of rig IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"active_well","in":"query",type:"integer",required:false,description:"Search by active well ID"},{name:"has_active_well","in":"query",type:"integer",required:false,description:"Return rigs that have an active well"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{rig_id}/active_well/well_cache",method:"GET",summary:"Get well_cache record for the active well on the rig",tags:["Assets"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Rig ID"},{name:"Serializer","in":"header",type:"string",required:false,description:"Controls how the data is serialized. Options: \"drilling-widget\""}],responses:{"200":{description:"Well Cache Record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units",method:"GET",summary:"List drillout units",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of drillout unit IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"well","in":"query",type:"integer",required:false,description:"Search by Well ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by drillout unit name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return drillout units that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like drillout_unit.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of drillout units to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List drillout units",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units",method:"POST",summary:"Create a drillout unit",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"GET",summary:"Get a single drillout unit",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Drillout Unit ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like drillout_unit.name"}],responses:{"200":{description:"Get drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"PATCH",summary:"Update a drillout unit",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"DELETE",summary:"Delete a drillout unit",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Drillout Unit ID"}],responses:{"200":{description:"Drillout Unit deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/clusters",method:"GET",summary:"Get drillout units clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of drillout unit IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"well","in":"query",type:"integer",required:false,description:"Search by Well ID"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells",method:"GET",summary:"List wells",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of well IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"status","in":"query",type:"string",required:false,description:"Search by well status"},{name:"state","in":"query",type:"string",required:false,description:"Search by well state"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by well visibility"},{name:"identifier","in":"query",type:"string",required:false,description:"Search by well identifier"},{name:"area","in":"query",type:"string",required:false,description:"Search by well area"},{name:"search","in":"query",type:"string",required:false,description:"Search by well name"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well.name"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"last_active_drilling_before","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is smaller than the given timestamp"},{name:"last_active_drilling_after","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is greater than the given timestamp"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of wells to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,status,visibility,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"filter_by_completed_streams","in":"query",type:"string",required:false,description:"Search by wells that have completed app_streams"},{name:"include_completed_idle_paused_stream","in":"query",type:"boolean",required:false,description:"Add has_completed_idle_paused_stream attribute to response"},{name:"app_segment","in":"query",type:"string",required:false,description:"Add app segment value to find out completed streams"},{name:"app_stream_source_type","in":"query",type:"string",required:false,description:"Search by wells with app_streams by source_type"},{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"distance","in":"query",type:"object",required:false,description:"Hash - latitude/longitude. Will return distance from point specified to well location for each well found."},{name:"point_and_distance","in":"query",type:"object",required:false,description:"Filter by wells between geo point and distance in miles. Subject point is the center of the circle."},{name:"polygon_coords","in":"query",type:"array",required:false,description:"Filter by wells within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed."},{name:"well_start_before","in":"query",type:"integer",required:false,description:"Filter by well_start_before in seconds timestamp"},{name:"well_start_after","in":"query",type:"integer",required:false,description:"Filter by well_start_after in seconds timestamp"},{name:"is_asset_viewer","in":"query",type:"boolean",required:false,description:"Filter by custom_property is_asset_viewer"},{name:"archivation_date_before","in":"query",type:"integer",required:false,description:"Filter by archivation_date_before in seconds timestamp"},{name:"archivation_date_after","in":"query",type:"integer",required:false,description:"Filter by archivation_date_after in seconds timestamp"},{name:"archivation_performer_id","in":"query",type:"array",required:false,description:"Filter by archivation_performer_id"},{name:"intervention_unit_event_id","in":"query",type:"array",required:false,description:"Filter by intervention_unit_event_id"},{name:"intervention_unit_id","in":"query",type:"array",required:false,description:"Filter by intervention_unit_id"}],responses:{"200":{description:"List wells",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells",method:"POST",summary:"Create a well",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"GET",summary:"Get a single well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Well ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well.name"}],responses:{"200":{description:"Get well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"PATCH",summary:"Update a well",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"DELETE",summary:"Delete a well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well ID"}],responses:{"200":{description:"Well deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/clusters",method:"GET",summary:"Get wells clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of well IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"status","in":"query",type:"string",required:false,description:"Search by well status"},{name:"state","in":"query",type:"string",required:false,description:"Search by well state"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by well visibility"},{name:"identifier","in":"query",type:"string",required:false,description:"Search by well identifier"},{name:"area","in":"query",type:"string",required:false,description:"Search by well area"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Well clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets",method:"GET",operationId:"fracFleets",summary:"List frac fleets",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of frac fleet IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"current_pad","in":"query",type:"integer",required:false,description:"Search by Pad ID where it is the current Pad for the Frac Fleet"},{name:"search","in":"query",type:"string",required:false,description:"Search by frac fleet name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return frac fleets that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like frac fleet.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of frac fleets to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List frac fleets",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets",method:"POST",summary:"Create a frac fleet",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"GET",summary:"Get a single frac fleet",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like frac_fleet.name"}],responses:{"200":{description:"Get frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"PATCH",summary:"Update a frac fleet",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"DELETE",summary:"Delete a frac fleet",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Frac Fleet ID"}],responses:{"200":{description:"Frac Fleet deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}/pads",method:"POST",summary:"Add one or more pads to a frac fleet, or set the current pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/pads/{id}",method:"DELETE",summary:"Delete a pad from a frac fleet",tags:["Assets"],parameters:[{name:"frac_fleet_id","in":"path",type:"any",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/active_wells/well_cache",method:"GET",summary:"Get well_cache records for the active wells on the frac fleet",tags:["Assets"],parameters:[{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Frac Fleet ID"},{name:"Serializer","in":"header",type:"string",required:false,description:"Controls how the data is serialized. Options: \"completions-widget\""}],responses:{"200":{description:"Well Cache Record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/clusters",method:"GET",summary:"Get frac fleets clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of frac fleet IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"current_pad","in":"query",type:"integer",required:false,description:"Search by Pad ID where it is the current Pad for the Frac Fleet"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines",method:"GET",summary:"List wirelines",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of wireline IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by wireline name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like wireline.name"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of wirelines to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List wirelines",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines",method:"POST",summary:"Create a wireline",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"GET",summary:"Get a single wireline",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Wireline ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like wireline.name"}],responses:{"200":{description:"Get wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"PATCH",summary:"Update a wireline",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"DELETE",summary:"Delete a wireline",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Wireline ID"}],responses:{"200":{description:"Wireline deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/",method:"GET",summary:"List comments for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"offset","in":"query",type:"integer",required:false,description:"Offset for pagination"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/",method:"POST",summary:"Create a comment for app annotation",tags:["DashboardAppAnnotations"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app annotation comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"GET",summary:"Show comment for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"PATCH",summary:"Update an app annotation comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated app annotation comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"DELETE",summary:"Delete an app annotation comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"App Annotation comment deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes",method:"GET",summary:"List likes for app annotation's comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes/toggle",method:"POST",summary:"Toggle a like for app annotation's comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Created/deleted alert app annotation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/likes",method:"GET",summary:"List likes for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/likes/toggle",method:"POST",summary:"Toggle a like for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"}],responses:{"200":{description:"Created/deleted app annotation like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations",method:"GET",summary:"List annotations for app-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"active","in":"query",type:"boolean",required:false,description:"Set to true to return active annotations, false - to return not active annotations"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID"},{name:"app_id","in":"query",type:"integer",required:false,description:"App ID"},{name:"user_id","in":"query",type:"integer",required:false,description:"Filter by user ID"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user email"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations",method:"POST",summary:"Create an app annotation",tags:["DashboardAppAnnotations"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app annotation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"GET",summary:"Show app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"PATCH",summary:"Update an app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated app annotation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"DELETE",summary:"Delete an app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"App annotation deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}/close",method:"GET",summary:"Closes app annotation for curent user, returns new last annotation for user and app-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/last_annotations",method:"GET",summary:"Returns last app annotations for current user and dashboard or dashboard-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"dashboard_id","in":"query",type:"integer",required:true,description:"Dashboard ID"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID"},{name:"parent_asset_id","in":"query",type:"integer",required:false,description:"Parent Asset ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps",method:"POST",summary:"Create a dashboard app with app name and category",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/bulk_create",method:"POST",summary:"Bulk create dashboard_apps for different asset_ids",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/batch_update",method:"PUT",summary:"Update all dashboard apps in a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"GET",summary:"Show dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"PATCH",summary:"Update a dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],requestBody:{contentType:"application/json",schema:"object",required:true},responses:{"200":{description:"Updated dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"DELETE",summary:"Delete a dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Dashboard app deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders",method:"GET",summary:"List dashboard folders",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders",method:"POST",summary:"Create a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard folder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{id}",method:"PATCH",summary:"Update a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{id}",method:"DELETE",summary:"Delete a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],responses:{"200":{description:"Dashboard folder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares",method:"GET",summary:"List dashboard shares in a dashboard folder for a user",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares",method:"POST",summary:"Add a dashboard share to a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}",method:"PATCH",summary:"Update a dashboard share in a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"},{name:"id","in":"path",type:"integer",required:true,description:"DashboardFolderDashboardShare ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}",method:"DELETE",summary:"Remove a dashboard share from a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"},{name:"id","in":"path",type:"integer",required:true,description:"DashboardFolderDashboardShare ID"}],responses:{"200":{description:"Record deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares",method:"GET",summary:"List dashboard folder shares",tags:["Dashboards"],parameters:[{name:"viewed","in":"query",type:"boolean",required:false,description:"Filter by viewed"},{name:"viewed","in":"owner_id",type:"integer",required:false,description:"Filter by Owner ID"},{name:"viewed","in":"dashboard_folder_id",type:"integer",required:false,description:"Filter by DashboardFolder ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares",method:"POST",summary:"Create a dashboard folder share",tags:["Dashboards"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Dashboard Folder Share",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}",method:"PATCH",summary:"Update a dashboard folder share",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard folder share",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}",method:"DELETE",summary:"Delete a dashboard folder share",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],responses:{"200":{description:"Dashboard folder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}/use",method:"POST",summary:"Use dashboard folder share for user",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Copied dashboard folder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/users/{user_id}/dashboards",method:"GET",summary:"List dashboards for user",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/users/{user_id}/dashboards/{id}",method:"GET",summary:"Get dashboard by ID",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards",method:"GET",summary:"List dashboards",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards",method:"POST",summary:"Create a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"GET",summary:"Show dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"PATCH",summary:"Update a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"DELETE",summary:"Delete a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Dashboard deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}/clone",method:"POST",summary:"Clone a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Cloned dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards/templates",method:"GET",summary:"Get template dashboards",tags:["Dashboards"],parameters:[],responses:{"200":{description:"Template dashboards",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}/use_template",method:"POST",summary:"Set dashboard apps and layout from a template dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Modified dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards",method:"GET",summary:"List all dashboards",tags:["Dashboards"],parameters:[{name:"visibility","in":"query",type:"string",required:false,description:"Filter Dashboards by visibility"},{name:"type","in":"query",type:"string",required:false,description:"Filter Dashboards by type"},{name:"viewed","in":"query",type:"string",required:false,description:"Filter Dashboards by viewed"},{name:"segment","in":"query",type:"string",required:false,description:"Filter Dashboards by segment"},{name:"layout","in":"query",type:"string",required:false,description:"Filter Dashboards by layout"},{name:"category","in":"query",type:"string",required:false,description:"Filter Dashboards by category"},{name:"exclude_shared","in":"query",type:"boolean",required:false,description:"Filter Shared Dashboards"},{name:"can_update","in":"query",type:"boolean",required:false,description:"Filter Dashboards by ability to update"},{name:"sort","in":"query",type:"string",required:false,description:"Sort dashboards by order field"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards/{id}/available_timezones",method:"GET",summary:"List timezones for dashboard",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plan_checklists",method:"GET",summary:"List well plan checklists",tags:["Well Plan Checklists"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plan_checklists/{id}",method:"GET",summary:"Show well plan checklist",tags:["Well Plan Checklists"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan Checklist ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans",method:"GET",summary:"List well plans",tags:["Well Plans"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"kind","in":"query",type:"string",required:false,description:"Filter by well plan kind"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well ID"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"search","in":"query",type:"string",required:false,description:"Case-insensitive search by well plan name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans",method:"POST",summary:"Create a well plan",tags:["Well Plans"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well plan",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/copy",method:"POST",summary:"Copy data from one well plan into another",tags:["Well Plans"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Well plan copy created and enqueued for processing",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"GET",summary:"Show well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"PATCH",summary:"Update well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well plan",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"DELETE",summary:"Delete well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],responses:{"200":{description:"Well plan deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards",method:"GET",summary:"List well planning dashboards",tags:["Well Planning Dashboards"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset ID (well)"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type: custom_well_planning_dashboard (default) or default_well_planning_dashboard"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards",method:"POST",summary:"Create a custom planning dashboard for a well",tags:["Well Planning Dashboards"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well planning dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"GET",summary:"Show well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID used for dashboard timezone/unit overrides"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"PATCH",summary:"Update a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well planning dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"DELETE",summary:"Delete a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"}],responses:{"200":{description:"Well planning dashboard deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",method:"POST",summary:"Create a dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",method:"PUT",summary:"Batch update dashboard apps on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/bulk_create",method:"POST",summary:"Bulk create dashboard apps on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"GET",summary:"Show dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"query",type:"integer",required:false,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"PATCH",summary:"Update dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"DELETE",summary:"Delete dashboard app from a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Dashboard app deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}",method:"GET",summary:"Retrieve records of data from a dataset",description:"Retrieve an array of records from a dataset based on one or more filters. Ensure that all values in the querystring are URL encoded to prevent misinterpretation, especially \"#\" and other symbols.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"company_id","in":"query",type:"integer",required:false,description:"Returns data only for the company with this ID. Otherwise, returns data for the current user or API key company. Only applies to Corva company admins."},{name:"asset_id","in":"query",type:"integer",required:false,description:"Returns data only for the asset with this ID. Otherwise, returns all data."},{name:"query","in":"query",type:"string",required:false,description:"Value for any additional data filters. Accepts fields in the format {field#operator#value}. Ensure the value is URL encoded to avoid misinterpretation. Valid operators are gt, gte, lt, lte, eq, ne, in, exists and elemmatch. Multiple fields can be chained with \"AND\". Example: {state#eq#InSlips}AND{timestamp#gte#1577836800}AND{elements#elemmatch#{\"key\": \"value\"}}"},{name:"where","in":"query",type:"string",required:false,description:"Use a MongoDB $where query. This allows calculations on each data record to filter by. Do not include `function()`."},{name:"map","in":"query",type:"string",required:false,description:"Use a MongoDB $map aggregation. See MongoDB documentation for more detail."},{name:"reduce","in":"query",type:"string",required:false,description:"Use a MongoDB $reduce aggregation. See MongoDB documentation for more detail."},{name:"aggregate","in":"query",type:"string",required:false,description:"MongoDB aggregation pipeline. See MongoDB documentation for more details about pipelines and how to construct them."},{name:"distinct","in":"query",type:"string",required:false,description:"Field name to perform a MongoDB distinct grouping on. See MongoDB documentation for more details about pipelines and how to construct them."},{name:"sort","in":"query",type:"string",required:false,description:"Value for database sorting. Takes one or more fields in a key/value map. Example: {state: 1, timestamp: -1}"},{name:"limit","in":"query",type:"integer",required:false,description:"How many data items to return. Best practice is to limit to a small dataset (usually ~100 records) and paginate to reduce server load and bandwidth. Default: 1. Maximum: 10000."},{name:"fields","in":"query",type:"string",required:false,description:"A comma separated list of fields to return from the queried document."},{name:"projection","in":"query",type:"string",required:false,description:"Use a MongoDB projection. If this field is provided, \"fields\" is ignored."},{name:"filter_inaccessible_assets","in":"query",type:"string",required:false,description:"Filters inaccessible assets from your query or aggregate instead of returning an error message. Set any value to turn filtering on."},{name:"count","in":"query",type:"string",required:false,description:"Returns count of documents after filters applied. \"count=true\" can be passed to receive count response"}],responses:{"200":{description:"List data for a provider and dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}",method:"POST",summary:"Save one or more records of data to a dataset",description:"Create data by inserting it a dataset. The provider and dataset must exist in order for data to be saved, although no error will be raised if either is not found. This endpoint accepts an array of records, and performs an upsert for each record that has a _id value.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."}],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"Return saved data statistics",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}",method:"DELETE",summary:"Delete selected data records from a dataset",description:"Delete multiple records from a dataset, based on data filters that are provided. Use caution and ensure that your filters are not too broad, or you may end up unintentionally deleting data.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"query","in":"query",type:"string",required:false,description:"Value for any data filters. Accepts fields in the format {field#operator#value}. Ensure the value is URL encoded to avoid misinterpretation. Valid operators are gt, gte, lt, lte, eq, ne, and in. Multiple fields can be chained with \"AND\". Example: {state#eq#InSlips}AND{timestamp#gte#1577836800}"}],responses:{"200":{description:"Return deleted count",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"GET",summary:"Retrieve a single data record from a dataset",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Unique ID for the data record"},{name:"fields","in":"query",type:"string",required:false,description:"A comma separated list of fields to return from the queried document."},{name:"projection","in":"query",type:"string",required:false,description:"Use a MongoDB projection. If this field is provided, \"fields\" is ignored."}],responses:{"200":{description:"Show data record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"PUT",summary:"Replace data record in a dataset",description:"Replace fields in a data record. This will completely delete any existing fields and replace them with the new data record that is passed in.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Mongo ObjectID to associate with the data record. Automatically generated if not provided. If provided and it matches an existing record, that record is overwritten. If it does not match an existing record, a new record is inserted."}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Return saved data statistics",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"PATCH",summary:"Update fields in a data record in a dataset",description:"Update metadata and fields in a data record. This will update existing fields and insert any new fields that are found, but will leave all existing fields alone",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Mongo ObjectID to associate with the data record. Automatically generated if not provided. If provided and it matches an existing record, that record is overwritten. If it does not match an existing record, a new record is inserted."}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Return data record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"DELETE",summary:"Delete a single data record from a dataset",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Unique data record identifier for the record to be deleted."}],responses:{"200":{description:"Deletion status"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters",method:"GET",summary:"Get data filters for dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters",method:"POST",summary:"Create a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters#2",method:"POST",summary:"Update multiple data filters",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"GET",summary:"Show data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Data Filter ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"PATCH",summary:"Update a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated data filter",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"DELETE",summary:"Delete a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Data filter deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/file",method:"POST",summary:"Upload a file as form data",tags:["Files"],parameters:[{name:"file","in":"formData",type:"file",required:true,description:"A file to upload"},{name:"s3_key","in":"formData",type:"string",required:true,description:"AWS S3 file identifier"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Invalid file",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/file",method:"PUT",summary:"Update a file by S3 key",tags:["Files"],parameters:[{name:"file","in":"formData",type:"file",required:true,description:"A file to upload"},{name:"s3_key","in":"formData",type:"string",required:true,description:"AWS S3 file identifier"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Invalid file",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/file/sign",method:"GET",summary:"Returns a signed URL",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"asset_id","in":"query",type:"int64",required:false,description:"Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v1/file/preview",method:"GET",summary:"Redirects user to the file via a generated download link",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"302":{description:"Redirect to direct S3 link"}}},{path:"/v1/file/download",method:"GET",summary:"Downloads a file",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"200":{description:"Fetchs a file from S3 link and gets it downloded"}}},{path:"/v1/file/download_link",method:"GET",summary:"Returns a URL where the file can be downloaded",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"response_content_disposition","in":"query",type:"string",required:false,description:"Desired content disposition"},{name:"response_content_type","in":"query",type:"string",required:false,description:"Desired content type"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"200":{description:"Returns the download URL"}}},{path:"/v1/file/delete",method:"DELETE",summary:"Deletes a file",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"}],responses:{"200":{description:"File deleted"}}},{path:"/v2/files",method:"DELETE",summary:"Deletes a file",tags:["Files"],parameters:[{name:"id","in":"query",type:"string",required:false,description:"Folder or File _id"},{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"segment","in":"query",type:"string",required:false,description:"Segment for collection"}],responses:{"200":{description:"File deleted",schema:"any"},"400":{description:"Failure response",schema:"any"},"404":{description:"Not found",schema:"any"}}},{path:"/v2/files/url",method:"GET",summary:"Get signed URL for a file",tags:["Files"],parameters:[{name:"id","in":"query",type:"string",required:false,description:"ID of the file"},{name:"file_name","in":"query",type:"string",required:false,description:"Name of the file"}],responses:{"200":{description:"File url",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found",schema:"any"}}},{path:"/v2/groups",method:"GET",summary:"List Groups",tags:["Security"],parameters:[{name:"users_search","in":"query",type:"string",required:false,description:"Search by users"},{name:"search","in":"query",type:"string",required:false,description:"Search by Group"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups",method:"POST",summary:"Create a Group",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"GET",summary:"Show Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"users_search","in":"query",type:"string",required:false,description:"Search by users inside a Group"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"PATCH",summary:"Update a Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"DELETE",summary:"Delete a Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Group deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}/users",method:"GET",summary:"Show Users for a given Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Current page of items"},{name:"sort","in":"query",type:"string",required:false,description:"A field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"search","in":"query",type:"string",required:false,description:"Search by first_name, last_name, email"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups",method:"GET",summary:"List Groups for User",tags:["Security"],parameters:[],responses:{"200":{description:"Current Groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups",method:"POST",summary:"Add Group to User",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Current Groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups/{id}",method:"DELETE",summary:"Remove a Group from User",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Group Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/assign_users",method:"POST",summary:"Assign users to group",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/copy_users",method:"POST",summary:"Copy users from one group to another",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/resolve",method:"POST",summary:"Resolve an asset based on an array of lookups",tags:["WellView"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Show asset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/ingest",method:"POST",summary:"Send data into Corva for processing",tags:["WellView"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Send the data for processing",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/bha",method:"GET",summary:"Retrieve Corva BHA/Drillstring data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the BHA dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac",method:"GET",summary:"Retrieve Corva Fracking data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Fracking dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_design",method:"GET",summary:"Retrieve Corva Frac Stage Design data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Design dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_summary",method:"GET",summary:"Retrieve Corva Frac Stage Summary data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Summary dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_summary_calculated",method:"GET",summary:"Retrieve Corva Frac Stage Summary Calculated data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Summary Calculated dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/job_settings",method:"GET",summary:"Retrieve Corva Job Settings data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Job Settings dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/plugs",method:"GET",summary:"Retrieve Corva Plugs data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Plugs dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/.well-known/jwks.json",method:"GET",operationId:"getJwks",summary:"Get JWKS public keys",description:"Returns JSON Web Key Set (JWKS) containing public keys for verifying RS256-signed JWT tokens. This is a public endpoint that does not require authentication. External services can use these keys to verify tokens issued by this API. Returns an empty keys array if JWKS is not configured.",tags:["Users"],parameters:[],responses:{"200":{description:"JWKS public key set",schema:"any"}}},{path:"/message_producer",method:"POST",summary:"Produce messages for sent data",tags:["MessageProducer"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications",method:"GET",summary:"List notifications for current user",tags:["Notifications"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"trigger_type","in":"query",type:"array",required:false,description:"Filter by one or more trigger types"},{name:"notification_type","in":"query",type:"array",required:false,description:"Filter by one or more notification types: banner, desktop, sms, mobile, and email"},{name:"level","in":"query",type:"array",required:false,description:"Filter by one or more notification levels: info, warning, and critical"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Filter by whether the notification has been acknowledged"},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/acknowledge",method:"POST",summary:"Acknowledge multiple notifications",tags:["Notifications"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/acknowledge_all",method:"POST",summary:"Acknowledge all notifications for current user",tags:["Notifications"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}/acknowledge",method:"POST",summary:"List notifications for current user",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}",method:"GET",summary:"Show notification",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}",method:"PATCH",summary:"Update notification",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/count/unread",method:"GET",summary:"Get the unread notification count for the current user",tags:["Notifications"],parameters:[{name:"trigger_type","in":"query",type:"array",required:false,description:"Filter by trigger type"}],responses:{"200":{description:"Unread notifications count",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/notification_policies",method:"GET",summary:"List Notification Policies",tags:["NotificationPolicies"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of notification policies accessible to the current user",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/notification_policies",method:"POST",summary:"Create Notification Policy",tags:["NotificationPolicies"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created notification policy",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"A scope row references a record the user cannot read"},"404":{description:"A scope row references a record that does not exist"}}},{path:"/v2/notification_policies/{id}",method:"GET",summary:"Get Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Notification policy details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/notification_policies/{id}",method:"PATCH",summary:"Update Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated notification policy",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"A scope row references a record the user cannot read"},"404":{description:"A scope row references a record that does not exist"}}},{path:"/v2/notification_policies/{id}",method:"DELETE",summary:"Delete Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/security_policies",method:"GET",summary:"List Security Policies",tags:["Security"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/security_policies/{id}",method:"GET",summary:"Show Security Policy",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Security Policy ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies",method:"GET",summary:"List Company Security Policies",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies",method:"POST",summary:"Create a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Company Security Policy",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"GET",summary:"Show Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"PATCH",summary:"Update a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Company Security Policy",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"DELETE",summary:"Delete a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],responses:{"200":{description:"Company Security Policy deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions",method:"GET",summary:"List Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions",method:"POST",summary:"Create a Permission",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"GET",summary:"Show Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"PATCH",summary:"Update a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"DELETE",summary:"Delete a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Permission deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/bulk_create",method:"POST",summary:"Create Multiple Permissions with list of abilities",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{user_id}/permissions/bulk_destroy",method:"DELETE",summary:"Delete Multiple Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"ids","in":"query",type:"any",required:true,description:"List of permission IDs to delete"}],responses:{"200":{description:"Permissions deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions",method:"GET",summary:"List Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions",method:"POST",summary:"Create a Permission",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"GET",summary:"Show Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"PATCH",summary:"Update a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"DELETE",summary:"Delete a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Permission deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/grouped",method:"GET",summary:"List Grouped Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/grouped",method:"GET",summary:"List Grouped Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/bulk_create",method:"POST",summary:"Create Multiple Permissions with list of abilities",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/bulk_destroy",method:"DELETE",summary:"Delete Multiple Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"ids","in":"query",type:"any",required:true,description:"List of permission IDs to delete"}],responses:{"200":{description:"Permissions deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists",method:"GET",summary:"List picklists",tags:["Picklists"],parameters:[],responses:{"200":{description:"List all picklists visible by the current role",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists",method:"POST",summary:"Create a picklist",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}",method:"GET",summary:"Show a single picklist",tags:["Picklists"],parameters:[{name:"name","in":"path",type:"string",required:false,description:"Picklist name identifier"}],responses:{"200":{description:"Show the picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}",method:"PATCH",summary:"Update picklist",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}/items",method:"POST",summary:"Create a picklist item",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created picklist item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}/items/{id}",method:"DELETE",summary:"Delete a picklist item",tags:["Picklists"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Picklist ID"}],responses:{"200":{description:"Item deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks",method:"GET",summary:"List tasks for asset and application",tags:["Tasks"],parameters:[{name:"asset_id","in":"query",type:"integer",required:true,description:"Asset ID"},{name:"app_key","in":"query",type:"string",required:true,description:"App Key for the background app to execute"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"A field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"state","in":"query",type:"string",required:false,description:"Filter by task's state"},{name:"output_type","in":"query",type:"boolean",required:false,description:"Filter by outputType property presence"},{name:"include_performer","in":"query",type:"string",required:false,description:"Include performer User in response"}],responses:{"200":{description:"List all queried tasks",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks",method:"POST",summary:"Create a new task",tags:["Tasks"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Show the created task",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}",method:"GET",summary:"Show Task",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}",method:"PATCH",summary:"Update payload of a task. This endpoint can be used with an api key on a running task",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}/{status}",method:"PUT",summary:"Update task status",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"},{name:"status","in":"query",type:"string",required:true,description:"Status"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Show the task",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#1",method:"POST",summary:"Obtain user token via email + password authentication",description:"Authenticates user and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#2",method:"POST",summary:"Obtain user token via Auth0 SSO authentication",description:"Authenticates user via Auth0 and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#3",method:"POST",summary:"Obtain user token via email + password authentication with multi-factor authentication",description:"Authenticates user with MFA and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#4",method:"POST",summary:"Refresh jwt token using refresh_token",description:"Refreshes JWT token using refresh_token. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/sessions/verification/request",method:"POST",summary:"Request verification code",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"Verification code requested",schema:"{ identity_verification: { required: boolean, enabled: boolean, available_modes: string[], enabled_modes: string[] }, triggered: boolean }"}}},{path:"/v1/sessions/schemas",method:"GET",summary:"Get available authentication schemas",tags:["Users"],parameters:[{name:"email","in":"query",type:"string",required:false,description:"User email"},{name:"provider","in":"query",type:"string",required:false,description:"Provider name to filter by"},{name:"connection","in":"query",type:"string",required:false,description:"Connection name to filter by"},{name:"with_provider","in":"query",type:"boolean",required:false,description:"Include provider and respond with extended format or not. \"false\" by default."}],responses:{"200":{description:"List of available schemas",schema:"any[]"}}},{path:"/v2/users",method:"GET",summary:"List Users",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users",method:"POST",summary:"Create a User",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"GET",summary:"Show User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"PATCH",summary:"Update a User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"DELETE",summary:"Delete a User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"User deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/export",method:"GET",summary:"Export users by company as csv",tags:["Users"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"object"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/streaks",method:"GET",summary:"User Streaks list",tags:["Users"],parameters:[{name:"ids","in":"query",type:"string",required:false,description:"User IDs"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings",method:"GET",summary:"Get all settings for a user",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings",method:"POST",summary:"Add settings for a user",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings/{key}",method:"GET",summary:"Get a setting with a key",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"key","in":"path",type:"string",required:true,description:"Settings key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings/{key}",method:"DELETE",summary:"Delete a setting with a key",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"key","in":"path",type:"string",required:true,description:"Settings key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers",method:"GET",summary:"List Identity Verifiers for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers",method:"POST",summary:"Create Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created Identity Verifier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"GET",summary:"Show Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"PATCH",summary:"Update Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Updated Identity Verifier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"DELETE",summary:"Delete Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],responses:{"200":{description:"Identity Verifier deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/api_keys",method:"GET",summary:"List accessible API keys",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys",method:"POST",summary:"Create an API key",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/current",method:"GET",summary:"Show current API key",description:"Returns the API key used to authenticate the request",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"GET",summary:"Show API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"PATCH",summary:"Update an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"DELETE",summary:"Delete an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"API key deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}/approve",method:"POST",summary:"Approve and activate an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Approved API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}/deactivate",method:"POST",summary:"Deactivate an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Deactivated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps",method:"GET",summary:"List accessible apps",tags:["Apps"],parameters:[{name:"provider","in":"query",type:"any",required:false,description:"Company Provider name"},{name:"company_id","in":"query",type:"any",required:false,description:"Company ID"},{name:"type","in":"query",type:"any",required:false,description:"App type filter"},{name:"segment","in":"query",type:"any",required:false,description:"App segment filter"},{name:"app_category_id","in":"query",type:"any",required:false,description:"AppCategory filter"},{name:"category","in":"query",type:"any",required:false,description:"App category filter"},{name:"label","in":"query",type:"any",required:false,description:"App label"},{name:"owner","in":"query",type:"any",required:false,description:"Search by the user ID of the owner of the app"},{name:"installed","in":"query",type:"boolean",required:false,description:"App installed filter"},{name:"search","in":"query",type:"string",required:false,description:"Search app by name/description/summary/app_key"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"marketing_level","in":"query",type:"string",required:false,description:"Filter by marketing level"},{name:"followable","in":"query",type:"boolean",required:false,description:"Filter by followable flag"},{name:"app_key","in":"query",type:"string",required:false,description:"Filter by app key"},{name:"platform","in":"query",type:"string",required:false,description:"Filter by platform"},{name:"subscribed","in":"query",type:"boolean",required:false,description:"Filter by subscribed/unsubscribed"},{name:"rig_fleet_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Rig"},{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Frac Fleet"},{name:"drillout_unit_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Drillout Unit"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"not_requested","in":"query",type:"boolean",required:false,description:"Filter by non-requested apps"},{name:"not_purchased","in":"query",type:"boolean",required:false,description:"Filter by non-purchased apps"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by log type. Can be \"time\", \"depth\" or \"all\""},{name:"full_lambda_name","in":"query",type:"string",required:false,description:"Find by full_lambda_name"},{name:"followable_scheduler_type","in":"query",type:"string",required:false,description:"Filter by BE app scheduler type allowed to follow. Can be used only when followable - true."},{name:"show_depends_apps","in":"query",type:"boolean",required:false,description:"Show 2-tier depends_on_apps data"},{name:"can_update","in":"query",type:"boolean",required:false,description:"Filter Apps by ability to update"},{name:"exclude_categories","in":"query",type:"array",required:false,description:"Array of app categories to exclude apps from request f.e. settings"},{name:"app_ids","in":"query",type:"array",required:false,description:"Filter apps by ID"},{name:"exclude_ids","in":"query",type:"array",required:false,description:"Filter out apps by ID"},{name:"exclude_app_keys","in":"query",type:"array",required:false,description:"Array of app keys to exclude apps from request"},{name:"dataset_id","in":"query",type:"integer",required:false,description:"Filter by Dataset ID"},{name:"author_id","in":"query",type:"integer",required:false,description:"Filter by Author"},{name:"temporary","in":"query",type:"boolean",required:false,description:"Filter permanent/temporary"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps",method:"POST",summary:"Create an app",tags:["Apps"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"GET",summary:"Show app",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"PATCH",summary:"Update an App",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated App",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"DELETE",summary:"Delete an App",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"App deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}/install",method:"POST",summary:"Install an app for your company",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages",method:"GET",summary:"See all packages for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/packages",method:"GET",summary:"See all packages for an app",tags:["Apps"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/upload",method:"POST",summary:"Upload a new package for an app",description:"Upload a ZIP file for the Dev Center Packager to build and deploy",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"package","in":"formData",type:"file",required:true,description:"Package ZIP file (field name must be package)"},{name:"github_username","in":"formData",type:"string",required:false,description:"Github username (optional)"},{name:"prebuilt","in":"formData",type:"boolean",required:false,description:"If true, indicates the uploaded zip is already built"},{name:"source","in":"formData",type:"string",required:false,description:"Request source (e.g. 'ui')"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}/download",method:"GET",summary:"Download the latest package for an app",description:"Download a ZIP file with the latest app code",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"302":{description:"Fetches a file from S3 link and gets it downloaded"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"GET",summary:"Show a specific packages for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"PATCH",summary:"Update a package",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"DELETE",summary:"Delete a package",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"200":{description:"Package Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/packages/upload",method:"POST",summary:"Upload a new package for an app",description:"Upload a ZIP file for the Dev Center Packager to build and deploy",tags:["Apps"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"package","in":"formData",type:"file",required:true,description:"Package ZIP file (field name must be package)"},{name:"github_username","in":"formData",type:"string",required:false,description:"Github username (optional)"},{name:"prebuilt","in":"formData",type:"boolean",required:false,description:"If true, indicates the uploaded zip is already built"},{name:"source","in":"formData",type:"string",required:false,description:"Request source (e.g. 'ui')"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/app_categories",method:"GET",summary:"List app categories",tags:["Apps"],parameters:[{name:"category","in":"query",type:"string",required:false,description:"Category of the AppCategories to fetch"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"return_as_nested_tree","in":"query",type:"boolean",required:false,description:"Returns AppCategories and Apps in a nested array"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/categories",method:"GET",summary:"List categories from look up table",tags:["Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/featured",method:"GET",summary:"List featured & promoted apps",tags:["Apps"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"marketing_level","in":"query",type:"string",required:false,description:"Filter by marketing level"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/types",method:"GET",summary:"List app types",tags:["Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"POST",summary:"Create a secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"PUT",summary:"Update secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"DELETE",summary:"Delete secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"key","in":"query",type:"string",required:true,description:"Parameter name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets",method:"GET",summary:"List app_datasets for app",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"dataset_operation","in":"query",type:"string",required:false,description:"Filtering by dataset operation. Can be read or write."}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets",method:"POST",summary:"Create an AppDataset",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppDataset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets/{app_dataset_id}",method:"DELETE",summary:"Delete an AppDataset",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppDataset ID"}],responses:{"200":{description:"AppDataset deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets/mark_followable",method:"PATCH",summary:"Mark an AppDataset as followable",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"dataset_id","in":"query",type:"integer",required:true,description:"Dataset ID"}],responses:{"200":{description:"AppDataset marked as followable",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents",method:"GET",summary:"List AppHelpContents",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by title, description"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents",method:"POST",summary:"Create an AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppHelpContent",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"GET",summary:"Show AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"PATCH",summary:"Update an AppHelpContent",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppHelpContent",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"DELETE",summary:"Delete an AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],responses:{"200":{description:"AppHelpContent deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/signed_url",method:"GET",summary:"Get signed_url for AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"file_name","in":"query",type:"string",required:true,description:"AppHelpContent file_name of attachment"},{name:"prefix","in":"query",type:"string",required:false,description:"AppHelpContent prefix of attachment"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not Found",schema:"any"}}},{path:"/v2/apps/{app_id}/app_logs",method:"GET",summary:"List log streams for app",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_logs/events/{log_stream}",method:"GET",summary:"List events for log stream",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"log_stream","in":"path",type:"string",required:true,description:"Log stream name"},{name:"start_time","in":"query",type:"integer",required:false,description:"The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"end_time","in":"query",type:"integer",required:false,description:"The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_logs/search",method:"GET",summary:"Search log events",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"log_stream","in":"query",type:"string",required:false,description:"Log stream name"},{name:"asset_id","in":"query",type:"string",required:false,description:"Asset ID by which logs will be filtered. F.e. ASSET=48238"},{name:"filter","in":"query",type:"string",required:false,description:"Filter pattern"},{name:"start_time","in":"query",type:"integer",required:false,description:"The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"end_time","in":"query",type:"integer",required:false,description:"The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_types",method:"GET",summary:"List AppTypes",tags:["AppTypes"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_types/{id}",method:"GET",summary:"Show AppType",tags:["AppTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppType ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_types/{id}",method:"PATCH",summary:"Update an AppType",tags:["AppTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppType ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppType",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates",method:"GET",summary:"List accesible app settings templates",tags:["AppSettingsTemplates"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"App Key"},{name:"name","in":"query",type:"string",required:false,description:"Filter by App Settings Template name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of app runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"ownership","in":"query",type:"string",required:false,description:"Filter app setting templates, by current_user or shared. Possible values: \"own\", \"shared\"."},{name:"published","in":"query",type:"string",required:false,description:"Filter app by published app settings template"},{name:"exact_name","in":"query",type:"string",required:false,description:"Filter by App Settings Template by exact name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates",method:"POST",summary:"Create an app settings template",tags:["AppSettingsTemplates"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"App Key"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"GET",summary:"Show app",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"PATCH",summary:"Update an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppSettingsTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"DELETE",summary:"Delete an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"AppSettingsTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/share",method:"POST",summary:"Share an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"},{name:"user_id","in":"query",type:"any",required:false,description:"User IDs"}],responses:{"200":{description:"Created AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/unshare",method:"POST",summary:"Unshare an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"},{name:"user_id","in":"query",type:"any",required:false,description:"User IDs"}],responses:{"200":{description:"Unshared AppSettingsTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/copy",method:"POST",summary:"Copy user's own or shared AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"Created AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/publish",method:"POST",summary:"Publish a AppSettingsTemplate as a company template. This'll create a copy of the template",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New Published AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates",method:"GET",summary:"List accessible app stream templates",tags:["AppStreamTemplate"],parameters:[{name:"log_type","in":"query",type:"string",required:false,description:"Filter by log_type. Can be time or depth"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment. Can be drilling or completion"},{name:"data_source","in":"query",type:"string",required:false,description:"Filter by data source. Can be witsml or csv"},{name:"stream_mode","in":"query",type:"string",required:false,description:"Filter by stream mode. Can be live or historical"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates",method:"POST",summary:"Create an app stream template",tags:["AppStreamTemplate"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"GET",summary:"Show app stream template",tags:["AppStreamTemplate"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"PATCH",summary:"Update an AppStreamTemplate",tags:["AppStreamTemplate"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStreamTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"DELETE",summary:"Delete an AppStreamTemplate",tags:["AppStreamTemplate"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],responses:{"200":{description:"AppStreamTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}/add_app",method:"POST",summary:"Add AppStreamTemplateApp to AppStreamTemplate",tags:["AppStreamTemplateApp"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Created AppStreamTemplateApp",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{app_stream_template_id}/update_app/{id}",method:"POST",summary:"Update AppStreamTemplateApp",tags:["AppStreamTemplateApp"],parameters:[{name:"app_stream_template_id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplateApp ID"}],responses:{"200":{description:"Updated AppStreamTemplateApp",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{app_stream_template_id}/remove_app/{id}",method:"DELETE",summary:"Remove AppStreamTemplateApp from AppStreamTemplate",tags:["AppStreamTemplateApp"],parameters:[{name:"app_stream_template_id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplateApp ID"}],responses:{"200":{description:"AppStreamTemplateApp deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dataset_types",method:"GET",summary:"List DatasetTypes",tags:["DatasetTypes"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/datset_types/{id}",method:"GET",summary:"Show DatasetType",tags:["DatasetTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DatasetType ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/datset_types/{id}",method:"PATCH",summary:"Update an DatasetType",tags:["DatasetTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DatasetType ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated DatasetType",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents",method:"GET",summary:"List documents",tags:["Documents"],parameters:[{name:"parent_slug","in":"query",type:"any",required:false,description:"Filter documents by parent_slug"},{name:"search","in":"query",type:"string",required:false,description:"Search document text"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents",method:"POST",summary:"Create a document",tags:["Documents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created document",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"GET",summary:"Show Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"PATCH",summary:"Update a Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Document",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"DELETE",summary:"Delete a Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Document deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections",method:"GET",summary:"List sections of document",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections",method:"POST",summary:"Create a document section",tags:["Documents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Document Section",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"GET",summary:"Show Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"PATCH",summary:"Update Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Document Section",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"DELETE",summary:"Delete a Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],responses:{"200":{description:"Document Section deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates",method:"GET",summary:"List rig templates",tags:["Assets"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter rig templates by rig_id"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter rig templates by company_id"},{name:"search","in":"query",type:"string",required:false,description:"Search rig templates by rig name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates",method:"POST",summary:"Create a rig template",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/aggregated_values",method:"GET",operationId:"getRigTemplatesAggregatedValues",summary:"Get aggregated values from rig template items",tags:["Assets"],parameters:[{name:"rig_template_id","in":"query",type:"integer",required:false,description:"Rig Template ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"rig_id","in":"query",type:"integer",required:false,description:"Rig ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"well_id","in":"query",type:"integer",required:false,description:"Well ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"rig_template_category_name","in":"query",type:"string",required:true,description:"Name of the rig template category"},{name:"rig_template_item_field","in":"query",type:"string",required:false,description:"Field from rig template item data to aggregate (default: name)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"GET",summary:"Show Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"PATCH",summary:"Update a Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"DELETE",summary:"Delete a Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Rig Template deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories",method:"GET",summary:"List rig template categories",tags:["Assets"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories",method:"POST",summary:"Create a rig template category",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig template category",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"GET",summary:"Show Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"PATCH",summary:"Update a Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template Category",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"DELETE",summary:"Delete a Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],responses:{"200":{description:"Rig Template Category deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items",method:"GET",summary:"List items of rig template",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items",method:"POST",summary:"Create a rig template item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Rig Template Item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"GET",summary:"Show Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"PATCH",summary:"Update Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template Item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"DELETE",summary:"Delete a Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],responses:{"200":{description:"Rig Template Item deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers",method:"GET",summary:"List Tiers",tags:["Tiers"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers",method:"POST",summary:"Create a Tier",tags:["Tiers"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Tier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"GET",summary:"Show Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"PATCH",summary:"Update a Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Tier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"DELETE",summary:"Delete a Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],responses:{"200":{description:"Tier deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions",method:"GET",summary:"List Product Subscriptions",tags:["ProductSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Product Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by subscription name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions",method:"POST",summary:"Create a Product Subscription",tags:["ProductSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Product Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"GET",summary:"Show Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"PATCH",summary:"Update a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Product Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Product Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Product Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{id}/approve",method:"POST",summary:"Approve a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Product Subscription ID"}],responses:{"200":{description:"Product Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{id}/deny",method:"POST",summary:"Deny a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Product Subscription ID"}],responses:{"200":{description:"Product Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions",method:"GET",summary:"List Platform Subscriptions",tags:["PlatformSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Platform Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions",method:"POST",summary:"Create a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Platform Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"GET",summary:"Show Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"PATCH",summary:"Update a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Platform Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Platform Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Platform Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/approve",method:"POST",summary:"Approve a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Platform Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/deny",method:"POST",summary:"Deny a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Platform Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/resume",method:"POST",summary:"Resume a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions",method:"GET",summary:"List Provisioning Subscriptions",tags:["ProvisioningSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Provisioning Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions",method:"POST",summary:"Create a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Provisioning Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"GET",summary:"Show Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"PATCH",summary:"Update a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Provisioning Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Provisioning Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Provisioning Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/approve",method:"POST",summary:"Approve a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Provisioning Subscription ID"}],responses:{"200":{description:"Provisioning Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/deny",method:"POST",summary:"Deny a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Provisioning Subscription ID"}],responses:{"200":{description:"Provisioning Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/resume",method:"POST",summary:"Resume a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Provisioning response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/app_streams",method:"GET",summary:"Show AppStream info for a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Provisioning response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions",method:"GET",summary:"List Purchase Subscriptions",tags:["PurchaseSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Purchase Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],responses:{"200":{description:"Purchase Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}",method:"GET",summary:"Show Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}",method:"PATCH",summary:"Update a Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Purchase Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/subscription_features",method:"GET",summary:"List Subscription Features",tags:["SubscriptionFeatures"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/subscription_features/{id}",method:"GET",summary:"Show Subscription Feature",tags:["SubscriptionFeatures"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Subscription Feature ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/corva/well_cache",method:"GET",summary:"List WellCache Records",tags:["WellCache"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Search by Asset ID"},{name:"company_id","in":"query",type:"integer",required:false,description:"Search by Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets",method:"GET",summary:"List of blacklisted datasets",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets",method:"POST",summary:"Create BlacklistedDataset",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets/bulk_create",method:"POST",summary:"Create many BlacklistedDatasets",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets/{id}",method:"DELETE",summary:"Delete a blacklisted dataset",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"},{name:"id","in":"path",type:"integer",required:true,description:"BlacklistedDataset ID"}],responses:{"200":{description:"BlacklistDataset deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/metrics",method:"GET",summary:"Metric statistics for a given App",tags:["App"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"metric_name","in":"query",type:"string",required:true,description:"The App name"},{name:"start_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"end_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"period","in":"query",type:"integer",required:false,description:"Period must be divisible by 60"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/app_metrics/for_selected_apps",method:"GET",summary:"Metric statistics for the selected Apps",tags:["App"],parameters:[{name:"app_ids","in":"query",type:"integer",required:true,description:"Apps ids"},{name:"metric_name","in":"query",type:"string",required:true,description:"Metric name"},{name:"start_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"end_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"period","in":"query",type:"integer",required:false,description:"Period must be divisible by 60"},{name:"segment","in":"query",type:"string",required:false,description:"Segment for apps"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/assets",method:"GET",summary:"Retrieve app assets",tags:["AppAssets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"asset_name","in":"query",type:"string",required:false,description:"Asset Name"},{name:"asset_status","in":"query",type:"string",required:false,description:"Asset Status. Possible: \"all\", \"active\", \"paused\", \"complete\", \"idle\""},{name:"from","in":"query",type:"integer",required:false,description:"Unix timestamp to start filtering assets \"from\" any time. Will filter assets by last_active_at field"},{name:"to","in":"query",type:"integer",required:false,description:"Unix timestamp to start filtering assets \"to: any time. Will filter assets by last_active_at field"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews",method:"GET",summary:"List PackageReviews",tags:["PackageReviews"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"query","in":"query",type:"string",required:false,description:"Search by App name"},{name:"status","in":"query",type:"string",required:false,description:"Filter by PackageReview status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews",method:"POST",summary:"Create a PackageReview",tags:["PackageReviews"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created PackageReview",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"GET",summary:"Show PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"PATCH",summary:"Update a PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated PackageReview",schema:"any"},"400":{description:"Package Review not updated",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"DELETE",summary:"Cancel a PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],responses:{"200":{description:"Package Review deleted",schema:"any"},"400":{description:"Package Review not deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases",method:"GET",summary:"List of app purchases",tags:["AppPurchases"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter app purchases by status. Valid statuses: pending, approved, denied"},{name:"search","in":"query",type:"string",required:false,description:"Search app purchases by app name"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter app purchases by app_id"},{name:"purchased","in":"query",type:"boolean",required:false,description:"Filter app purchases if they are purchased or provided"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response with all required relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases",method:"POST",summary:"Create a App Purchase",tags:["AppPurchases"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created App Purchase Payload without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}",method:"GET",summary:"Show app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response with all required relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/approve",method:"POST",summary:"Approve app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/deny",method:"POST",summary:"Deny app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/resume",method:"POST",summary:"Resume a App Purchase Subscription",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchases ID"}],responses:{"200":{description:"App Purchase response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/datasets/filtered_by_apps",method:"GET",summary:"List app_datasets for specific app ids with dependencies",tags:["Datasets"],parameters:[{name:"app_ids","in":"path",type:"array",required:true,description:"Array of app ids"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs",method:"GET",summary:"List of app runs",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"status","in":"query",type:"string",required:false,description:"App run status"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well id"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company id"},{name:"app_ids","in":"query",type:"integer",required:false,description:"Filter by app ids"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs",method:"POST",summary:"Create AppRun",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successfully created app run",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"GET",summary:"Return App Run",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],responses:{"200":{description:"App run successfully returned",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"PATCH",summary:"Update AppRun status. Used only for api key authentication.",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App run execution successfully updated. Auto updates finished_at time.",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"DELETE",summary:"Stop AppRun execution",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of app runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"App run execution successfully stopped",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}/stop",method:"PATCH",summary:"Stop AppRun execution",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],responses:{"200":{description:"App run execution successfully stopped",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/duplicate_check",method:"GET",summary:"Check duplicate app run",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"well_id","in":"query",type:"integer",required:true,description:"App run's well id"},{name:"app_stream_id","in":"query",type:"integer",required:true,description:"App run's app stream"},{name:"app_version","in":"query",type:"string",required:true,description:"App run's app version"}],responses:{"200":{description:"Status can be warning or OK",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams",method:"GET",summary:"List AppStreams",tags:["AppStream"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset_id"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by streams' log_type. Can be time or depth"},{name:"source_type","in":"query",type:"string",required:false,description:"Filter by source_type"},{name:"data_received_at","in":"query",type:"string",required:false,description:"Filter by data_received_at"},{name:"last_active_at","in":"query",type:"string",required:false,description:"Filter by last_active_at"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"started_by","in":"query",type:"string",required:false,description:"Filter by started_by user column"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter by app_id"},{name:"updated_at_gt","in":"query",type:"integer",required:false,description:"Filter streams where updated_at greater than provided unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams",method:"POST",summary:"Create AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams",method:"GET",summary:"List AppStreams",tags:["AppStream"],parameters:[{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like app_stream.log_type. See example response for fields."},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset_id"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by streams' log_type. Can be time or depth"},{name:"source_type","in":"query",type:"string",required:false,description:"Filter by source_type"},{name:"data_received_at","in":"query",type:"string",required:false,description:"Filter by data_received_at"},{name:"last_active_at","in":"query",type:"string",required:false,description:"Filter by last_active_at"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter by app_id"},{name:"consumer_strategy","in":"query",type:"string",required:false,description:"Filter by consumer_strategy"},{name:"updated_at_gt","in":"query",type:"integer",required:false,description:"Filter streams where updated_at greater than provided unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams/idle_worker_stats",method:"GET",summary:"Get AppStream Auto Idle Job Stats",tags:["AppStream"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams/{id}",method:"GET",summary:"Show AppStream",tags:["AppStream"],parameters:[{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like app_stream.log_type. See example response for fields."},{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"GET",summary:"Show AppStream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"PATCH",summary:"Update AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Updated AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"DELETE",summary:"Delete AppStream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"AppStream deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/clone",method:"POST",summary:"Clone AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Cloned AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/create_backfill_stream",method:"POST",summary:"Create Backfill App Stream for App Stream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created Backfill AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/force_resume",method:"POST",summary:"Force resuming consumers for stream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"AppStream force resumed consumers"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"App Stream is not a drilling time stream",schema:"any"}}},{path:"/v1/app_streams/{id}/reset_data_schedules",method:"POST",summary:"Reset data_time scheduled app cursors and schedules for a purge/rerun window",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Data schedules were reset",schema:"any"},"400":{description:"Invalid or missing window parameters",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/batch_update",method:"PATCH",summary:"Batch Update AppStreams. Limited to 10 app streams",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App streams were updated"},"401":{description:"Authentication error",schema:"any"},"403":{description:"No permissions to update app streams",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/batch_destroy",method:"DELETE",summary:"Batch Deletion of AppStreams. Limited to 10 app streams",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App streams were deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"No permissions to delete app streams",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/update_edr_provider_connection_status",method:"PATCH",summary:"Update edr provider connection time",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"boolean",required:true},responses:{"200":{description:"Edr provider connection updated"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"connection_failed parameter missing"}}},{path:"/v1/app_connections",method:"POST",summary:"Create AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"GET",summary:"Show AppConnection",tags:["AppConnection"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppConnection ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"PATCH",summary:"Update AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"DELETE",summary:"Delete AppConnection",tags:["AppConnection"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppConnection ID"}],responses:{"200":{description:"AppConnection deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}/update_package",method:"PATCH",summary:"Update package version for AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Updated AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"GET",summary:"Show AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"POST",summary:"Create an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"PATCH",summary:"Update an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"DELETE",summary:"Delete an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/subscribe",method:"POST",summary:"Subscribe a user to AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/unsubscribe",method:"POST",summary:"Unsubscribe a user from AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage",method:"GET",summary:"Returns Usage records",tags:["Usage"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Company ID."},{name:"billable","in":"query",type:"string",required:false,description:"Billable ID or identifier."},{name:"start_at","in":"query",type:"any",required:false,description:"Smallest start_at time of returned records. UNIX timestamp or string."},{name:"end_at","in":"query",type:"any",required:false,description:"Largest end_at time of returned records. UNIX timestamp or string."},{name:"segment","in":"query",type:"string",required:false,description:"Segment of the records to return."},{name:"totals_by","in":"query",type:"string",required:false,description:"Calculate totals grouped by selected value."}],responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/usage/summaries",method:"GET",summary:"Returns UsageSummary records",tags:["Usage"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Company ID."},{name:"billable","in":"query",type:"string",required:false,description:"Billable ID or identifier."},{name:"start_at","in":"query",type:"any",required:false,description:"Smallest start_at time of returned records. UNIX timestamp or string."},{name:"end_at","in":"query",type:"any",required:false,description:"Largest end_at time of returned records. UNIX timestamp or string."},{name:"segment","in":"query",type:"string",required:false,description:"Segment of the records to return."},{name:"totals_by","in":"query",type:"string",required:false,description:"Calculate totals grouped by selected value."}],responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/workflows",method:"GET",summary:"List Workflows",tags:["Workflows"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Workflow segment filter"},{name:"company_id","in":"query",type:"any",required:false,description:"Workflow company filter"},{name:"allow_empty_company","in":"query",type:"string",required:false,description:"While filter by company, allow to add Workflows without company in results"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"search","in":"query",type:"string",required:false,description:"Search workflow by name/caption"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"array",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows",method:"POST",summary:"Create a Workflow",tags:["Workflows"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Workflow",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"GET",summary:"Show workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"PATCH",summary:"Update a Workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"DELETE",summary:"Delete a Workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Workflow deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks",method:"GET",summary:"List Workflow Content Blocks of a workflow",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks",method:"POST",summary:"Create a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Workflow Content Block",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"GET",summary:"Show Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"PATCH",summary:"Update a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow Content Block",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"DELETE",summary:"Delete a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],responses:{"200":{description:"Workflow Content Block deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps",method:"GET",summary:"List Workflow Apps of a Workflow",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps",method:"PUT",summary:"Update many Workflow Apps",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow Apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps/{id}",method:"GET",summary:"Show Workflow App",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps/{id}",method:"PATCH",summary:"Update a Workflow App",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow App",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflow_roles",method:"GET",summary:"List WorkflowRoles",tags:["WorkflowRoles"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates",method:"GET",summary:"Get list of column mapper templates",tags:["ColumnMapperTemplates"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter by Rig ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by column mapper name or rig name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"}],responses:{"200":{description:"List of column mapper templates",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates",method:"POST",summary:"Create column mapper template",tags:["ColumnMapperTemplates"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"GET",summary:"Get one column mapper template by ID",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],responses:{"200":{description:"Column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"PATCH",summary:"Update column mapper",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"DELETE",summary:"Delete column mapper",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],responses:{"200":{description:"ColumnMapperTemplate deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}/add_asset",method:"PUT",summary:"Add asset to column mapper template",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Rig was added to column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}/remove_asset",method:"PUT",summary:"Remove rig from column mapper template",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Rig was removed from column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels",method:"POST",summary:"Create column mapper template channel",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template channel",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}",method:"PATCH",summary:"Update column mapper template channel",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template channel",schema:"any"}}},{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}",method:"DELETE",summary:"Delete column mapper",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"}],responses:{"200":{description:"ColumnMapperTemplateChannel deleted",schema:"any"}}},{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules",method:"POST",summary:"Create column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template rule",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}",method:"PATCH",summary:"Update column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[{name:"column_mapper_template_channel_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateRule ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template rule",schema:"any"}}},{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}",method:"DELETE",summary:"Delete column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[{name:"column_mapper_channel_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateRule ID"}],responses:{"200":{description:"ColumnMapperTemplateRule deleted",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows",method:"GET",summary:"List Dashboard Workflows of a Dashboard",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}",method:"GET",summary:"Show Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}",method:"DELETE",summary:"Delete Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Dashboard Workflow deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/ungroup",method:"POST",summary:"Ungroup Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/ungroup_all",method:"POST",summary:"Ungroup All Dashboard Workflows for Dashboard",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/change_asset",method:"PUT",summary:"Change Asset of Dashboard Workflows and related Dashboard Apps",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/competitor_analysis/statistics",method:"GET",summary:"Get Competitor Analysis statistics",tags:["CompetitorAnalysis"],parameters:[{name:"asset_id","in":"query",type:"integer",required:true,description:"Asset ID"},{name:"radius","in":"query",type:"float",required:true,description:"Filter by radius"},{name:"keys","in":"query",type:"any",required:true,description:"Metric keys"},{name:"type","in":"query",type:"float",required:true,description:"Metrics type"},{name:"rig_release","in":"query",type:"string",required:false,description:"Filter by rig release"},{name:"target_formations","in":"query",type:"any",required:false,description:"Target Formations"},{name:"string_designs","in":"query",type:"any",required:false,description:"String Designs"},{name:"wells_number","in":"query",type:"integer",required:false,description:"Number of wells to return stats for (500 max)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_companies",method:"GET",summary:"List companies which have access to Apps",tags:["Company","Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates",method:"GET",summary:"List AppStoreTemplates",tags:["AppStoreTemplates"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"view_type","in":"query",type:"string",required:false,description:"Filter by view_type"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates",method:"POST",summary:"Create a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"GET",summary:"Show AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"PATCH",summary:"Update a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"DELETE",summary:"Delete a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],responses:{"200":{description:"AppStoreTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_sections",method:"GET",summary:"List AppStoreTemplateSections",tags:["AppStoreTemplateSections"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"title","in":"query",type:"string",required:false,description:"Filter by title"},{name:"section_type","in":"query",type:"string",required:false,description:"Filter by section_type"},{name:"view_type","in":"query",type:"string",required:false,description:"Filter by view_type"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_sections",method:"POST",summary:"Create a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_section/{id}",method:"GET",summary:"Show AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_section/{id}",method:"PATCH",summary:"Update a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreTemplateSection",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_section/{id}",method:"DELETE",summary:"Delete a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],responses:{"200":{description:"AppStoreTemplateSection deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles",method:"GET",summary:"List AppStoreArticles",tags:["AppStoreArticles"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"search","in":"query",type:"string",required:false,description:"Search by caption, name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles",method:"POST",summary:"Create a AppStoreArticle",tags:["AppStoreArticles"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreArticle",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"GET",summary:"Show AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"PATCH",summary:"Update a AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreArticle",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"DELETE",summary:"Delete a AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],responses:{"200":{description:"AppStoreArticle deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}/remove_section",method:"PATCH",summary:"Remove Section from AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"AppStoreTemplateSection removed from Article"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/signed_url",method:"GET",summary:"Get signed_url from S3",tags:["SignedUrl"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"file_name of attachment"},{name:"folder","in":"query",type:"string",required:true,description:"Folder for files"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dataset_audits",method:"GET",summary:"List Dataset Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"start","in":"query",type:"integer",required:false,description:"Filter by event time (Unix timestamp)"},{name:"end","in":"query",type:"integer",required:false,description:"Filter by event time (Unix timestamp)"},{name:"permission_workflow","in":"query",type:"string",required:false,description:"Filter by Permission column"},{name:"name","in":"query",type:"string",required:false,description:"Searches by dataset name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"data_type","in":"query",type:"string",required:false,description:"Filter by data_type"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/permission_audits",method:"GET",summary:"List Permission Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"ability","in":"query",type:"string",required:false,description:"Search by ability"},{name:"owner_name","in":"query",type:"string",required:false,description:"Search by owner name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/group_membership_audits",method:"GET",summary:"List Group Membership Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action (add, remove)"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by performer email"},{name:"target_user_email","in":"query",type:"string",required:false,description:"Search by target user email"},{name:"group_name","in":"query",type:"string",required:false,description:"Search by group name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscription_audits",method:"GET",summary:"List ProvisioningSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscription_audits",method:"GET",summary:"List PlatformSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscription_audits",method:"GET",summary:"List PurchaseSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/events/publish",method:"POST",summary:"Publish Events",tags:["Event","Audit"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage",method:"GET",summary:"Get Total App Usage Statistics",tags:["AppUsage"],parameters:[{name:"group_by","in":"query",type:"string",required:false,description:"Group results by some columns"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_family","in":"query",type:"array",required:false,description:"Filter by device_family"},{name:"os_family","in":"query",type:"array",required:false,description:"Filter by os_family"},{name:"useragent_family","in":"query",type:"array",required:false,description:"Filter by useragent_family"},{name:"corva_v3","in":"query",type:"boolean",required:false,description:"Filter by corva_v3"},{name:"corva_next","in":"query",type:"boolean",required:false,description:"Filter by corva_next (iOS app)"},{name:"user_group","in":"query",type:"string",required:false,description:"Filter by user_group emails"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/usage_list",method:"GET",summary:"Get App Usage Statistics by user",tags:["AppUsage"],parameters:[{name:"app_name","in":"query",type:"string",required:true,description:"Filter by app name"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: -event_sum"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/view_date_list",method:"GET",summary:"Get App Usage Statistics day by day",tags:["AppUsage"],parameters:[{name:"app_name","in":"query",type:"string",required:true,description:"Filter by app name"},{name:"group_by","in":"query",type:"string",required:false,description:"Group results by some columns"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/top_apps",method:"GET",summary:"Get Top App Usage Statistics",tags:["AppUsage"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of top apps to return (10, 20, or 30)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/top_users",method:"GET",summary:"Get Top Users Usage Statistics",tags:["AppUsage"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of top users to return (10, 20, or 30)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/total_usage_trend",method:"GET",summary:"Get Total AppUsage for each view_date",tags:["AppUsage"],parameters:[{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company_ids"},{name:"app_names","in":"query",type:"array",required:false,description:"Filter by app_names"},{name:"user_group","in":"query",type:"string",required:false,description:"Filter by user_group emails"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns",method:"GET",summary:"List Partial Well Reruns",tags:["PartialWellReruns"],parameters:[{name:"status","in":"query",type:"any",required:false,description:"Filter by multiple statuses"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter by rig_id"},{name:"start_timestamp","in":"query",type:"integer",required:false,description:"Filter runs that started later than start_timestamp. start_timestamp is in seconds"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user email. Can filter by parts of email"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by source's and target's well id"},{name:"start","in":"query",type:"integer",required:false,description:"Unix timestamp in seconds that filters reruns by created date and are created later than param specified"},{name:"end","in":"query",type:"integer",required:false,description:"Unix timestamp in seconds that filters reruns by created date and are created before than param specified"},{name:"mergeable","in":"query",type:"boolean",required:false,description:"Filter by mergeable status"},{name:"order","in":"query",type:"string",required:false,description:"Order partial well reruns by 'asc' or 'desc'"},{name:"sort","in":"query",type:"string",required:false,description:"Available sort values - id, company, rig, source_well_name, target_well_name, start_timestamp, status, created_at"}],responses:{"200":{description:"List of Partial Well Reruns",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/list",method:"POST",summary:"List Partial Well Reruns",tags:["PartialWellReruns"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"List of Partial Well Reruns",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}",method:"GET",summary:"Show Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}",method:"PATCH",summary:"Update Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/start_merging",method:"PATCH",summary:"Start rerun merging",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/resume",method:"PATCH",summary:"Change rerun status to synchronizing_streams",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/stop",method:"PATCH",summary:"Change rerun status to stop",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/fail",method:"PATCH",summary:"Change rerun status to failed",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/cancel",method:"PATCH",summary:"Change rerun status to canceled",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/restart",method:"PATCH",summary:"Restart partial rerun, which will change its status to running",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/app_progress/{app_id}",method:"GET",summary:"Show Partial Well Rerun App Progress",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/app_progress/{app_id}",method:"PATCH",summary:"Update Partial Well Rerun App Progress",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/partial_reruns",method:"POST",summary:"Create Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"Well is missing drilling#time stream",schema:"any"}}},{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}",method:"GET",summary:"Show Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],responses:{"200":{description:"Partial Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}",method:"PATCH",summary:"Update Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}/restart",method:"PATCH",summary:"Restart Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],responses:{"200":{description:"Restarted Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/search_suggestions",method:"GET",summary:"Search suggestions for App, Workflow and Article",tags:["SearchSuggestions"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search keyword to filter results"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/companies",method:"GET",summary:"List of Companies",tags:["Company"],parameters:[{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"provider","in":"query",type:"array",required:false,description:"Filter by provider (string or array of strings)"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"ids","in":"query",type:"array",required:false,description:"Filter by company IDs (array or comma-separated string)"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/company/{id}",method:"GET",summary:"Show Company by ID",tags:["Company"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found",schema:"any"}}},{path:"/v1/company",method:"GET",summary:"Show current user Company",tags:["Company"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/company",method:"PATCH",summary:"Update Company",tags:["Company"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals",method:"GET",summary:"List Company Goals if no filters applied",tags:["Goals"],parameters:[{name:"owner_id","in":"query",type:"integer",required:false,description:"Filter by owner ID"},{name:"owner_type","in":"query",type:"string",required:false,description:"Filter owner type"},{name:"goal_type","in":"query",type:"string",required:false,description:"Filter by goal type"},{name:"name","in":"query",type:"string",required:false,description:"Filter by name. Available only when goal_type is casing or well_section"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"include_wells","in":"query",type:"boolean",required:false,description:"Filter goals by Well owner_type. Include well association in response"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals",method:"POST",summary:"Create a Goal",tags:["Goals"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals/{id}",method:"PATCH",summary:"Update a Goal",tags:["Goals"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Goal ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals/{id}",method:"DELETE",summary:"Delete a Goal",tags:["Goals"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Goal ID"}],responses:{"200":{description:"Deleted Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects",method:"GET",summary:"List Projects",tags:["Projects"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects",method:"POST",summary:"Create a Project",tags:["Projects"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"GET",summary:"Show Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"POST",summary:"Clone a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Cloned Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"PATCH",summary:"Update a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"DELETE",summary:"Delete a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Project deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders",method:"GET",summary:"List ProjectFolders",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders",method:"POST",summary:"Create a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created ProjectFolder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"GET",summary:"Show ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"PATCH",summary:"Update a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated ProjectFolder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"DELETE",summary:"Delete a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],responses:{"200":{description:"ProjectFolder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files",method:"GET",summary:"List ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files",method:"POST",summary:"Create a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created ProjectFile",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"GET",summary:"Show ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"PATCH",summary:"Update a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated ProjectFile",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"DELETE",summary:"Delete a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],responses:{"200":{description:"ProjectFile deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/registered_models",method:"GET",summary:"Show list of Registered Models",tags:["RegisteredModels"],parameters:[{name:"filter","in":"query",type:"string",required:false,description:"Filter by model name"},{name:"uuid","in":"query",type:"string",required:false,description:"Filter by model name"},{name:"alias","in":"query",type:"string",required:false,description:"Filter by model alias (e.g., \"qa\" or \"prod\")"},{name:"company_id","in":"query",type:"string",required:false,description:"Filter by company ID"},{name:"asset_id","in":"query",type:"string",required:false,description:"Filter by asset ID"},{name:"basin","in":"query",type:"string",required:false,description:"Filter by basin name"},{name:"max_results","in":"query",type:"integer",required:false,description:"Limit number of items, Default is 100. Max threshold is 1000."},{name:"order_by","in":"query",type:"array",required:false,description:"List of columns for ordering search results"},{name:"page_token","in":"query",type:"string",required:false,description:"Next page token"},{name:"force","in":"query",type:"boolean",required:false,description:"Use to force request MLFlow API instead of cache"}],responses:{"200":{description:"List of Registered Models",schema:"{ data: any[] }"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules",method:"POST",summary:"Create App schedule",tags:["AppSchedule"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v1/app_schedules/bulk_update_status",method:"POST",summary:"Bulk update status for list of App Schedule",tags:["AppSchedule"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"GET",summary:"Retrieve App schedules",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App schedule ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"PATCH",summary:"Update app schedule",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Schedule ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"DELETE",summary:"Delete app schedule",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Schedule ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_audits",method:"GET",summary:"List Package Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Filter by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"app_name","in":"query",type:"string",required:false,description:"Filter by app name"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management",method:"GET",summary:"List accessible API keys",tags:["ApiKey"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"owner_type","in":"query",type:"string",required:false,description:"Filter by owner_type"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"name","in":"query",type:"string",required:false,description:"Search by name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management",method:"POST",summary:"Create an API key",tags:["ApiKey"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"GET",summary:"Show API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"PATCH",summary:"Update an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"DELETE",summary:"Delete an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"API key deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}/activate",method:"POST",summary:"Approve and Activate an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Activated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}/deactivate",method:"POST",summary:"Deactivate an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Deactivated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers",method:"GET",summary:"Get a list of edr providers",tags:["EdrProviders"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by edr provider's name, username or link"},{name:"provider_type","in":"query",type:"string",required:false,description:"Filter by provider type"},{name:"last_connection_failed","in":"query",type:"boolean",required:false,description:"Search by edr provider's last connection try"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-id"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List of edr providers",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers",method:"POST",summary:"Create a edr provider",tags:["EdrProviders"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"GET",summary:"Get an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Edr provider",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"PATCH",summary:"Update an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Updated Edr provider",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"DELETE",summary:"Delete an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Edr provider deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}/test_connection",method:"POST",summary:"Get an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Successful response with task_id to poll from",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_key_audits",method:"GET",summary:"List ApiKey Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Filter by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/type_wells",method:"GET",summary:"Get typewells from a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],responses:{"200":{description:"List of typewells",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/type_wells",method:"POST",summary:"Add new typewell well to a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Type well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/type_wells/{id}",method:"DELETE",summary:"Remove typewell well from a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"},{name:"id","in":"path",type:"integer",required:true,description:"TypeWell ID"}],responses:{"200":{description:"TypeWell deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/orders",method:"GET",summary:"List Tool Orders",tags:["Tool Ordering"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter by exact status"},{name:"active","in":"query",type:"string",required:false,description:"'true' excludes received_on_rig/cancelled/rejected orders; 'false' returns only those"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of tool orders for the current company, newest first",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/orders",method:"POST",summary:"Create Tool Order",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created draft order",schema:"any"},"400":{description:"Validation error: invalid asset/vendor, missing components, or bad quantity"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/orders/{id}",method:"GET",summary:"Get Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Tool order details, including components",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Tool order not found"}}},{path:"/v2/tool_ordering/orders/{id}",method:"PATCH",summary:"Update Draft Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated order",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is no longer a draft"}}},{path:"/v2/tool_ordering/orders/{id}",method:"DELETE",summary:"Delete Draft Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is no longer a draft"}}},{path:"/v2/tool_ordering/orders/{id}/submit",method:"POST",summary:"Submit Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Order moved to awaiting_acknowledgement; every component submitted",schema:"any"},"400":{description:"Validation error: inactive vendor, vendor with no eligible notification recipient, an unselectable recipient_user_id, invalid specs, or a tool family over its max quantity"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is not a draft"}}},{path:"/v2/tool_ordering/orders/{id}/acknowledge",method:"POST",summary:"Acknowledge Tool Order (vendor action)",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Order acknowledged; idempotent if already acknowledged",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order not found, draft, or not visible to this vendor"},"409":{description:"Order is not awaiting acknowledgement"}}},{path:"/v2/tool_ordering/orders/{id}/cancel",method:"POST",summary:"Cancel Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Order and its cancellable components cancelled; allowed for the vendor (same-customer active membership) or an internal user with update access",schema:"any"},"400":{description:"reason is missing, not a string, or too long"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized (neither vendor access nor internal update access)"},"404":{description:"Order not found or not visible"},"409":{description:"Order has not been submitted, is already terminal, or a component has shipped"}}},{path:"/v2/tool_ordering/orders/{order_id}/components/{id}/transition",method:"POST",summary:"Transition Order Component Status (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Component transitioned; order status re-derived",schema:"any"},"400":{description:"Unsupported target status, or the transition is not legal from the current status"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is not acknowledged, or is no longer active"}}},{path:"/v2/tool_ordering/orders/{order_id}/components/{id}/final_specs",method:"PATCH",summary:"Update Order Component Final Specs (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Component final specs and/or serial number updated",schema:"any"},"400":{description:"final_specs is not an object, or the payload is too large"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is read only, or the component is not active"}}},{path:"/v2/tool_ordering/orders/{order_id}/proposals",method:"POST",summary:"Submit Component Change Proposal (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created pending proposal",schema:"any"},"400":{description:"proposed_changes is missing/not an object/too large, or reason is invalid"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is terminal, or the component is not active"}}},{path:"/v2/tool_ordering/specifications",method:"GET",summary:"Get Tool Specification Definition",tags:["Tool Ordering"],parameters:[{name:"tool_family","in":"query",type:"string",required:true,description:"Tool family key, e.g. mud_motor; unknown families fall back to the generic definition"}],responses:{"200":{description:"Specification field definitions for the given tool family",schema:"any"},"400":{description:"tool_family query param is required"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors",method:"GET",summary:"List Vendors",tags:["Tool Ordering"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"Vendors for the current company, with contacts inlined",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors",method:"POST",summary:"Create Vendor",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created vendor",schema:"any"},"400":{description:"Validation error: blank or duplicate name"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to create vendors, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors/{id}",method:"PATCH",summary:"Update Vendor",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated vendor",schema:"any"},"400":{description:"Validation error: blank or duplicate name"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to update this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships",method:"GET",summary:"List Vendor Memberships",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Memberships for the vendor, with member user name/email inlined",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships",method:"POST",summary:"Add Vendor Membership",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created membership; the vendor_tool_order permission group is appended to the user's groups (additively, without touching other groups)",schema:"any"},"400":{description:"user_id is missing or belongs to another company (code 'validation_failed')"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships/{id}",method:"PATCH",summary:"Update Vendor Membership",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated membership; active: false revokes access immediately (deactivate, not delete)",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor or membership not found"}}},{path:"/v2/tool_ordering/vendor_contacts",method:"POST",summary:"Add Vendor Contact",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created contact; vendor_name may have created a new vendor",schema:"any"},"400":{description:"Validation error: missing vendor_id/vendor_name, invalid email, or duplicate email on the vendor"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized on the resolved vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"vendor_id not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendor_contacts/{id}",method:"DELETE",summary:"Remove Vendor Contact",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized on the contact's vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Contact not found, or its vendor belongs to another company"}}},{path:"/v2/tool_ordering/vendor_directory",method:"GET",summary:"List Vendor Directory",tags:["Tool Ordering"],parameters:[],responses:{"200":{description:"Distinct-by-email people across the company vendors",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to read vendors, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_drillout_unit_runs",method:"GET",summary:"List well drillout unit runs",tags:["WellDrilloutUnitRuns"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well ID"},{name:"drillout_unit_id","in":"query",type:"integer",required:false,description:"Filter by drillout unit ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well_drillout_unit_run.well_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of well drillout unit runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"List well drillout unit runs",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_drillout_unit_runs/{id}",method:"GET",summary:"Get a single well drillout unit run",tags:["WellDrilloutUnitRuns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Drillout Unit Run ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well_drillout_unit_run.well_id"}],responses:{"200":{description:"Get well drillout unit run",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets",method:"GET",summary:"List Pad/Frac Fleet Relations",tags:["PadFracFleets"],parameters:[{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Filter by frac_fleet_id"},{name:"pad_id","in":"query",type:"integer",required:false,description:"Filter by pad_id"},{name:"order","in":"query",type:"string",required:false,description:"Order pad frac fleets by 'asc' or 'desc'"},{name:"sort","in":"query",type:"string",required:false,description:"Available sort values - created_at, last_current_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"List of Pad/Frac Fleet Relations",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets",method:"POST",summary:"Create Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Pad/Frac Fleet Relation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets/{id}",method:"PATCH",summary:"Patch Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad/Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Pad/Frac Fleet Relation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets/{id}",method:"DELETE",summary:"Delete Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad/Frac Fleet ID"}],responses:{"200":{description:"Pad/Frac Fleet Relation deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts",method:"GET",summary:"List Company Goals if no filters applied",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"}],responses:{"200":{description:"List of Frac Fleet Contracts",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts",method:"POST",summary:"Create Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"GET",summary:"List Company Goals if no filters applied",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],responses:{"200":{description:"Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"PATCH",summary:"Update Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"DELETE",summary:"Delete Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],responses:{"200":{description:"Deleted Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units",method:"GET",summary:"Get a list of Intervention Units",tags:["InterventionUnits"],parameters:[{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by intervention name"},{name:"intervention_type","in":"query",type:"string",required:false,description:"Filter by intervention type"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention units per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units",method:"POST",summary:"Create an Intervention Unit",tags:["InterventionUnits"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units/{id}",method:"PATCH",summary:"Update Intervention Unit",tags:["InterventionUnits"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units/{id}",method:"DELETE",summary:"Delete Intervention Unit",tags:["InterventionUnits"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention ID"}],responses:{"200":{description:"Deleted Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_unit_events",method:"GET",summary:"Get a list of Intervention Units Events by well",tags:["InterventionUnitEvents"],parameters:[{name:"operation","in":"query",type:"string",required:false,description:"Filter by operation"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention unit events per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: operation,created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/intervention_unit_events",method:"POST",summary:"Create an Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_unit_events/{id}",method:"PATCH",summary:"Update Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Event ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_unit_events/{id}",method:"DELETE",summary:"Delete Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Event ID"}],responses:{"200":{description:"Deleted Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/data_export_app",method:"GET",summary:"Get enriched well export data",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by Well visibility"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"keys","in":"query",type:"array",required:false,description:"Optional list of metric keys to return under `metrics`"},{name:"drillstring_keys","in":"query",type:"array",required:false,description:"Optional list of drillstrings keys to return under `drillstrings`"},{name:"data_type","in":"query",type:"string",required:false,description:"Optional filter by data.type"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by (e.g. `county`, `rig_type`, `bit_depth`, etc.)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/data_export_app/list",method:"POST",summary:"Get enriched well export data",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by Well visibility"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"keys","in":"query",type:"array",required:false,description:"Optional list of metric keys to return under `metrics`"},{name:"drillstring_keys","in":"query",type:"array",required:false,description:"Optional list of drillstrings keys to return under `drillstrings`"},{name:"data_type","in":"query",type:"string",required:false,description:"Optional filter by data.type"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by (e.g. `county`, `rig_type`, `bit_depth`, etc.)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/data_export_app/column_fields",method:"GET",summary:"Get column fields for a column in export index endpoint",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"},{name:"lookup_field","in":"query",type:"string",required:false,description:"A lookup field to lookup column fields in the app. Currently supported three main groups well, bha, metrics. Main groups are names before first dot. Lookup fields example F.e. well.name, bha.pdm.maker, metrics.hour.bit_depth.formation_id"}],responses:{"200":{description:"Successful response",schema:"DataExportColumnFields"}}},{path:"/v2/data_export_app/column_fields_list",method:"POST",summary:"Get column fields for a column in export index endpoint",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"},{name:"lookup_field","in":"query",type:"string",required:false,description:"A lookup field to lookup column fields in the app. Currently supported three main groups well, bha, metrics. Main groups are names before first dot. Lookup fields example F.e. well.name, bha.pdm.maker, metrics.hour.bit_depth.formation_id"}],responses:{"200":{description:"Successful response",schema:"DataExportColumnFields"}}},{path:"/v2/data_export_app/flat",method:"POST",summary:"Get flat JSON:API-like response for global sorting",description:"Returns a flat array of items (BHA, well_section, well, mud) with global sorting support.\n\n**Key differences from /list endpoint:**\n- **Flat structure**: Items in `data` array, wells deduplicated in `included`\n- **Global sorting**: Array order IS the sort order - no need for sorted_metric_order indices\n- **Clear counts**: `total_count` (static) vs `filtered_count` (dynamic with filters)\n- **Optimized for large datasets**: Batched MongoDB queries for 7000+ wells\n\n**Response structure:**\n```json\n{\n \"data\": [{ \"id\": \"bha_123_456_2\", \"type\": \"bha\", \"attributes\": {...}, \"relationships\": {...} }],\n \"included\": [{ \"id\": 123, \"type\": \"well\", \"attributes\": {...} }],\n \"meta\": { \"total_count\": 150, \"filtered_count\": 45, \"has_more\": true, \"page\": 1, \"per_page\": 80 }\n}\n```\n",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination (default: 1)"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page (default: 80)"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"data_type","in":"query",type:"string",required:false,description:"Data type to return (determines item grouping)"},{name:"keys","in":"query",type:"array",required:false,description:"Metric keys to include in attributes (filter_keys)"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by globally (e.g., bit_depth, start_depth, name)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction (default: asc)"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Filter condition"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response with flat items and metadata",schema:"DataExportFlatResponse"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to requested wells/companies"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/data_export_app/activity_code_mappings",method:"GET",summary:"Get activity code type mappings for a company",tags:["Data Export App"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID to fetch activity code mappings for"}],responses:{"200":{description:"Successful response with mappings(or empty array if none exist)",schema:"ActivityCodeMappingsList"},"400":{description:"Bad request - company_id is required"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to wells in this company"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/data_export_app/metrics_definitions",method:"GET",summary:"Get dynamic metric definitions for a company",description:"Returns per-company dynamic metric metadata from the `corva#metrics.definitions`\nMongoDB collection. The FE uses this to render custom metrics (name, category,\nunit, ILT icon/color) without hardcoding them per company.\n\nNotes:\n- One entry per segment; only the **latest** document per segment is returned.\n- Backend-internal fields (`rules`, `restrict`, `description`) are stripped.\n- `usage_rules` is included as-is when present; FE matches wells by program name.\n- Metric **values** flow through the existing `/v2/data_export_app/flat` endpoint —\n no separate fetch is required.\n",tags:["Data Export App"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID to fetch metric definitions for"}],responses:{"200":{description:"Successful response with definitions(or empty array if none exist)",schema:"MetricsDefinitionsList"},"400":{description:"Bad request - company_id is required"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to wells in this company"},"404":{description:"Not found error",schema:"NotFoundError"},"503":{description:"Service unavailable - upstream MongoDB error"}}},{path:"/v2/country_list",method:"GET",summary:"Get list of available countries",tags:["Countries"],parameters:[],responses:{"200":{description:"Successful response",schema:"CountryList"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/integration/revolt_chat_sessions",method:"POST",summary:"Create or fetch Revolt Chat session",tags:["RevoltChat"],parameters:[{name:"well_id","in":"query",type:"integer",required:false,description:"Well ID"},{name:"pad_id","in":"query",type:"integer",required:false,description:"Pad ID"}],responses:{"200":{description:"Returns session token and channel info",schema:"{ revolt_session_token: string, revolt_user_id: string, revolt_company_server_id: string, revolt_user_joined_server_id: string, revolt_channel_id: string }"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"},"502":{description:"Revolt API error",schema:"{ code: number, message: string }"}}},{path:"/v2/intervention_unit_reruns",method:"GET",summary:"Get a list of Intervention Unit Reruns",tags:["InterventionUnitReruns"],parameters:[{name:"intervention_unit_id","in":"query",type:"integer",required:false,description:"Filter by intervention_unit_id"},{name:"intervention_unit_event_id","in":"query",type:"integer",required:false,description:"Filter by intervention_unit_event_id"},{name:"app_stream_id","in":"query",type:"integer",required:false,description:"Filter by app_stream_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention unit reruns per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: created_at,intervention_unit"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List of Intervention Unit Reruns",schema:"any"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/intervention_unit_reruns",method:"POST",summary:"Create an Intervention Unit Rerun",tags:["InterventionUnitReruns"],parameters:[],requestBody:{contentType:"application/json",schema:"CreateInterventionUnitRerunPayload",required:true},responses:{"200":{description:"Created Intervention Unit Rerun",schema:"InterventionUnitRerun"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"},"422":{description:"Unprocessable Entity",schema:"any"}}},{path:"/v2/intervention_unit_reruns/{id}",method:"GET",summary:"Get Intervention Unit Rerun by ID",tags:["InterventionUnitReruns"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Rerun ID"}],responses:{"200":{description:"Intervention Unit Rerun",schema:"InterventionUnitRerun"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}}],endpointsByTag:{AbilityCheck:[{path:"v2/ability_check/check_feature",method:"GET",summary:"Check feature status for user",tags:["AbilityCheck"],parameters:[{name:"feature_name","in":"query",type:"string",required:true,description:"Name of Feature"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"v2/ability_check/check_permission",method:"GET",summary:"Check permission status for user",tags:["AbilityCheck"],parameters:[{name:"ability","in":"query",type:"string",required:true,description:"Ability to check"},{name:"resource_class","in":"query",type:"string",required:true,description:"Class of resource"},{name:"resource_id","in":"query",type:"integer",required:false,description:"Id of resource if checking permission for particular entity"},{name:"name","in":"query",type:"integer",required:false,description:"Dataset name"},{name:"provider","in":"query",type:"integer",required:false,description:"Dataset provider"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AlertDefinitions:[{path:"/v2/alert_groups/{alert_group_id}/alert_definitions",method:"GET",summary:"List an Alert Group's Definitions",tags:["AlertDefinitions"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:"Alert group ID"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type (personal/company)"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"alert_tag_ids","in":"query",type:"string",required:false,description:"Filter by alert tag: a single value or a comma-separated list of tag ids and/or names (numeric values are treated as ids, names match case-insensitively). Matches definitions tagged with any of the given tags."},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"The alert group's definitions (same payload as /v2/alerts/definitions?alert_group_id=:id)",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions",method:"GET",summary:"List Alert Definitions",tags:["AlertDefinitions"],parameters:[{name:"type","in":"query",type:"string",required:false,description:"Filter by type (personal/company)"},{name:"alert_group_id","in":"query",type:"string",required:false,description:"Filter by alert group: a single id, a comma-separated list of ids, or \"none\" for ungrouped definitions"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"segment","in":"query",type:"string",required:false,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."},{name:"alert_tag_ids","in":"query",type:"string",required:false,description:"Filter by alert tag: a single value or a comma-separated list of tag ids and/or names (numeric values are treated as ids, names match case-insensitively). Matches definitions tagged with any of the given tags."},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert definitions",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions",method:"POST",summary:"Create Alert Definition",tags:["AlertDefinitions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert definition",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"GET",summary:"Get Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Alert definition details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"PATCH",summary:"Update Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert definition",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}",method:"DELETE",summary:"Delete Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/definitions/{id}/subscribe",method:"POST",summary:"Subscribe to Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Subscription created; activates an inactive definition"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Subscription already exists"}}},{path:"/v2/alerts/definitions/{id}/unsubscribe",method:"POST",summary:"Unsubscribe from Alert Definition",tags:["AlertDefinitions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Unsubscribed; deactivates a personal definition left without subscriptions"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AlertGroups:[{path:"/v2/alert_groups",method:"GET",summary:"List Alert Groups",tags:["AlertGroups"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups",method:"POST",summary:"Create Alert Group",tags:["AlertGroups"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations",method:"GET",summary:"List Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of configurations",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations",method:"POST",summary:"Create Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created configuration",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",method:"PATCH",summary:"Update Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated configuration",schema:"any"},"400":{description:"Validation error, or scope_type/scope_id provided without the other — the pair must always be updated together"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/{id}",method:"DELETE",summary:"Delete Group Configuration",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_create",method:"POST",summary:"Bulk Create Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Configurations created (all-or-nothing — none created if any is invalid)",schema:"any"},"400":{description:"Validation error; no configurations were created"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_configurations/bulk_destroy",method:"DELETE",summary:"Bulk Delete Group Configurations",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Configurations removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes",method:"GET",summary:"List Group Scopes",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of group scope targets",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes",method:"POST",summary:"Add Scope Target to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added scope target",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/{id}",method:"DELETE",summary:"Remove Scope Target from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_create",method:"POST",summary:"Bulk Add Scope Targets to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope targets added (idempotent — targets already in the group are skipped)",schema:"any"},"400":{description:"Validation error; no scope targets were added"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_destroy",method:"DELETE",summary:"Bulk Remove Scope Targets from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope targets removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_scopes/bulk_replace",method:"PUT",summary:"Replace Group Scope Targets",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Scope set replaced with the payload: targets not in the payload are removed, new ones added, targets already in the group are kept unchanged. An explicit empty scopes array removes all scope targets",schema:"any"},"400":{description:"Missing scopes key or validation error; no changes were made"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users",method:"GET",summary:"List Group Members",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"List of group members; each member embeds its user record (UserMinimalSerializer) in the response `included` array",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users",method:"POST",summary:"Add Member to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added member",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/{id}",method:"DELETE",summary:"Remove Member from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_create",method:"POST",summary:"Bulk Add Members to Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Members added (idempotent — users already in the group are skipped)",schema:"any"},"400":{description:"Validation error; no members were added"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{alert_group_id}/alert_group_users/bulk_destroy",method:"DELETE",summary:"Bulk Remove Members from Group",tags:["AlertGroups"],parameters:[{name:"alert_group_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Members removed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"GET",summary:"Get Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Alert group details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"PATCH",summary:"Update Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert group",schema:"any"},"400":{description:"Validation error, including changing segment while the group has scopes or configuration overrides whose type is invalid for the new segment"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_groups/{id}",method:"DELETE",summary:"Delete Alert Group",tags:["AlertGroups"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AlertRBAC:[{path:"/v2/alert_abilities",method:"GET",summary:"List Assignable Alert Abilities",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.",tags:["AlertRBAC"],parameters:[{name:"locale","in":"query",type:"string",required:false,description:"Display-name language; unknown/unsupported locales fall back to English"}],responses:{"200":{description:"Ability catalog",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_rbac/disable",method:"POST",summary:"Disable Alert RBAC",description:"Turns off enforcement. Always permitted (independent of RBAC state) so a company can never lock itself out.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"RBAC disabled",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_rbac/enable",method:"POST",summary:"Enable Alert RBAC",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.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"RBAC enabled",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"},"422":{description:"No alert role exists yet"}}},{path:"/v2/companies/{company_id}/alert_roles",method:"GET",summary:"List Alert Roles",description:"Company-defined alert roles. Gated by `update Company` (company admins only).",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert roles",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles",method:"POST",summary:"Create Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert role",schema:"any"},"400":{description:"Validation error (e.g. blank or duplicate name)"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"GET",summary:"Get Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],responses:{"200":{description:"Alert role details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Role not found in this company"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"PATCH",summary:"Update Alert Role",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert role",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}",method:"DELETE",summary:"Delete Alert Role",description:"Deletes the role. Rejected with 403 if any group membership still references it (detach members first).",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin, or the role is still assigned to members"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/alert_roles/{id}/abilities",method:"PUT",summary:"Replace Alert Role Abilities",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.",tags:["AlertRBAC"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Alert role ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Role with its updated abilities",schema:"any"},"400":{description:"Missing or malformed abilities payload, or an ability is not valid for its resource class; no change applied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not a company admin"},"404":{description:"Not found error",schema:"any"}}}],AlertTags:[{path:"/v2/alert_tags",method:"GET",summary:"List Alert Tags",tags:["AlertTags"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of alert tags for the current company",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags",method:"POST",summary:"Create Alert Tag",tags:["AlertTags"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert tag",schema:"any"},"400":{description:"Validation error, including a name already used in the company, a parent in another company, or a parent that is not a top-level tag"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags/{id}",method:"PATCH",summary:"Update Alert Tag",tags:["AlertTags"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert tag",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alert_tags/{id}",method:"DELETE",summary:"Delete Alert Tag",tags:["AlertTags"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted. Child tags and definition taggings are removed as well"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AlertWorkflows:[{path:"/v1/alert_workflows",method:"GET",summary:"List Alert Workflows",tags:["AlertWorkflows"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID (must be nil/current company or a company accessible to the user)"}],responses:{"200":{description:"Returns global workflows and workflows belonging to the current company, optionally filtered by company_id",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alert_workflows/{id}",method:"GET",summary:"Get Alert Workflow",tags:["AlertWorkflows"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AlertWorkflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Workflow not found or not accessible by current company"}}}],Alerts:[{path:"/v1/alerts",method:"GET",summary:"List Alerts",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"alert_definition_id","in":"query",type:"integer",required:false,description:"Filter by Alert Definition ID"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status. Supports comma-separated values for multiple statuses (e.g. open,acknowledged)"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"},{name:"sort","in":"query",type:"string",required:false,description:"Column to sort by, one of [alert_at, last_alert_at, created_at, status, status_changed_at, level, occurrences, acknowledged, validated, alert_classification, name]. Unrecognized values fall back to the default sort (alert_at descending)."},{name:"order","in":"query",type:"string",required:false,description:"Sort direction, asc or desc. Applies only when sort is provided and defaults to asc; without sort, results are returned alert_at descending."},{name:"serializer","in":"query",type:"string",required:false,description:"Select serializer to be used with the returned records"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/acknowledge",method:"POST",summary:"Add acknowledgement to alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated acknowledgement",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/classify",method:"POST",summary:"Add alert_classification to alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated alert_classification",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/",method:"GET",summary:"List comments for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/",method:"POST",summary:"Create a comment for alert",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created alert comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{comment_id}/likes",method:"GET",summary:"List likes for alert's comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{comment_id}/likes/toggle",method:"POST",summary:"Toggle a like for alert's comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Created/deleted alert like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"GET",summary:"Show comment for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"PATCH",summary:"Update an alert comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated alert comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/comments/{id}",method:"DELETE",summary:"Delete an alert comment",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Alert comment deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/deescalate",method:"POST",summary:"Close active escalation on alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Alert with escalation closed",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Only the escalated user or an admin can de-escalate"},"404":{description:"Not found error",schema:"any"},"422":{description:"Alert is not escalated"}}},{path:"/v1/alerts/{alert_id}/escalate",method:"POST",summary:"Escalate alert to specific users",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with new active escalation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Invalid request (empty user_ids, users outside company, or alert in terminal state)"}}},{path:"/v1/alerts/{alert_id}/likes",method:"GET",summary:"List likes for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/likes/toggle",method:"POST",summary:"Toggle a like for alert",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Created/deleted alert like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{alert_id}/transition",method:"POST",summary:"Transition alert status",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Alert with updated status and new activity entry",schema:"any"},"400":{description:"Invalid request (e.g. missing or blank status)"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Unauthorized"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/{id}",method:"GET",summary:"Get Alert",tags:["Alerts"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Alert ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Alert not found"}}},{path:"/v1/alerts/acknowledge",method:"POST",summary:"Bulk acknowledge multiple alerts",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"List of alerts with updated acknowledgement",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions",method:"GET",summary:"List Alert Definitions",tags:["Alerts"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"template_type","in":"query",type:"string",required:false,description:"Filter by template type: standard or preset"},{name:"topic","in":"query",type:"string",required:false,description:"Filter by topic"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/check",method:"POST",summary:"Check Alert Definition in point of time",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"any",required:false,description:"Alert definition to check"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/disable",method:"POST",summary:"Disable Alert Definition Template",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"integer",required:true,description:"Template alert definition ID to disable"}],responses:{"200":{description:"Successful response - returns disabled alert override",schema:"any"},"400":{description:"No enabled alert definition found for this template"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Alert definition not found or is not a template"}}},{path:"/v1/alerts/definitions/{alert_definition_id}/enable",method:"POST",summary:"Enable Alert Definition Template",tags:["Alerts"],parameters:[{name:"alert_definition_id","in":"path",type:"integer",required:true,description:"Template alert definition ID to enable"},{name:"alert_group_id","in":"query",type:"integer",required:false,description:"Optional alert group to associate the enabled alert with"}],responses:{"200":{description:"Successful response - returns enabled alerts (new copy or existing overrides)",schema:"any"},"400":{description:"Enabled alert is not valid for the given alert group"},"401":{description:"Authentication error",schema:"any"},"403":{description:"User is not authorized to update the given alert group"},"404":{description:"Alert definition not found or is not a template, or alert group not found"}}},{path:"/v1/alerts/definitions/{id}/save_as_template",method:"POST",summary:"Save Alert Definition as Library Template",tags:["Alerts"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Source alert definition id"},{name:"template_type","in":"query",type:"string",required:true,description:"Template type: standard or preset"},{name:"scope","in":"query",type:"string",required:false,description:"Target library shelf. \"company\" (default) saves a company-owned template, \"user\" saves a personal template for the current user, \"corva\" saves to the Corva library (Corva principals only). The source definition is unaffected."}],responses:{"200":{description:"The created template",schema:"any"},"400":{description:"Invalid template_type or scope parameter"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Caller is not allowed to create templates on the target shelf"},"404":{description:"Alert definition not found"}}},{path:"/v1/alerts/definitions/close",method:"POST",summary:"Close Open Alerts",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/context",method:"GET",summary:"Gather Alert Definition Context",tags:["Alerts"],parameters:[{name:"asset_id","in":"query",type:"any",required:false,description:"Asset to gather context from"},{name:"identifier","in":"query",type:"any",required:false,description:"Alert definition identifier to check against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/templates/{template_type}",method:"GET",summary:"List Alert Definition Templates",tags:["Alerts"],parameters:[{name:"template_type","in":"path",type:"string",required:true,description:"Template type: standard or preset"},{name:"scope","in":"query",type:"string",required:false,description:"Library shelf to list. \"corva\" (default) lists Corva-owned templates, swapping in the caller's copy where one exists. \"company\" lists templates owned by the current company. \"user\" lists the current user's personal templates."}],responses:{"200":{description:"Successful response - returns templates or their overrides",schema:"any[]"},"400":{description:"Invalid template_type or scope parameter"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/definitions/trigger",method:"POST",summary:"Trigger Alert",tags:["Alerts"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/details",method:"GET",summary:"Alerts Details for given period of time",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"top_alerts_count","in":"query",type:"integer",required:false,description:"Number of Total Alerts, default is 5"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"},{name:"sort","in":"query",type:"string",required:false,description:"Column to sort by, one of [alert_at, last_alert_at, created_at, status, status_changed_at, level, occurrences, acknowledged, validated, alert_classification, name]. Unrecognized values fall back to the default sort (alert_at descending)."},{name:"order","in":"query",type:"string",required:false,description:"Sort direction, asc or desc. Applies only when sort is provided and defaults to asc; without sort, results are returned alert_at descending."}],responses:{"200":{description:"Successful response",schema:"{ data: { alert_definition_id: number, alert_definition_name: string, active: boolean, segment: string, subscription: boolean, ... }[] }"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/alerts/totals",method:"GET",summary:"Alerts Counts",tags:["Alerts"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Timestamp to start alert at"},{name:"end","in":"query",type:"integer",required:false,description:"Timestamp to end alert at"},{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Timestamp (ms) lower bound for last_alert_at"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Timestamp (ms) upper bound for last_alert_at"},{name:"created_after","in":"query",type:"integer",required:false,description:"Timestamp for created after"},{name:"top_alerts_count","in":"query",type:"integer",required:false,description:"Number of Total Alerts, default is 5"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID"},{name:"name","in":"query",type:"string",required:false,description:"Alert Definition name"},{name:"alert_classification","in":"query",type:"string",required:false,description:"Alert Classification, one of [unclassified, true_positive, false_positive, informational, threshold_reached]"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Acknowledge the alert, true or false"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Alert subscription, true or false"},{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"assets","in":"query",type:"any",required:false,description:"Assets could be a string or a comma-delimited list of strings"},{name:"levels","in":"query",type:"any",required:false,description:"Levels could be a string or a comma-delimited list of strings"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/{alert_id}/activities",method:"GET",summary:"List Alert Activities",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"order","in":"query",type:"string",required:false,description:"Sort order by created_at (started_at is an alias): desc (default) or asc"},{name:"activity","in":"query",type:"string",required:false,description:"Filter by activity type"},{name:"user_id","in":"query",type:"integer",required:false,description:"Filter by user ID"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page, default 25, max 100"}],responses:{"200":{description:"Successful response",schema:"{ data: { id: string, type: string, attributes: any }[] }"},"400":{description:"Invalid activity filter"},"401":{description:"Unauthorized"},"403":{description:"Forbidden"},"404":{description:"Alert not found"}}},{path:"/v2/alerts/{alert_id}/occurrences",method:"GET",summary:"List Alert Occurrences",tags:["Alerts"],parameters:[{name:"alert_id","in":"path",type:"integer",required:true,description:"Alert ID"},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by: start_at (default) or severity"},{name:"order","in":"query",type:"string",required:false,description:"Sort direction: asc (default) or desc"},{name:"page","in":"query",type:"integer",required:false,description:"Page number (enables pagination)"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page, max 1000 (enables pagination)"}],responses:{"200":{description:"Successful response",schema:"{ data: { id: string, type: string, attributes: any }[] }"},"401":{description:"Unauthorized"},"403":{description:"Forbidden"},"404":{description:"Alert not found"}}},{path:"/v2/alerts/metrics",method:"GET",summary:"Alert Occurrence Metrics",tags:["Alerts"],parameters:[{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Occurrence window lower bound (ms); defaults to 7 days ago"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Occurrence window upper bound (ms); defaults to now"},{name:"top","in":"query",type:"integer",required:false,description:"Number of top alert definitions to return; defaults to 10, max 50"},{name:"levels","in":"query",type:"string",required:false,description:"Filter by per-fire level; comma-separated"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID; comma-separated"},{name:"name","in":"query",type:"string",required:false,description:"Filter by Alert Definition name"},{name:"assets","in":"query",type:"string",required:false,description:"Filter by asset IDs; comma-separated"},{name:"rigs","in":"query",type:"string",required:false,description:"Filter by rig (parent asset) IDs; comma-separated"},{name:"interventions","in":"query",type:"string",required:false,description:"Filter by intervention unit IDs; comma-separated"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment; comma-separated"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status; comma-separated"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Restrict to the caller's subscriptions"}],responses:{"200":{description:"Successful response",schema:"{ total_occurrences: number, levels: object, alert_definitions: { alert_definition_id: number, alert_definition_name: string, count: number }[] }"},"400":{description:"Invalid timestamp, range, or top"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/alerts/occurrences/series",method:"GET",summary:"Alert Occurrence Time-Series",tags:["Alerts"],parameters:[{name:"last_alert_start","in":"query",type:"integer",required:false,description:"Occurrence window lower bound (ms); defaults to 7 days ago"},{name:"last_alert_end","in":"query",type:"integer",required:false,description:"Occurrence window upper bound (ms); defaults to now"},{name:"timezone","in":"query",type:"string",required:false,description:"IANA timezone for bucketing; defaults to UTC"},{name:"interval","in":"query",type:"string",required:false,description:"Bucket size; auto-selected from the range if omitted"},{name:"levels","in":"query",type:"string",required:false,description:"Filter by per-fire level; comma-separated"},{name:"alert_definition_id","in":"query",type:"string",required:false,description:"Filter by Alert Definition ID; comma-separated"},{name:"name","in":"query",type:"string",required:false,description:"Filter by Alert Definition name"},{name:"assets","in":"query",type:"string",required:false,description:"Filter by asset IDs; comma-separated"},{name:"rigs","in":"query",type:"string",required:false,description:"Filter by rig (parent asset) IDs; comma-separated"},{name:"interventions","in":"query",type:"string",required:false,description:"Filter by intervention unit IDs; comma-separated"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment; comma-separated"},{name:"status","in":"query",type:"string",required:false,description:"Filter by Alert status; comma-separated"},{name:"subscription","in":"query",type:"boolean",required:false,description:"Restrict to the caller's subscriptions"}],responses:{"200":{description:"Successful response",schema:"{ interval: \"hour\" | \"day\" | \"month\", timezone: string, data: { bucket: string, groups: object[] }[] }"},"400":{description:"Invalid timezone, timestamp, range, or interval"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],ApiKey:[{path:"/v2/api_keys_management",method:"GET",summary:"List accessible API keys",tags:["ApiKey"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"owner_type","in":"query",type:"string",required:false,description:"Filter by owner_type"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"name","in":"query",type:"string",required:false,description:"Search by name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management",method:"POST",summary:"Create an API key",tags:["ApiKey"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"GET",summary:"Show API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"PATCH",summary:"Update an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}",method:"DELETE",summary:"Delete an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"API key deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}/activate",method:"POST",summary:"Approve and Activate an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Activated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys_management/{id}/deactivate",method:"POST",summary:"Deactivate an API key",tags:["ApiKey"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Deactivated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],App:[{path:"/v2/app_metrics/for_selected_apps",method:"GET",summary:"Metric statistics for the selected Apps",tags:["App"],parameters:[{name:"app_ids","in":"query",type:"integer",required:true,description:"Apps ids"},{name:"metric_name","in":"query",type:"string",required:true,description:"Metric name"},{name:"start_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"end_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"period","in":"query",type:"integer",required:false,description:"Period must be divisible by 60"},{name:"segment","in":"query",type:"string",required:false,description:"Segment for apps"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/metrics",method:"GET",summary:"Metric statistics for a given App",tags:["App"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"metric_name","in":"query",type:"string",required:true,description:"The App name"},{name:"start_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"end_time","in":"query",type:"integer",required:true,description:"Unix timestamp"},{name:"period","in":"query",type:"integer",required:false,description:"Period must be divisible by 60"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}}],AppAssets:[{path:"/v2/apps/{app_id}/assets",method:"GET",summary:"Retrieve app assets",tags:["AppAssets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"asset_name","in":"query",type:"string",required:false,description:"Asset Name"},{name:"asset_status","in":"query",type:"string",required:false,description:"Asset Status. Possible: \"all\", \"active\", \"paused\", \"complete\", \"idle\""},{name:"from","in":"query",type:"integer",required:false,description:"Unix timestamp to start filtering assets \"from\" any time. Will filter assets by last_active_at field"},{name:"to","in":"query",type:"integer",required:false,description:"Unix timestamp to start filtering assets \"to: any time. Will filter assets by last_active_at field"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppConnection:[{path:"/v1/app_connections",method:"POST",summary:"Create AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"GET",summary:"Show AppConnection",tags:["AppConnection"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppConnection ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"PATCH",summary:"Update AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}",method:"DELETE",summary:"Delete AppConnection",tags:["AppConnection"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppConnection ID"}],responses:{"200":{description:"AppConnection deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_connections/{id}/update_package",method:"PATCH",summary:"Update package version for AppConnection",tags:["AppConnection"],parameters:[],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Updated AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppDatasets:[{path:"/v2/apps/{app_id}/app_datasets",method:"GET",summary:"List app_datasets for app",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"dataset_operation","in":"query",type:"string",required:false,description:"Filtering by dataset operation. Can be read or write."}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets",method:"POST",summary:"Create an AppDataset",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppDataset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets/{app_dataset_id}",method:"DELETE",summary:"Delete an AppDataset",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppDataset ID"}],responses:{"200":{description:"AppDataset deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_datasets/mark_followable",method:"PATCH",summary:"Mark an AppDataset as followable",tags:["AppDatasets"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"dataset_id","in":"query",type:"integer",required:true,description:"Dataset ID"}],responses:{"200":{description:"AppDataset marked as followable",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppErrorAlert:[{path:"/v2/apps/{app_id}/app_error_alerts",method:"GET",summary:"Show AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"POST",summary:"Create an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"PATCH",summary:"Update an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"DELETE",summary:"Delete an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/subscribe",method:"POST",summary:"Subscribe a user to AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/unsubscribe",method:"POST",summary:"Unsubscribe a user from AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppLogs:[{path:"/v2/apps/{app_id}/app_logs",method:"GET",summary:"List log streams for app",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_logs/events/{log_stream}",method:"GET",summary:"List events for log stream",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"log_stream","in":"path",type:"string",required:true,description:"Log stream name"},{name:"start_time","in":"query",type:"integer",required:false,description:"The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"end_time","in":"query",type:"integer",required:false,description:"The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_logs/search",method:"GET",summary:"Search log events",tags:["AppLogs"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"log_stream","in":"query",type:"string",required:false,description:"Log stream name"},{name:"asset_id","in":"query",type:"string",required:false,description:"Asset ID by which logs will be filtered. F.e. ASSET=48238"},{name:"filter","in":"query",type:"string",required:false,description:"Filter pattern"},{name:"start_time","in":"query",type:"integer",required:false,description:"The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"end_time","in":"query",type:"integer",required:false,description:"The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC"},{name:"next_token","in":"query",type:"string",required:false,description:"The token for the next set of items to return"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppPurchases:[{path:"/v2/app_purchases",method:"GET",summary:"List of app purchases",tags:["AppPurchases"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter app purchases by status. Valid statuses: pending, approved, denied"},{name:"search","in":"query",type:"string",required:false,description:"Search app purchases by app name"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter app purchases by app_id"},{name:"purchased","in":"query",type:"boolean",required:false,description:"Filter app purchases if they are purchased or provided"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response with all required relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases",method:"POST",summary:"Create a App Purchase",tags:["AppPurchases"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created App Purchase Payload without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}",method:"GET",summary:"Show app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response with all required relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/approve",method:"POST",summary:"Approve app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/deny",method:"POST",summary:"Deny app purchase",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchase ID"}],responses:{"200":{description:"Successful response without apps/assets relationships",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_purchases/{id}/resume",method:"POST",summary:"Resume a App Purchase Subscription",tags:["AppPurchases"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Purchases ID"}],responses:{"200":{description:"App Purchase response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppReviews:[{path:"/v2/app_reviews",method:"GET",summary:"List accesible App Reviews",tags:["AppReviews"],parameters:[{name:"status","in":"query",type:"any",required:false,description:"Filter by status"},{name:"app_ids","in":"query",type:"any",required:false,description:"Filter by App Ids"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_reviews/{id}/approve",method:"POST",summary:"Approve App Review",tags:["AppReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Review ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_reviews/{id}/decline",method:"POST",summary:"Approve App Review",tags:["AppReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Review ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppRuns:[{path:"/v2/apps/{app_id}/app_runs",method:"GET",summary:"List of app runs",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"status","in":"query",type:"string",required:false,description:"App run status"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well id"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company id"},{name:"app_ids","in":"query",type:"integer",required:false,description:"Filter by app ids"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs",method:"POST",summary:"Create AppRun",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successfully created app run",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"GET",summary:"Return App Run",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],responses:{"200":{description:"App run successfully returned",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"PATCH",summary:"Update AppRun status. Used only for api key authentication.",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App run execution successfully updated. Auto updates finished_at time.",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}",method:"DELETE",summary:"Stop AppRun execution",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of app runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"App run execution successfully stopped",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/{id}/stop",method:"PATCH",summary:"Stop AppRun execution",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Run ID"}],responses:{"200":{description:"App run execution successfully stopped",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_runs/duplicate_check",method:"GET",summary:"Check duplicate app run",tags:["AppRuns"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"well_id","in":"query",type:"integer",required:true,description:"App run's well id"},{name:"app_stream_id","in":"query",type:"integer",required:true,description:"App run's app stream"},{name:"app_version","in":"query",type:"string",required:true,description:"App run's app version"}],responses:{"200":{description:"Status can be warning or OK",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppSchedule:[{path:"/v1/app_schedules",method:"POST",summary:"Create App schedule",tags:["AppSchedule"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"GET",summary:"Retrieve App schedules",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App schedule ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"PATCH",summary:"Update app schedule",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Schedule ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules/{id}",method:"DELETE",summary:"Delete app schedule",tags:["AppSchedule"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App Schedule ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_schedules/bulk_update_status",method:"POST",summary:"Bulk update status for list of App Schedule",tags:["AppSchedule"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Successful response",schema:"any"}}}],AppSettingsTemplates:[{path:"/v2/apps/{app_key}/app_settings_templates",method:"GET",summary:"List accesible app settings templates",tags:["AppSettingsTemplates"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"App Key"},{name:"name","in":"query",type:"string",required:false,description:"Filter by App Settings Template name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of app runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"ownership","in":"query",type:"string",required:false,description:"Filter app setting templates, by current_user or shared. Possible values: \"own\", \"shared\"."},{name:"published","in":"query",type:"string",required:false,description:"Filter app by published app settings template"},{name:"exact_name","in":"query",type:"string",required:false,description:"Filter by App Settings Template by exact name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates",method:"POST",summary:"Create an app settings template",tags:["AppSettingsTemplates"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"App Key"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"GET",summary:"Show app",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"PATCH",summary:"Update an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppSettingsTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}",method:"DELETE",summary:"Delete an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"AppSettingsTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/copy",method:"POST",summary:"Copy user's own or shared AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],responses:{"200":{description:"Created AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/publish",method:"POST",summary:"Publish a AppSettingsTemplate as a company template. This'll create a copy of the template",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New Published AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/share",method:"POST",summary:"Share an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"},{name:"user_id","in":"query",type:"any",required:false,description:"User IDs"}],responses:{"200":{description:"Created AppSettingsTemplateShares",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/app_settings_templates/{id}/unshare",method:"POST",summary:"Unshare an AppSettingsTemplate",tags:["AppSettingsTemplates"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"id","in":"path",type:"integer",required:true,description:"AppSettingsTemplate ID"},{name:"user_id","in":"query",type:"any",required:false,description:"User IDs"}],responses:{"200":{description:"Unshared AppSettingsTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStoreArticles:[{path:"/v2/app_store_articles",method:"GET",summary:"List AppStoreArticles",tags:["AppStoreArticles"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"search","in":"query",type:"string",required:false,description:"Search by caption, name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles",method:"POST",summary:"Create a AppStoreArticle",tags:["AppStoreArticles"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreArticle",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"GET",summary:"Show AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"PATCH",summary:"Update a AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreArticle",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}",method:"DELETE",summary:"Delete a AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],responses:{"200":{description:"AppStoreArticle deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_articles/{id}/remove_section",method:"PATCH",summary:"Remove Section from AppStoreArticle",tags:["AppStoreArticles"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"AppStoreArticle article_key or ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"AppStoreTemplateSection removed from Article"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStoreTemplateSections:[{path:"/v2/app_store_template_section/{id}",method:"GET",summary:"Show AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_section/{id}",method:"PATCH",summary:"Update a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreTemplateSection",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_section/{id}",method:"DELETE",summary:"Delete a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplateSection ID"}],responses:{"200":{description:"AppStoreTemplateSection deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_sections",method:"GET",summary:"List AppStoreTemplateSections",tags:["AppStoreTemplateSections"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"title","in":"query",type:"string",required:false,description:"Filter by title"},{name:"section_type","in":"query",type:"string",required:false,description:"Filter by section_type"},{name:"view_type","in":"query",type:"string",required:false,description:"Filter by view_type"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_template_sections",method:"POST",summary:"Create a AppStoreTemplateSection",tags:["AppStoreTemplateSections"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStoreTemplates:[{path:"/v2/app_store_templates",method:"GET",summary:"List AppStoreTemplates",tags:["AppStoreTemplates"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"view_type","in":"query",type:"string",required:false,description:"Filter by view_type"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates",method:"POST",summary:"Create a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"GET",summary:"Show AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"PATCH",summary:"Update a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStoreTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_store_templates/{id}",method:"DELETE",summary:"Delete a AppStoreTemplate",tags:["AppStoreTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStoreTemplate ID"}],responses:{"200":{description:"AppStoreTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStream:[{path:"/v1/app_streams",method:"GET",summary:"List AppStreams",tags:["AppStream"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset_id"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by streams' log_type. Can be time or depth"},{name:"source_type","in":"query",type:"string",required:false,description:"Filter by source_type"},{name:"data_received_at","in":"query",type:"string",required:false,description:"Filter by data_received_at"},{name:"last_active_at","in":"query",type:"string",required:false,description:"Filter by last_active_at"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"started_by","in":"query",type:"string",required:false,description:"Filter by started_by user column"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter by app_id"},{name:"updated_at_gt","in":"query",type:"integer",required:false,description:"Filter streams where updated_at greater than provided unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams",method:"POST",summary:"Create AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"GET",summary:"Show AppStream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"PATCH",summary:"Update AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Updated AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}",method:"DELETE",summary:"Delete AppStream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"AppStream deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/clone",method:"POST",summary:"Clone AppStream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Cloned AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/create_backfill_stream",method:"POST",summary:"Create Backfill App Stream for App Stream",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created Backfill AppStream",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/force_resume",method:"POST",summary:"Force resuming consumers for stream",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"AppStream force resumed consumers"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"App Stream is not a drilling time stream",schema:"any"}}},{path:"/v1/app_streams/{id}/reset_data_schedules",method:"POST",summary:"Reset data_time scheduled app cursors and schedules for a purge/rerun window",tags:["AppStream"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Data schedules were reset",schema:"any"},"400":{description:"Invalid or missing window parameters",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/{id}/update_edr_provider_connection_status",method:"PATCH",summary:"Update edr provider connection time",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"boolean",required:true},responses:{"200":{description:"Edr provider connection updated"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"connection_failed parameter missing"}}},{path:"/v1/app_streams/batch_destroy",method:"DELETE",summary:"Batch Deletion of AppStreams. Limited to 10 app streams",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App streams were deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"No permissions to delete app streams",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/app_streams/batch_update",method:"PATCH",summary:"Batch Update AppStreams. Limited to 10 app streams",tags:["AppStream"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"App streams were updated"},"401":{description:"Authentication error",schema:"any"},"403":{description:"No permissions to update app streams",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams",method:"GET",summary:"List AppStreams",tags:["AppStream"],parameters:[{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like app_stream.log_type. See example response for fields."},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset_id"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by streams' log_type. Can be time or depth"},{name:"source_type","in":"query",type:"string",required:false,description:"Filter by source_type"},{name:"data_received_at","in":"query",type:"string",required:false,description:"Filter by data_received_at"},{name:"last_active_at","in":"query",type:"string",required:false,description:"Filter by last_active_at"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"app_id","in":"query",type:"integer",required:false,description:"Filter by app_id"},{name:"consumer_strategy","in":"query",type:"string",required:false,description:"Filter by consumer_strategy"},{name:"updated_at_gt","in":"query",type:"integer",required:false,description:"Filter streams where updated_at greater than provided unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams/{id}",method:"GET",summary:"Show AppStream",tags:["AppStream"],parameters:[{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like app_stream.log_type. See example response for fields."},{name:"id","in":"path",type:"integer",required:true,description:"AppStream ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_streams/idle_worker_stats",method:"GET",summary:"Get AppStream Auto Idle Job Stats",tags:["AppStream"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStreamTemplate:[{path:"/v2/app_stream_templates",method:"GET",summary:"List accessible app stream templates",tags:["AppStreamTemplate"],parameters:[{name:"log_type","in":"query",type:"string",required:false,description:"Filter by log_type. Can be time or depth"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment. Can be drilling or completion"},{name:"data_source","in":"query",type:"string",required:false,description:"Filter by data source. Can be witsml or csv"},{name:"stream_mode","in":"query",type:"string",required:false,description:"Filter by stream mode. Can be live or historical"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates",method:"POST",summary:"Create an app stream template",tags:["AppStreamTemplate"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"GET",summary:"Show app stream template",tags:["AppStreamTemplate"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"PATCH",summary:"Update an AppStreamTemplate",tags:["AppStreamTemplate"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppStreamTemplate",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}",method:"DELETE",summary:"Delete an AppStreamTemplate",tags:["AppStreamTemplate"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],responses:{"200":{description:"AppStreamTemplate deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppStreamTemplateApp:[{path:"/v2/app_stream_templates/{app_stream_template_id}/remove_app/{id}",method:"DELETE",summary:"Remove AppStreamTemplateApp from AppStreamTemplate",tags:["AppStreamTemplateApp"],parameters:[{name:"app_stream_template_id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplateApp ID"}],responses:{"200":{description:"AppStreamTemplateApp deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{app_stream_template_id}/update_app/{id}",method:"POST",summary:"Update AppStreamTemplateApp",tags:["AppStreamTemplateApp"],parameters:[{name:"app_stream_template_id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplateApp ID"}],responses:{"200":{description:"Updated AppStreamTemplateApp",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_stream_templates/{id}/add_app",method:"POST",summary:"Add AppStreamTemplateApp to AppStreamTemplate",tags:["AppStreamTemplateApp"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppStreamTemplate ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Created AppStreamTemplateApp",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppTypes:[{path:"/v2/app_types",method:"GET",summary:"List AppTypes",tags:["AppTypes"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_types/{id}",method:"GET",summary:"Show AppType",tags:["AppTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppType ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/app_types/{id}",method:"PATCH",summary:"Update an AppType",tags:["AppTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppType ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppType",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],AppUsage:[{path:"/v2/usage_analytics/app_usage",method:"GET",summary:"Get Total App Usage Statistics",tags:["AppUsage"],parameters:[{name:"group_by","in":"query",type:"string",required:false,description:"Group results by some columns"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_family","in":"query",type:"array",required:false,description:"Filter by device_family"},{name:"os_family","in":"query",type:"array",required:false,description:"Filter by os_family"},{name:"useragent_family","in":"query",type:"array",required:false,description:"Filter by useragent_family"},{name:"corva_v3","in":"query",type:"boolean",required:false,description:"Filter by corva_v3"},{name:"corva_next","in":"query",type:"boolean",required:false,description:"Filter by corva_next (iOS app)"},{name:"user_group","in":"query",type:"string",required:false,description:"Filter by user_group emails"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/top_apps",method:"GET",summary:"Get Top App Usage Statistics",tags:["AppUsage"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of top apps to return (10, 20, or 30)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/top_users",method:"GET",summary:"Get Top Users Usage Statistics",tags:["AppUsage"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of top users to return (10, 20, or 30)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/total_usage_trend",method:"GET",summary:"Get Total AppUsage for each view_date",tags:["AppUsage"],parameters:[{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company_ids"},{name:"app_names","in":"query",type:"array",required:false,description:"Filter by app_names"},{name:"user_group","in":"query",type:"string",required:false,description:"Filter by user_group emails"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/usage_list",method:"GET",summary:"Get App Usage Statistics by user",tags:["AppUsage"],parameters:[{name:"app_name","in":"query",type:"string",required:true,description:"Filter by app name"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: -event_sum"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/usage_analytics/app_usage/view_date_list",method:"GET",summary:"Get App Usage Statistics day by day",tags:["AppUsage"],parameters:[{name:"app_name","in":"query",type:"string",required:true,description:"Filter by app name"},{name:"group_by","in":"query",type:"string",required:false,description:"Group results by some columns"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user_email (accepts only full email)"},{name:"program_id","in":"query",type:"array",required:false,description:"Filter by program_id"},{name:"asset_id","in":"query",type:"array",required:false,description:"Filter by asset_id"},{name:"well_id","in":"query",type:"array",required:false,description:"Filter by well_id"},{name:"pad_id","in":"query",type:"array",required:false,description:"Filter by pad_id"},{name:"fleet_id","in":"query",type:"array",required:false,description:"Filter by fleet_id"},{name:"rig_id","in":"query",type:"array",required:false,description:"Filter by rig_id"},{name:"drillout_unit_id","in":"query",type:"array",required:false,description:"Filter by drillout_unit_id"},{name:"device_type","in":"query",type:"string",required:false,description:"Filter by device_type"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Apps:[{path:"/v2/app_companies",method:"GET",summary:"List companies which have access to Apps",tags:["Company","Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps",method:"GET",summary:"List accessible apps",tags:["Apps"],parameters:[{name:"provider","in":"query",type:"any",required:false,description:"Company Provider name"},{name:"company_id","in":"query",type:"any",required:false,description:"Company ID"},{name:"type","in":"query",type:"any",required:false,description:"App type filter"},{name:"segment","in":"query",type:"any",required:false,description:"App segment filter"},{name:"app_category_id","in":"query",type:"any",required:false,description:"AppCategory filter"},{name:"category","in":"query",type:"any",required:false,description:"App category filter"},{name:"label","in":"query",type:"any",required:false,description:"App label"},{name:"owner","in":"query",type:"any",required:false,description:"Search by the user ID of the owner of the app"},{name:"installed","in":"query",type:"boolean",required:false,description:"App installed filter"},{name:"search","in":"query",type:"string",required:false,description:"Search app by name/description/summary/app_key"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"marketing_level","in":"query",type:"string",required:false,description:"Filter by marketing level"},{name:"followable","in":"query",type:"boolean",required:false,description:"Filter by followable flag"},{name:"app_key","in":"query",type:"string",required:false,description:"Filter by app key"},{name:"platform","in":"query",type:"string",required:false,description:"Filter by platform"},{name:"subscribed","in":"query",type:"boolean",required:false,description:"Filter by subscribed/unsubscribed"},{name:"rig_fleet_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Rig"},{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Frac Fleet"},{name:"drillout_unit_id","in":"query",type:"integer",required:false,description:"Filter by subscribed Drillout Unit"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"not_requested","in":"query",type:"boolean",required:false,description:"Filter by non-requested apps"},{name:"not_purchased","in":"query",type:"boolean",required:false,description:"Filter by non-purchased apps"},{name:"log_type","in":"query",type:"string",required:false,description:"Filter by log type. Can be \"time\", \"depth\" or \"all\""},{name:"full_lambda_name","in":"query",type:"string",required:false,description:"Find by full_lambda_name"},{name:"followable_scheduler_type","in":"query",type:"string",required:false,description:"Filter by BE app scheduler type allowed to follow. Can be used only when followable - true."},{name:"show_depends_apps","in":"query",type:"boolean",required:false,description:"Show 2-tier depends_on_apps data"},{name:"can_update","in":"query",type:"boolean",required:false,description:"Filter Apps by ability to update"},{name:"exclude_categories","in":"query",type:"array",required:false,description:"Array of app categories to exclude apps from request f.e. settings"},{name:"app_ids","in":"query",type:"array",required:false,description:"Filter apps by ID"},{name:"exclude_ids","in":"query",type:"array",required:false,description:"Filter out apps by ID"},{name:"exclude_app_keys","in":"query",type:"array",required:false,description:"Array of app keys to exclude apps from request"},{name:"dataset_id","in":"query",type:"integer",required:false,description:"Filter by Dataset ID"},{name:"author_id","in":"query",type:"integer",required:false,description:"Filter by Author"},{name:"temporary","in":"query",type:"boolean",required:false,description:"Filter permanent/temporary"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps",method:"POST",summary:"Create an app",tags:["Apps"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"GET",summary:"Show AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"POST",summary:"Create an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"PATCH",summary:"Update an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppErrorAlert",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts",method:"DELETE",summary:"Delete an AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/subscribe",method:"POST",summary:"Subscribe a user to AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_error_alerts/unsubscribe",method:"POST",summary:"Unsubscribe a user from AppErrorAlert",tags:["Apps","AppErrorAlert"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"AppErrorAlert with users data",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents",method:"GET",summary:"List AppHelpContents",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by title, description"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents",method:"POST",summary:"Create an AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created AppHelpContent",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"GET",summary:"Show AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"PATCH",summary:"Update an AppHelpContent",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated AppHelpContent",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/{id}",method:"DELETE",summary:"Delete an AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"AppHelpContent ID"}],responses:{"200":{description:"AppHelpContent deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/app_help_contents/signed_url",method:"GET",summary:"Get signed_url for AppHelpContent",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"file_name","in":"query",type:"string",required:true,description:"AppHelpContent file_name of attachment"},{name:"prefix","in":"query",type:"string",required:false,description:"AppHelpContent prefix of attachment"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not Found",schema:"any"}}},{path:"/v2/apps/{app_id}/packages",method:"GET",summary:"See all packages for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"GET",summary:"Show a specific packages for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"PATCH",summary:"Update a package",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}",method:"DELETE",summary:"Delete a package",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"200":{description:"Package Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/{id}/download",method:"GET",summary:"Download the latest package for an app",description:"Download a ZIP file with the latest app code",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"id","in":"path",type:"integer",required:true,description:"Package ID"}],responses:{"302":{description:"Fetches a file from S3 link and gets it downloaded"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/packages/upload",method:"POST",summary:"Upload a new package for an app",description:"Upload a ZIP file for the Dev Center Packager to build and deploy",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"package","in":"formData",type:"file",required:true,description:"Package ZIP file (field name must be package)"},{name:"github_username","in":"formData",type:"string",required:false,description:"Github username (optional)"},{name:"prebuilt","in":"formData",type:"boolean",required:false,description:"If true, indicates the uploaded zip is already built"},{name:"source","in":"formData",type:"string",required:false,description:"Request source (e.g. 'ui')"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"POST",summary:"Create a secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"PUT",summary:"Update secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_id}/secrets",method:"DELETE",summary:"Delete secret parameter for an app",tags:["Apps"],parameters:[{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"},{name:"key","in":"query",type:"string",required:true,description:"Parameter name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"422":{description:"Failure response",schema:"any"}}},{path:"/v2/apps/{app_key}/packages",method:"GET",summary:"See all packages for an app",tags:["Apps"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{app_key}/packages/upload",method:"POST",summary:"Upload a new package for an app",description:"Upload a ZIP file for the Dev Center Packager to build and deploy",tags:["Apps"],parameters:[{name:"app_key","in":"path",type:"string",required:true,description:"App Key"},{name:"package","in":"formData",type:"file",required:true,description:"Package ZIP file (field name must be package)"},{name:"github_username","in":"formData",type:"string",required:false,description:"Github username (optional)"},{name:"prebuilt","in":"formData",type:"boolean",required:false,description:"If true, indicates the uploaded zip is already built"},{name:"source","in":"formData",type:"string",required:false,description:"Request source (e.g. 'ui')"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"GET",summary:"Show app",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"PATCH",summary:"Update an App",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated App",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}",method:"DELETE",summary:"Delete an App",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"App deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/{id}/install",method:"POST",summary:"Install an app for your company",tags:["Apps"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/app_categories",method:"GET",summary:"List app categories",tags:["Apps"],parameters:[{name:"category","in":"query",type:"string",required:false,description:"Category of the AppCategories to fetch"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"return_as_nested_tree","in":"query",type:"boolean",required:false,description:"Returns AppCategories and Apps in a nested array"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/categories",method:"GET",summary:"List categories from look up table",tags:["Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/featured",method:"GET",summary:"List featured & promoted apps",tags:["Apps"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"marketing_level","in":"query",type:"string",required:false,description:"Filter by marketing level"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/apps/types",method:"GET",summary:"List app types",tags:["Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Assets:[{path:"/v2/assets",method:"GET",summary:"List assets",tags:["Assets"],parameters:[{name:"types","in":"query",type:"string",required:false,description:"List of asset types"},{name:"status","in":"query",type:"string",required:false,description:"Search by asset status (wells only; status is null for other asset types)"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by asset visibility"},{name:"ids","in":"query",type:"any",required:false,description:"List of asset IDs to filter by"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"parent_asset_id","in":"query",type:"integer",required:false,description:"Search by parent asset ID"},{name:"api_number","in":"query",type:"string",required:false,description:"Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored"},{name:"search","in":"query",type:"string",required:false,description:"Search by asset ID, asset name, api_number or customer_well_id"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"long_start","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"long_end","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"lat_start","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"lat_end","in":"query",type:"float",required:false,description:"Search by lon_lat coordinate area"},{name:"company_id","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"api_number","in":"query",type:"string",required:false,description:"Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like asset.asset_type. See example response for fields."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-last_active_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"range_filter_field","in":"query",type:"string",required:false,description:"Filtering datetime with start/end"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than or equal to the given timestamp"},{name:"last_active_drilling_before","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is smaller than the given timestamp"},{name:"last_active_drilling_after","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is greater than or equal to the given timestamp"},{name:"include_rig_id","in":"query",type:"boolean",required:false,description:"Add rig_id to response(only works with Asset::Rig)"},{name:"include_type_wells","in":"query",type:"boolean",required:false,description:"Add type wells to response(only works with Asset::Well)"},{name:"include_intervention_units","in":"query",type:"boolean",required:false,description:"Add intervention units to response"},{name:"polygon_coords","in":"query",type:"array",required:false,description:"Filter by assets within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed."}],responses:{"200":{description:"List assets",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}",method:"GET",summary:"Get asset by ID",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like asset.asset_type"}],responses:{"200":{description:"Show asset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/ancestor_ids",method:"GET",summary:"Return the ancestor_ids for the asset",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Ancestors",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/reruns",method:"GET",summary:"Return reruns for the asset",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Reruns",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/settings",method:"GET",summary:"Get asset settings",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"app_key","in":"query",type:"string",required:false,description:"App Key"},{name:"segment","in":"query",type:"string",required:false,description:"Used with app_key"},{name:"source_type","in":"query",type:"string",required:false,description:"Used with app_key"},{name:"log_type","in":"query",type:"string",required:false,description:"Used with source_type and app_key"},{name:"app_connection_id","in":"query",type:"integer",required:false,description:"App Connection ID"},{name:"app_stream_id","in":"query",type:"integer",required:false,description:"App Stream ID, used with app_key"}],responses:{"200":{description:"Asset settings, merged with optional connection settings",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_well",method:"POST",summary:"Create a new type_well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],requestBody:{contentType:"application/json",schema:"number",required:true},responses:{"200":{description:"Newly created type well object",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_wells",method:"GET",summary:"List type well assets",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"}],responses:{"200":{description:"Type well assets",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/{id}/type_wells/{type_well_id}",method:"DELETE",summary:"Delete type_well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Asset ID"},{name:"type_well_id","in":"path",type:"integer",required:true,description:"Type Well Id"}],responses:{"200":{description:"Delete type well object",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/autocomplete",method:"GET",summary:"Return autocompletion tokens",tags:["Assets"],parameters:[{name:"field","in":"query",type:"string",required:true,description:""},{name:"search","in":"query",type:"string",required:false,description:"Filter by a wildcard search"},{name:"company_id","in":"query",type:"integer",required:false,description:"Corva admins only. Scope to a particular company."}],responses:{"200":{description:"Search results",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/assets/resolve",method:"POST",summary:"Resolve old-style assets to new-style assets",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Resolution results",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units",method:"GET",summary:"List drillout units",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of drillout unit IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"well","in":"query",type:"integer",required:false,description:"Search by Well ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by drillout unit name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return drillout units that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like drillout_unit.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of drillout units to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List drillout units",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units",method:"POST",summary:"Create a drillout unit",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"GET",summary:"Get a single drillout unit",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Drillout Unit ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like drillout_unit.name"}],responses:{"200":{description:"Get drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"PATCH",summary:"Update a drillout unit",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated drillout unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/{id}",method:"DELETE",summary:"Delete a drillout unit",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Drillout Unit ID"}],responses:{"200":{description:"Drillout Unit deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/drillout_units/clusters",method:"GET",summary:"Get drillout units clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of drillout unit IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"well","in":"query",type:"integer",required:false,description:"Search by Well ID"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/favorites",method:"GET",summary:"List favorites",description:"Returns all of the favorites that are saved in a user's settings.favorites key.",tags:["Assets"],parameters:[{name:"fields","in":"query",type:"string",required:false,description:"Filter response fields, example: fields=rig.name,rig.active_well,well.name"}],responses:{"200":{description:"List user favorites",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets",method:"GET",operationId:"fracFleets",summary:"List frac fleets",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of frac fleet IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"current_pad","in":"query",type:"integer",required:false,description:"Search by Pad ID where it is the current Pad for the Frac Fleet"},{name:"search","in":"query",type:"string",required:false,description:"Search by frac fleet name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return frac fleets that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like frac fleet.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of frac fleets to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List frac fleets",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets",method:"POST",summary:"Create a frac fleet",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/active_wells/well_cache",method:"GET",summary:"Get well_cache records for the active wells on the frac fleet",tags:["Assets"],parameters:[{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Frac Fleet ID"},{name:"Serializer","in":"header",type:"string",required:false,description:"Controls how the data is serialized. Options: \"completions-widget\""}],responses:{"200":{description:"Well Cache Record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/pads/{id}",method:"DELETE",summary:"Delete a pad from a frac fleet",tags:["Assets"],parameters:[{name:"frac_fleet_id","in":"path",type:"any",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"GET",summary:"Get a single frac fleet",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like frac_fleet.name"}],responses:{"200":{description:"Get frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"PATCH",summary:"Update a frac fleet",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}",method:"DELETE",summary:"Delete a frac fleet",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Frac Fleet ID"}],responses:{"200":{description:"Frac Fleet deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{id}/pads",method:"POST",summary:"Add one or more pads to a frac fleet, or set the current pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Updated frac fleet",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/clusters",method:"GET",summary:"Get frac fleets clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of frac fleet IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"current_pad","in":"query",type:"integer",required:false,description:"Search by Pad ID where it is the current Pad for the Frac Fleet"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads",method:"GET",operationId:"pads",summary:"List pads",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of pad IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"current_frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID where it is the current Frac Fleet on the Pad"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by pad name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like pad.name"},{name:"active","in":"query",type:"boolean",required:false,description:"Return records that have an active well"},{name:"current","in":"query",type:"boolean",required:false,description:"Return records that are current based on PadFracFleet"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"well_ids","in":"query",type:"any",required:false,description:"Filter by array of well ids"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of pads to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List pads",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads",method:"POST",summary:"Create a pad",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"GET",summary:"Get a single pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Pad ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like pad.name"}],responses:{"200":{description:"Get pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"PATCH",summary:"Update a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}",method:"DELETE",summary:"Delete a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad ID"}],responses:{"200":{description:"Pad deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/active_wells",method:"POST",summary:"Add an active well to a pad",description:"Set one or more wells on a pad so that they are part of the active_wells list. Also adds the wells to the pad.wells list, if not found.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/frac_fleets",method:"POST",summary:"Add a frac fleet to a pad",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/wells",method:"GET",summary:"Retrieve well and app stream details for a pad",description:"Retrieve the wells and nested app streams for a pad.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"segment","in":"query",type:"string",required:false,description:"Segments to filter the wells and app streams by"},{name:"source_type","in":"query",type:"string",required:false,description:"Source Types to filter the wells and app streams by"},{name:"log_type","in":"query",type:"string",required:false,description:"Log Types to filter the wells and app streams by"},{name:"status","in":"query",type:"string",required:false,description:"Statuses to filter app streams by"},{name:"include_intervention_units","in":"query",type:"any",required:false,description:"Include intervention units in the response"}],responses:{"200":{description:"Pad Details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{id}/wells",method:"POST",summary:"Add a well to a pad",description:"Set one or more wells so that they belong to a pad.",tags:["Assets"],parameters:[{name:"id","in":"path",type:"any",required:false,description:"Pad ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/active_wells/{id}",method:"DELETE",summary:"Delete an active well from a pad",description:"Remove a well from a pad.active_wells list.",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Well ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/app_wells",method:"GET",summary:"Retrieve wells and app stream details for a pad filtered by app.source_type",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"integer",required:"true",description:"Pad ID"},{name:"dashboard_app_id","in":"query",type:"integer",required:false,description:"Find app by Dashboard app id"},{name:"app_id","in":"query",type:"integer",required:false,description:"Find app by app id"},{name:"app_key","in":"query",type:"string",required:false,description:"Find app by app key"}],responses:{"200":{description:"Pad Details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/frac_fleets/{id}",method:"DELETE",summary:"Delete a frac fleet from a pad",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Frac Fleet ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/{pad_id}/wells/{id}",method:"DELETE",summary:"Delete a well from a pad",description:"Remove a well from a pad. Also removes the well from the pad.active_wells list, if found.",tags:["Assets"],parameters:[{name:"pad_id","in":"path",type:"any",required:false,description:"Pad ID"},{name:"id","in":"path",type:"any",required:false,description:"Well ID"}],responses:{"200":{description:"Updated pad",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pads/clusters",method:"GET",summary:"Get pads clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of pad IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"current_frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID where it is the current Frac Fleet on the Pad"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs",method:"GET",summary:"List programs",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of program IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"name","in":"query",type:"string",required:false,description:"Search by program name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like program.name"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of programs to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List programs",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs",method:"POST",summary:"Create a program",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"GET",summary:"Get a single program",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Program ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like program.name"}],responses:{"200":{description:"Get program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"PATCH",summary:"Update a program",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated program",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/{id}",method:"DELETE",summary:"Delete a program",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Program ID"}],responses:{"200":{description:"Program deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/programs/clusters",method:"GET",summary:"Get programs clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of program IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories",method:"GET",summary:"List rig template categories",tags:["Assets"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories",method:"POST",summary:"Create a rig template category",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig template category",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"GET",summary:"Show Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"PATCH",summary:"Update a Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template Category",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_template_categories/{id}",method:"DELETE",summary:"Delete a Rig Template Category",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Category ID"}],responses:{"200":{description:"Rig Template Category deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates",method:"GET",summary:"List rig templates",tags:["Assets"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter rig templates by rig_id"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter rig templates by company_id"},{name:"search","in":"query",type:"string",required:false,description:"Search rig templates by rig name"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates",method:"POST",summary:"Create a rig template",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"GET",summary:"Show Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"PATCH",summary:"Update a Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{id}",method:"DELETE",summary:"Delete a Rig Template",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Rig Template deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items",method:"GET",summary:"List items of rig template",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items",method:"POST",summary:"Create a rig template item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Rig Template Item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"GET",summary:"Show Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"PATCH",summary:"Update Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Rig Template Item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/{rig_template_id}/rig_template_items/{id}",method:"DELETE",summary:"Delete a Rig Template Item",tags:["Assets"],parameters:[{name:"rig_template_id","in":"path",type:"integer",required:true,description:"Rig Template ID"},{name:"id","in":"path",type:"integer",required:true,description:"Rig Template Item ID"}],responses:{"200":{description:"Rig Template Item deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rig_templates/aggregated_values",method:"GET",operationId:"getRigTemplatesAggregatedValues",summary:"Get aggregated values from rig template items",tags:["Assets"],parameters:[{name:"rig_template_id","in":"query",type:"integer",required:false,description:"Rig Template ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"rig_id","in":"query",type:"integer",required:false,description:"Rig ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"well_id","in":"query",type:"integer",required:false,description:"Well ID (provide one of rig_id, well_id, or rig_template_id)"},{name:"rig_template_category_name","in":"query",type:"string",required:true,description:"Name of the rig template category"},{name:"rig_template_item_field","in":"query",type:"string",required:false,description:"Field from rig template item data to aggregate (default: name)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs",method:"GET",summary:"List rigs",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of rig IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"active_well","in":"query",type:"integer",required:false,description:"Search by active well ID"},{name:"has_active_well","in":"query",type:"integer",required:false,description:"Return rigs that have an active well"},{name:"search","in":"query",type:"string",required:false,description:"Search by rig name"},{name:"app_key","in":"query",type:"string",required:false,description:"Return rigs that have been part of any product subscription that included the given app"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like rig.name"},{name:"active","in":"query",type:"string",required:false,description:"Return records that have an active well"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of rigs to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: program,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List rigs",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs",method:"POST",summary:"Create a rig",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"GET",summary:"Get a single rig",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Rig ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like rig.name"}],responses:{"200":{description:"Get rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"PATCH",summary:"Update a rig",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated rig",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{id}",method:"DELETE",summary:"Delete a rig",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Rig ID"}],responses:{"200":{description:"Rig deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/{rig_id}/active_well/well_cache",method:"GET",summary:"Get well_cache record for the active well on the rig",tags:["Assets"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Rig ID"},{name:"Serializer","in":"header",type:"string",required:false,description:"Controls how the data is serialized. Options: \"drilling-widget\""}],responses:{"200":{description:"Well Cache Record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/rigs/clusters",method:"GET",summary:"Get rigs clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of rig IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"active_well","in":"query",type:"integer",required:false,description:"Search by active well ID"},{name:"has_active_well","in":"query",type:"integer",required:false,description:"Return rigs that have an active well"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells",method:"GET",summary:"List wells",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of well IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"status","in":"query",type:"string",required:false,description:"Search by well status"},{name:"state","in":"query",type:"string",required:false,description:"Search by well state"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by well visibility"},{name:"identifier","in":"query",type:"string",required:false,description:"Search by well identifier"},{name:"area","in":"query",type:"string",required:false,description:"Search by well area"},{name:"search","in":"query",type:"string",required:false,description:"Search by well name"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well.name"},{name:"active_before","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"datetime",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"last_active_drilling_before","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is smaller than the given timestamp"},{name:"last_active_drilling_after","in":"query",type:"datetime",required:false,description:"Return records where last_drilling_at is greater than the given timestamp"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of wells to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,status,visibility,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"filter_by_completed_streams","in":"query",type:"string",required:false,description:"Search by wells that have completed app_streams"},{name:"include_completed_idle_paused_stream","in":"query",type:"boolean",required:false,description:"Add has_completed_idle_paused_stream attribute to response"},{name:"app_segment","in":"query",type:"string",required:false,description:"Add app segment value to find out completed streams"},{name:"app_stream_source_type","in":"query",type:"string",required:false,description:"Search by wells with app_streams by source_type"},{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"distance","in":"query",type:"object",required:false,description:"Hash - latitude/longitude. Will return distance from point specified to well location for each well found."},{name:"point_and_distance","in":"query",type:"object",required:false,description:"Filter by wells between geo point and distance in miles. Subject point is the center of the circle."},{name:"polygon_coords","in":"query",type:"array",required:false,description:"Filter by wells within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed."},{name:"well_start_before","in":"query",type:"integer",required:false,description:"Filter by well_start_before in seconds timestamp"},{name:"well_start_after","in":"query",type:"integer",required:false,description:"Filter by well_start_after in seconds timestamp"},{name:"is_asset_viewer","in":"query",type:"boolean",required:false,description:"Filter by custom_property is_asset_viewer"},{name:"archivation_date_before","in":"query",type:"integer",required:false,description:"Filter by archivation_date_before in seconds timestamp"},{name:"archivation_date_after","in":"query",type:"integer",required:false,description:"Filter by archivation_date_after in seconds timestamp"},{name:"archivation_performer_id","in":"query",type:"array",required:false,description:"Filter by archivation_performer_id"},{name:"intervention_unit_event_id","in":"query",type:"array",required:false,description:"Filter by intervention_unit_event_id"},{name:"intervention_unit_id","in":"query",type:"array",required:false,description:"Filter by intervention_unit_id"}],responses:{"200":{description:"List wells",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells",method:"POST",summary:"Create a well",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"GET",summary:"Get a single well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Well ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well.name"}],responses:{"200":{description:"Get well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"PATCH",summary:"Update a well",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{id}",method:"DELETE",summary:"Delete a well",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well ID"}],responses:{"200":{description:"Well deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/clusters",method:"GET",summary:"Get wells clustered based on their location",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of well IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"pad","in":"query",type:"integer",required:false,description:"Search by Pad ID"},{name:"drillout_unit","in":"query",type:"integer",required:false,description:"Search by Drillout Unit ID"},{name:"frac_fleet","in":"query",type:"integer",required:false,description:"Search by Frac Fleet ID"},{name:"status","in":"query",type:"string",required:false,description:"Search by well status"},{name:"state","in":"query",type:"string",required:false,description:"Search by well state"},{name:"visibility","in":"query",type:"string",required:false,description:"Search by well visibility"},{name:"identifier","in":"query",type:"string",required:false,description:"Search by well identifier"},{name:"area","in":"query",type:"string",required:false,description:"Search by well area"},{name:"active_before","in":"query",type:"integer",required:false,description:"Return records where last_active_at is smaller than the given timestamp"},{name:"active_after","in":"query",type:"integer",required:false,description:"Return records where last_active_at is greater than the given timestamp"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"cluster_radius","in":"query",type:"float",required:false,description:"Defines how big clusters are returned."}],responses:{"200":{description:"Well clusters",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines",method:"GET",summary:"List wirelines",tags:["Assets"],parameters:[{name:"ids","in":"query",type:"any",required:false,description:"List of wireline IDs to filter by"},{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by wireline name"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like wireline.name"},{name:"lat_start","in":"query",type:"float",required:false,description:"Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"lat_end","in":"query",type:"float",required:false,description:"Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_start","in":"query",type:"float",required:false,description:"Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"long_end","in":"query",type:"float",required:false,description:"Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined."},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of wirelines to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List wirelines",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines",method:"POST",summary:"Create a wireline",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"GET",summary:"Get a single wireline",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Wireline ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like wireline.name"}],responses:{"200":{description:"Get wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"PATCH",summary:"Update a wireline",tags:["Assets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated wireline",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wirelines/{id}",method:"DELETE",summary:"Delete a wireline",tags:["Assets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Wireline ID"}],responses:{"200":{description:"Wireline deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Audit:[{path:"/v2/events/publish",method:"POST",summary:"Publish Events",tags:["Event","Audit"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Audits:[{path:"/v2/api_key_audits",method:"GET",summary:"List ApiKey Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Filter by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dataset_audits",method:"GET",summary:"List Dataset Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"start","in":"query",type:"integer",required:false,description:"Filter by event time (Unix timestamp)"},{name:"end","in":"query",type:"integer",required:false,description:"Filter by event time (Unix timestamp)"},{name:"permission_workflow","in":"query",type:"string",required:false,description:"Filter by Permission column"},{name:"name","in":"query",type:"string",required:false,description:"Searches by dataset name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"data_type","in":"query",type:"string",required:false,description:"Filter by data_type"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/group_membership_audits",method:"GET",summary:"List Group Membership Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action (add, remove)"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by performer email"},{name:"target_user_email","in":"query",type:"string",required:false,description:"Search by target user email"},{name:"group_name","in":"query",type:"string",required:false,description:"Search by group name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_audits",method:"GET",summary:"List Package Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Filter by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"app_name","in":"query",type:"string",required:false,description:"Filter by app name"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/permission_audits",method:"GET",summary:"List Permission Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"ability","in":"query",type:"string",required:false,description:"Search by ability"},{name:"owner_name","in":"query",type:"string",required:false,description:"Search by owner name"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscription_audits",method:"GET",summary:"List PlatformSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscription_audits",method:"GET",summary:"List ProvisioningSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscription_audits",method:"GET",summary:"List PurchaseSubscription Audits",tags:["Audits"],parameters:[{name:"action_name","in":"query",type:"string",required:false,description:"Search by action"},{name:"user_email","in":"query",type:"string",required:false,description:"Searches by user email"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: action, -created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],BlacklistedDatasets:[{path:"/v2/groups/{group_id}/blacklisted_datasets",method:"GET",summary:"List of blacklisted datasets",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets",method:"POST",summary:"Create BlacklistedDataset",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets/{id}",method:"DELETE",summary:"Delete a blacklisted dataset",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"},{name:"id","in":"path",type:"integer",required:true,description:"BlacklistedDataset ID"}],responses:{"200":{description:"BlacklistDataset deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/blacklisted_datasets/bulk_create",method:"POST",summary:"Create many BlacklistedDatasets",tags:["BlacklistedDatasets"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"BlacklistedDataset group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"}}}],ColumnMapperTemplateChannels:[{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels",method:"POST",summary:"Create column mapper template channel",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template channel",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}",method:"PATCH",summary:"Update column mapper template channel",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template channel",schema:"any"}}},{path:"/v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}",method:"DELETE",summary:"Delete column mapper",tags:["ColumnMapperTemplateChannels"],parameters:[{name:"column_mapper_template_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"}],responses:{"200":{description:"ColumnMapperTemplateChannel deleted",schema:"any"}}}],ColumnMapperTemplateRules:[{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules",method:"POST",summary:"Create column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template rule",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}",method:"PATCH",summary:"Update column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[{name:"column_mapper_template_channel_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateRule ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template rule",schema:"any"}}},{path:"/v2/column_mapper_template_channels/{column_mapper_channel_id}/column_mapper_template_rules/{id}",method:"DELETE",summary:"Delete column mapper template rule",tags:["ColumnMapperTemplateRules"],parameters:[{name:"column_mapper_channel_id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateChannel ID"},{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplateRule ID"}],responses:{"200":{description:"ColumnMapperTemplateRule deleted",schema:"any"}}}],ColumnMapperTemplates:[{path:"/v2/column_mapper_templates",method:"GET",summary:"Get list of column mapper templates",tags:["ColumnMapperTemplates"],parameters:[{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter by Rig ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by column mapper name or rig name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"}],responses:{"200":{description:"List of column mapper templates",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates",method:"POST",summary:"Create column mapper template",tags:["ColumnMapperTemplates"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Created column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"GET",summary:"Get one column mapper template by ID",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],responses:{"200":{description:"Column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"PATCH",summary:"Update column mapper",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}",method:"DELETE",summary:"Delete column mapper",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],responses:{"200":{description:"ColumnMapperTemplate deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}/add_asset",method:"PUT",summary:"Add asset to column mapper template",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Rig was added to column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/column_mapper_templates/{id}/remove_asset",method:"PUT",summary:"Remove rig from column mapper template",tags:["ColumnMapperTemplates"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"ColumnMapperTemplate ID"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Rig was removed from column mapper template",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Company:[{path:"/v1/companies",method:"GET",summary:"List of Companies",tags:["Company"],parameters:[{name:"existing_partial_reruns","in":"query",type:"boolean",required:false,description:"Filter by existing partial reruns"},{name:"provider","in":"query",type:"array",required:false,description:"Filter by provider (string or array of strings)"},{name:"search","in":"query",type:"string",required:false,description:"Search by name"},{name:"ids","in":"query",type:"array",required:false,description:"Filter by company IDs (array or comma-separated string)"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/company",method:"GET",summary:"Show current user Company",tags:["Company"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/company",method:"PATCH",summary:"Update Company",tags:["Company"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/company/{id}",method:"GET",summary:"Show Company by ID",tags:["Company"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found",schema:"any"}}},{path:"/v2/app_companies",method:"GET",summary:"List companies which have access to Apps",tags:["Company","Apps"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],CompetitorAnalysis:[{path:"/v1/competitor_analysis/statistics",method:"GET",summary:"Get Competitor Analysis statistics",tags:["CompetitorAnalysis"],parameters:[{name:"asset_id","in":"query",type:"integer",required:true,description:"Asset ID"},{name:"radius","in":"query",type:"float",required:true,description:"Filter by radius"},{name:"keys","in":"query",type:"any",required:true,description:"Metric keys"},{name:"type","in":"query",type:"float",required:true,description:"Metrics type"},{name:"rig_release","in":"query",type:"string",required:false,description:"Filter by rig release"},{name:"target_formations","in":"query",type:"any",required:false,description:"Target Formations"},{name:"string_designs","in":"query",type:"any",required:false,description:"String Designs"},{name:"wells_number","in":"query",type:"integer",required:false,description:"Number of wells to return stats for (500 max)"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Countries:[{path:"/v2/country_list",method:"GET",summary:"Get list of available countries",tags:["Countries"],parameters:[],responses:{"200":{description:"Successful response",schema:"CountryList"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}}],DashboardAppAnnotations:[{path:"/v2/dashboard_app_annotations",method:"GET",summary:"List annotations for app-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"active","in":"query",type:"boolean",required:false,description:"Set to true to return active annotations, false - to return not active annotations"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID"},{name:"app_id","in":"query",type:"integer",required:false,description:"App ID"},{name:"user_id","in":"query",type:"integer",required:false,description:"Filter by user ID"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user email"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations",method:"POST",summary:"Create an app annotation",tags:["DashboardAppAnnotations"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app annotation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/",method:"GET",summary:"List comments for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"offset","in":"query",type:"integer",required:false,description:"Offset for pagination"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/",method:"POST",summary:"Create a comment for app annotation",tags:["DashboardAppAnnotations"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created app annotation comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes",method:"GET",summary:"List likes for app annotation's comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{comment_id}/likes/toggle",method:"POST",summary:"Toggle a like for app annotation's comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"comment_id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Created/deleted alert app annotation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"GET",summary:"Show comment for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"PATCH",summary:"Update an app annotation comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated app annotation comment",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/comments/{id}",method:"DELETE",summary:"Delete an app annotation comment",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"},{name:"id","in":"path",type:"integer",required:true,description:"Comment ID"}],responses:{"200":{description:"App Annotation comment deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/likes",method:"GET",summary:"List likes for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{app_annotation_id}/likes/toggle",method:"POST",summary:"Toggle a like for app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"app_annotation_id","in":"path",type:"integer",required:true,description:"App Annotation ID"}],responses:{"200":{description:"Created/deleted app annotation like"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"GET",summary:"Show app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"PATCH",summary:"Update an app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated app annotation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}",method:"DELETE",summary:"Delete an app annotation",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"App annotation deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/{id}/close",method:"GET",summary:"Closes app annotation for curent user, returns new last annotation for user and app-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DashboardAppAnnotation ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_app_annotations/last_annotations",method:"GET",summary:"Returns last app annotations for current user and dashboard or dashboard-asset combination",tags:["DashboardAppAnnotations"],parameters:[{name:"dashboard_id","in":"query",type:"integer",required:true,description:"Dashboard ID"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID"},{name:"parent_asset_id","in":"query",type:"integer",required:false,description:"Parent Asset ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Dashboards:[{path:"/v1/users/{user_id}/dashboards",method:"GET",summary:"List dashboards for user",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/bulk_create",method:"POST",summary:"Bulk create dashboard_apps for different asset_ids",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/users/{user_id}/dashboards/{id}",method:"GET",summary:"Get dashboard by ID",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares",method:"GET",summary:"List dashboard folder shares",tags:["Dashboards"],parameters:[{name:"viewed","in":"query",type:"boolean",required:false,description:"Filter by viewed"},{name:"viewed","in":"owner_id",type:"integer",required:false,description:"Filter by Owner ID"},{name:"viewed","in":"dashboard_folder_id",type:"integer",required:false,description:"Filter by DashboardFolder ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares",method:"POST",summary:"Create a dashboard folder share",tags:["Dashboards"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Dashboard Folder Share",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}",method:"PATCH",summary:"Update a dashboard folder share",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard folder share",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}",method:"DELETE",summary:"Delete a dashboard folder share",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],responses:{"200":{description:"Dashboard folder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboard_folder_shares/{id}/use",method:"POST",summary:"Use dashboard folder share for user",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder Share ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Copied dashboard folder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards",method:"GET",summary:"List all dashboards",tags:["Dashboards"],parameters:[{name:"visibility","in":"query",type:"string",required:false,description:"Filter Dashboards by visibility"},{name:"type","in":"query",type:"string",required:false,description:"Filter Dashboards by type"},{name:"viewed","in":"query",type:"string",required:false,description:"Filter Dashboards by viewed"},{name:"segment","in":"query",type:"string",required:false,description:"Filter Dashboards by segment"},{name:"layout","in":"query",type:"string",required:false,description:"Filter Dashboards by layout"},{name:"category","in":"query",type:"string",required:false,description:"Filter Dashboards by category"},{name:"exclude_shared","in":"query",type:"boolean",required:false,description:"Filter Shared Dashboards"},{name:"can_update","in":"query",type:"boolean",required:false,description:"Filter Dashboards by ability to update"},{name:"sort","in":"query",type:"string",required:false,description:"Sort dashboards by order field"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards/{id}/available_timezones",method:"GET",summary:"List timezones for dashboard",tags:["Dashboards"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/dashboards/templates",method:"GET",summary:"Get template dashboards",tags:["Dashboards"],parameters:[],responses:{"200":{description:"Template dashboards",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders",method:"GET",summary:"List dashboard folders",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders",method:"POST",summary:"Create a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard folder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares",method:"GET",summary:"List dashboard shares in a dashboard folder for a user",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares",method:"POST",summary:"Add a dashboard share to a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Added record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}",method:"PATCH",summary:"Update a dashboard share in a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"},{name:"id","in":"path",type:"integer",required:true,description:"DashboardFolderDashboardShare ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{dashboard_folder_id}/dashboard_shares/{id}",method:"DELETE",summary:"Remove a dashboard share from a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_folder_id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"},{name:"id","in":"path",type:"integer",required:true,description:"DashboardFolderDashboardShare ID"}],responses:{"200":{description:"Record deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{id}",method:"PATCH",summary:"Update a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboard_folders/{id}",method:"DELETE",summary:"Delete a dashboard folder",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Folder ID"}],responses:{"200":{description:"Dashboard folder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards",method:"GET",summary:"List dashboards",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards",method:"POST",summary:"Create a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps",method:"POST",summary:"Create a dashboard app with app name and category",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"GET",summary:"Show dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"PATCH",summary:"Update a dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],requestBody:{contentType:"application/json",schema:"object",required:true},responses:{"200":{description:"Updated dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/{id}",method:"DELETE",summary:"Delete a dashboard app",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Dashboard app deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_apps/batch_update",method:"PUT",summary:"Update all dashboard apps in a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters",method:"GET",summary:"Get data filters for dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters",method:"POST",summary:"Create a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"GET",summary:"Show data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Data Filter ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"PATCH",summary:"Update a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated data filter",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters/{id}",method:"DELETE",summary:"Delete a data filter",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Data filter deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/data_filters#2",method:"POST",summary:"Update multiple data filters",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"GET",summary:"Show dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"filter_asset_id","in":"path",type:"integer",required:true,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"PATCH",summary:"Update a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}",method:"DELETE",summary:"Delete a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Dashboard deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}/clone",method:"POST",summary:"Clone a dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Cloned dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{id}/use_template",method:"POST",summary:"Set dashboard apps and layout from a template dashboard",tags:["Dashboards"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Modified dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Data:[{path:"/v1/data/{provider}/{dataset}",method:"GET",summary:"Retrieve records of data from a dataset",description:"Retrieve an array of records from a dataset based on one or more filters. Ensure that all values in the querystring are URL encoded to prevent misinterpretation, especially \"#\" and other symbols.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"company_id","in":"query",type:"integer",required:false,description:"Returns data only for the company with this ID. Otherwise, returns data for the current user or API key company. Only applies to Corva company admins."},{name:"asset_id","in":"query",type:"integer",required:false,description:"Returns data only for the asset with this ID. Otherwise, returns all data."},{name:"query","in":"query",type:"string",required:false,description:"Value for any additional data filters. Accepts fields in the format {field#operator#value}. Ensure the value is URL encoded to avoid misinterpretation. Valid operators are gt, gte, lt, lte, eq, ne, in, exists and elemmatch. Multiple fields can be chained with \"AND\". Example: {state#eq#InSlips}AND{timestamp#gte#1577836800}AND{elements#elemmatch#{\"key\": \"value\"}}"},{name:"where","in":"query",type:"string",required:false,description:"Use a MongoDB $where query. This allows calculations on each data record to filter by. Do not include `function()`."},{name:"map","in":"query",type:"string",required:false,description:"Use a MongoDB $map aggregation. See MongoDB documentation for more detail."},{name:"reduce","in":"query",type:"string",required:false,description:"Use a MongoDB $reduce aggregation. See MongoDB documentation for more detail."},{name:"aggregate","in":"query",type:"string",required:false,description:"MongoDB aggregation pipeline. See MongoDB documentation for more details about pipelines and how to construct them."},{name:"distinct","in":"query",type:"string",required:false,description:"Field name to perform a MongoDB distinct grouping on. See MongoDB documentation for more details about pipelines and how to construct them."},{name:"sort","in":"query",type:"string",required:false,description:"Value for database sorting. Takes one or more fields in a key/value map. Example: {state: 1, timestamp: -1}"},{name:"limit","in":"query",type:"integer",required:false,description:"How many data items to return. Best practice is to limit to a small dataset (usually ~100 records) and paginate to reduce server load and bandwidth. Default: 1. Maximum: 10000."},{name:"fields","in":"query",type:"string",required:false,description:"A comma separated list of fields to return from the queried document."},{name:"projection","in":"query",type:"string",required:false,description:"Use a MongoDB projection. If this field is provided, \"fields\" is ignored."},{name:"filter_inaccessible_assets","in":"query",type:"string",required:false,description:"Filters inaccessible assets from your query or aggregate instead of returning an error message. Set any value to turn filtering on."},{name:"count","in":"query",type:"string",required:false,description:"Returns count of documents after filters applied. \"count=true\" can be passed to receive count response"}],responses:{"200":{description:"List data for a provider and dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}",method:"POST",summary:"Save one or more records of data to a dataset",description:"Create data by inserting it a dataset. The provider and dataset must exist in order for data to be saved, although no error will be raised if either is not found. This endpoint accepts an array of records, and performs an upsert for each record that has a _id value.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."}],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"Return saved data statistics",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}",method:"DELETE",summary:"Delete selected data records from a dataset",description:"Delete multiple records from a dataset, based on data filters that are provided. Use caution and ensure that your filters are not too broad, or you may end up unintentionally deleting data.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"query","in":"query",type:"string",required:false,description:"Value for any data filters. Accepts fields in the format {field#operator#value}. Ensure the value is URL encoded to avoid misinterpretation. Valid operators are gt, gte, lt, lte, eq, ne, and in. Multiple fields can be chained with \"AND\". Example: {state#eq#InSlips}AND{timestamp#gte#1577836800}"}],responses:{"200":{description:"Return deleted count",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"GET",summary:"Retrieve a single data record from a dataset",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Unique ID for the data record"},{name:"fields","in":"query",type:"string",required:false,description:"A comma separated list of fields to return from the queried document."},{name:"projection","in":"query",type:"string",required:false,description:"Use a MongoDB projection. If this field is provided, \"fields\" is ignored."}],responses:{"200":{description:"Show data record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"PUT",summary:"Replace data record in a dataset",description:"Replace fields in a data record. This will completely delete any existing fields and replace them with the new data record that is passed in.",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Mongo ObjectID to associate with the data record. Automatically generated if not provided. If provided and it matches an existing record, that record is overwritten. If it does not match an existing record, a new record is inserted."}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Return saved data statistics",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"PATCH",summary:"Update fields in a data record in a dataset",description:"Update metadata and fields in a data record. This will update existing fields and insert any new fields that are found, but will leave all existing fields alone",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Mongo ObjectID to associate with the data record. Automatically generated if not provided. If provided and it matches an existing record, that record is overwritten. If it does not match an existing record, a new record is inserted."}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Return data record",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/data/{provider}/{dataset}/{id}",method:"DELETE",summary:"Delete a single data record from a dataset",tags:["Data"],parameters:[{name:"provider","in":"path",type:"string",required:false,description:"Provider value for the company that owns the data dataset. Usually \"corva\"."},{name:"dataset","in":"path",type:"string",required:false,description:"Name of the dataset to retrieve data for."},{name:"id","in":"path",type:"string",required:false,description:"Unique data record identifier for the record to be deleted."}],responses:{"200":{description:"Deletion status"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],"Data Export App":[{path:"/v2/data_export_app",method:"GET",summary:"Get enriched well export data",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by Well visibility"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"keys","in":"query",type:"array",required:false,description:"Optional list of metric keys to return under `metrics`"},{name:"drillstring_keys","in":"query",type:"array",required:false,description:"Optional list of drillstrings keys to return under `drillstrings`"},{name:"data_type","in":"query",type:"string",required:false,description:"Optional filter by data.type"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by (e.g. `county`, `rig_type`, `bit_depth`, etc.)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/data_export_app/activity_code_mappings",method:"GET",summary:"Get activity code type mappings for a company",tags:["Data Export App"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID to fetch activity code mappings for"}],responses:{"200":{description:"Successful response with mappings(or empty array if none exist)",schema:"ActivityCodeMappingsList"},"400":{description:"Bad request - company_id is required"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to wells in this company"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/data_export_app/column_fields",method:"GET",summary:"Get column fields for a column in export index endpoint",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"},{name:"lookup_field","in":"query",type:"string",required:false,description:"A lookup field to lookup column fields in the app. Currently supported three main groups well, bha, metrics. Main groups are names before first dot. Lookup fields example F.e. well.name, bha.pdm.maker, metrics.hour.bit_depth.formation_id"}],responses:{"200":{description:"Successful response",schema:"DataExportColumnFields"}}},{path:"/v2/data_export_app/column_fields_list",method:"POST",summary:"Get column fields for a column in export index endpoint",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"},{name:"lookup_field","in":"query",type:"string",required:false,description:"A lookup field to lookup column fields in the app. Currently supported three main groups well, bha, metrics. Main groups are names before first dot. Lookup fields example F.e. well.name, bha.pdm.maker, metrics.hour.bit_depth.formation_id"}],responses:{"200":{description:"Successful response",schema:"DataExportColumnFields"}}},{path:"/v2/data_export_app/flat",method:"POST",summary:"Get flat JSON:API-like response for global sorting",description:"Returns a flat array of items (BHA, well_section, well, mud) with global sorting support.\n\n**Key differences from /list endpoint:**\n- **Flat structure**: Items in `data` array, wells deduplicated in `included`\n- **Global sorting**: Array order IS the sort order - no need for sorted_metric_order indices\n- **Clear counts**: `total_count` (static) vs `filtered_count` (dynamic with filters)\n- **Optimized for large datasets**: Batched MongoDB queries for 7000+ wells\n\n**Response structure:**\n```json\n{\n \"data\": [{ \"id\": \"bha_123_456_2\", \"type\": \"bha\", \"attributes\": {...}, \"relationships\": {...} }],\n \"included\": [{ \"id\": 123, \"type\": \"well\", \"attributes\": {...} }],\n \"meta\": { \"total_count\": 150, \"filtered_count\": 45, \"has_more\": true, \"page\": 1, \"per_page\": 80 }\n}\n```\n",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination (default: 1)"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page (default: 80)"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"data_type","in":"query",type:"string",required:false,description:"Data type to return (determines item grouping)"},{name:"keys","in":"query",type:"array",required:false,description:"Metric keys to include in attributes (filter_keys)"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by globally (e.g., bit_depth, start_depth, name)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction (default: asc)"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Filter condition"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response with flat items and metadata",schema:"DataExportFlatResponse"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to requested wells/companies"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/data_export_app/list",method:"POST",summary:"Get enriched well export data",tags:["Data Export App"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number for pagination"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items per page"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by Well visibility"},{name:"company_ids","in":"query",type:"array",required:false,description:"Filter by company IDs"},{name:"well_ids","in":"query",type:"array",required:false,description:"Filter by Well IDs"},{name:"asset_ids","in":"query",type:"array",required:false,description:"Filter by Asset IDs"},{name:"keys","in":"query",type:"array",required:false,description:"Optional list of metric keys to return under `metrics`"},{name:"drillstring_keys","in":"query",type:"array",required:false,description:"Optional list of drillstrings keys to return under `drillstrings`"},{name:"data_type","in":"query",type:"string",required:false,description:"Optional filter by data.type"},{name:"sort_field","in":"query",type:"string",required:false,description:"Field to sort by (e.g. `county`, `rig_type`, `bit_depth`, etc.)"},{name:"sort_direction","in":"query",type:"string",required:false,description:"Sort direction"},{name:"filters[].field","in":"query",type:"string",required:false,description:"Field name to filter by (e.g. `county`, `bit_depth`)"},{name:"filters[].condition","in":"query",type:"string",required:false,description:"Condition for filtering"},{name:"filters[].value","in":"query",type:"string",required:false,description:"Value to compare against"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/data_export_app/metrics_definitions",method:"GET",summary:"Get dynamic metric definitions for a company",description:"Returns per-company dynamic metric metadata from the `corva#metrics.definitions`\nMongoDB collection. The FE uses this to render custom metrics (name, category,\nunit, ILT icon/color) without hardcoding them per company.\n\nNotes:\n- One entry per segment; only the **latest** document per segment is returned.\n- Backend-internal fields (`rules`, `restrict`, `description`) are stripped.\n- `usage_rules` is included as-is when present; FE matches wells by program name.\n- Metric **values** flow through the existing `/v2/data_export_app/flat` endpoint —\n no separate fetch is required.\n",tags:["Data Export App"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID to fetch metric definitions for"}],responses:{"200":{description:"Successful response with definitions(or empty array if none exist)",schema:"MetricsDefinitionsList"},"400":{description:"Bad request - company_id is required"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Forbidden - user has no access to wells in this company"},"404":{description:"Not found error",schema:"NotFoundError"},"503":{description:"Service unavailable - upstream MongoDB error"}}}],DatasetTypes:[{path:"/v2/dataset_types",method:"GET",summary:"List DatasetTypes",tags:["DatasetTypes"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/datset_types/{id}",method:"GET",summary:"Show DatasetType",tags:["DatasetTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DatasetType ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/datset_types/{id}",method:"PATCH",summary:"Update an DatasetType",tags:["DatasetTypes"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"DatasetType ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated DatasetType",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Datasets:[{path:"/v2/datasets/filtered_by_apps",method:"GET",summary:"List app_datasets for specific app ids with dependencies",tags:["Datasets"],parameters:[{name:"app_ids","in":"path",type:"array",required:true,description:"Array of app ids"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Documents:[{path:"/v2/documents",method:"GET",summary:"List documents",tags:["Documents"],parameters:[{name:"parent_slug","in":"query",type:"any",required:false,description:"Filter documents by parent_slug"},{name:"search","in":"query",type:"string",required:false,description:"Search document text"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents",method:"POST",summary:"Create a document",tags:["Documents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created document",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections",method:"GET",summary:"List sections of document",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections",method:"POST",summary:"Create a document section",tags:["Documents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Document Section",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"GET",summary:"Show Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"PATCH",summary:"Update Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Document Section",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{document_id}/document_sections/{id}",method:"DELETE",summary:"Delete a Document Section",tags:["Documents"],parameters:[{name:"document_id","in":"path",type:"integer",required:true,description:"Document ID"},{name:"id","in":"path",type:"integer",required:true,description:"Document Section ID"}],responses:{"200":{description:"Document Section deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"GET",summary:"Show Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"PATCH",summary:"Update a Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Document",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/documents/{id}",method:"DELETE",summary:"Delete a Document",tags:["Documents"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Document ID"}],responses:{"200":{description:"Document deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],EdrProviders:[{path:"/v2/edr_providers",method:"GET",summary:"Get a list of edr providers",tags:["EdrProviders"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by edr provider's name, username or link"},{name:"provider_type","in":"query",type:"string",required:false,description:"Filter by provider type"},{name:"last_connection_failed","in":"query",type:"boolean",required:false,description:"Search by edr provider's last connection try"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-id"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List of edr providers",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers",method:"POST",summary:"Create a edr provider",tags:["EdrProviders"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"GET",summary:"Get an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Edr provider",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"PATCH",summary:"Update an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Updated Edr provider",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}",method:"DELETE",summary:"Delete an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Edr provider deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/edr_providers/{id}/test_connection",method:"POST",summary:"Get an Edr provider",tags:["EdrProviders"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Edr Provider ID"}],responses:{"200":{description:"Successful response with task_id to poll from",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Event:[{path:"/v2/events/publish",method:"POST",summary:"Publish Events",tags:["Event","Audit"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Feed:[{path:"/v2/activities",method:"GET",summary:"List activities",tags:["Feed"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Segments could be nil, a comma-delimited list of strings, or an array"},{name:"type","in":"query",type:"any",required:false,description:"List of asset types"},{name:"rigs","in":"query",type:"any",required:false,description:"Ids of rigs to search for"},{name:"assets","in":"query",type:"any",required:false,description:"Ids of assets to search for"},{name:"users","in":"query",type:"any",required:false,description:"Ids of users to search for"},{name:"apps","in":"query",type:"any",required:false,description:"Ids of apps to search for"},{name:"is_recommendation","in":"query",type:"boolean",required:false,description:"Search geosteering_comments based on isRecommendation field"},{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"List activities",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities",method:"POST",summary:"Create an activity",tags:["Feed"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created activity",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"GET",summary:"Show activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"PATCH",summary:"Update an activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated activity",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/activities/{id}",method:"DELETE",summary:"Delete an activity",tags:["Feed"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Activity ID"}],responses:{"200":{description:"Activity deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Files:[{path:"/v1/file",method:"POST",summary:"Upload a file as form data",tags:["Files"],parameters:[{name:"file","in":"formData",type:"file",required:true,description:"A file to upload"},{name:"s3_key","in":"formData",type:"string",required:true,description:"AWS S3 file identifier"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Invalid file",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/file",method:"PUT",summary:"Update a file by S3 key",tags:["Files"],parameters:[{name:"file","in":"formData",type:"file",required:true,description:"A file to upload"},{name:"s3_key","in":"formData",type:"string",required:true,description:"AWS S3 file identifier"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Invalid file",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/file/delete",method:"DELETE",summary:"Deletes a file",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"}],responses:{"200":{description:"File deleted"}}},{path:"/v1/file/download",method:"GET",summary:"Downloads a file",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"200":{description:"Fetchs a file from S3 link and gets it downloded"}}},{path:"/v1/file/download_link",method:"GET",summary:"Returns a URL where the file can be downloaded",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"response_content_disposition","in":"query",type:"string",required:false,description:"Desired content disposition"},{name:"response_content_type","in":"query",type:"string",required:false,description:"Desired content type"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"200":{description:"Returns the download URL"}}},{path:"/v1/file/preview",method:"GET",summary:"Redirects user to the file via a generated download link",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"internal","in":"query",type:"string",required:false,description:"When 'true', generates signed URL using internal storage endpoint (for same-network access). Otherwise uses external storage."}],responses:{"302":{description:"Redirect to direct S3 link"}}},{path:"/v1/file/sign",method:"GET",summary:"Returns a signed URL",tags:["Files"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"asset_id","in":"query",type:"int64",required:false,description:"Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/files",method:"DELETE",summary:"Deletes a file",tags:["Files"],parameters:[{name:"id","in":"query",type:"string",required:false,description:"Folder or File _id"},{name:"file_name","in":"query",type:"string",required:true,description:"A file name"},{name:"segment","in":"query",type:"string",required:false,description:"Segment for collection"}],responses:{"200":{description:"File deleted",schema:"any"},"400":{description:"Failure response",schema:"any"},"404":{description:"Not found",schema:"any"}}},{path:"/v2/files/url",method:"GET",summary:"Get signed URL for a file",tags:["Files"],parameters:[{name:"id","in":"query",type:"string",required:false,description:"ID of the file"},{name:"file_name","in":"query",type:"string",required:false,description:"Name of the file"}],responses:{"200":{description:"File url",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found",schema:"any"}}}],FracFleetContracts:[{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts",method:"GET",summary:"List Company Goals if no filters applied",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"}],responses:{"200":{description:"List of Frac Fleet Contracts",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts",method:"POST",summary:"Create Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"GET",summary:"List Company Goals if no filters applied",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],responses:{"200":{description:"Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"PATCH",summary:"Update Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/frac_fleets/{frac_fleet_id}/frac_fleet_contracts/{id}",method:"DELETE",summary:"Delete Frac Fleet Contract",tags:["FracFleetContracts"],parameters:[{name:"frac_fleet_id","in":"path",type:"integer",required:false,description:"Frac Fleet ID"},{name:"id","in":"path",type:"integer",required:false,description:"Frac Fleet Contract ID"}],responses:{"200":{description:"Deleted Frac Fleet Contract",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Goals:[{path:"/v2/goals",method:"GET",summary:"List Company Goals if no filters applied",tags:["Goals"],parameters:[{name:"owner_id","in":"query",type:"integer",required:false,description:"Filter by owner ID"},{name:"owner_type","in":"query",type:"string",required:false,description:"Filter owner type"},{name:"goal_type","in":"query",type:"string",required:false,description:"Filter by goal type"},{name:"name","in":"query",type:"string",required:false,description:"Filter by name. Available only when goal_type is casing or well_section"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"include_wells","in":"query",type:"boolean",required:false,description:"Filter goals by Well owner_type. Include well association in response"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals",method:"POST",summary:"Create a Goal",tags:["Goals"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals/{id}",method:"PATCH",summary:"Update a Goal",tags:["Goals"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Goal ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/goals/{id}",method:"DELETE",summary:"Delete a Goal",tags:["Goals"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Goal ID"}],responses:{"200":{description:"Deleted Goal",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],InterventionUnitEvents:[{path:"/v2/intervention_unit_events",method:"GET",summary:"Get a list of Intervention Units Events by well",tags:["InterventionUnitEvents"],parameters:[{name:"operation","in":"query",type:"string",required:false,description:"Filter by operation"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention unit events per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: operation,created_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_unit_events/{id}",method:"PATCH",summary:"Update Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Event ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_unit_events/{id}",method:"DELETE",summary:"Delete Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Event ID"}],responses:{"200":{description:"Deleted Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/intervention_unit_events",method:"POST",summary:"Create an Intervention Unit Event",tags:["InterventionUnitEvents"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Intervention Unit Event",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],InterventionUnitReruns:[{path:"/v2/intervention_unit_reruns",method:"GET",summary:"Get a list of Intervention Unit Reruns",tags:["InterventionUnitReruns"],parameters:[{name:"intervention_unit_id","in":"query",type:"integer",required:false,description:"Filter by intervention_unit_id"},{name:"intervention_unit_event_id","in":"query",type:"integer",required:false,description:"Filter by intervention_unit_event_id"},{name:"app_stream_id","in":"query",type:"integer",required:false,description:"Filter by app_stream_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention unit reruns per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: created_at,intervention_unit"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"List of Intervention Unit Reruns",schema:"any"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}},{path:"/v2/intervention_unit_reruns",method:"POST",summary:"Create an Intervention Unit Rerun",tags:["InterventionUnitReruns"],parameters:[],requestBody:{contentType:"application/json",schema:"CreateInterventionUnitRerunPayload",required:true},responses:{"200":{description:"Created Intervention Unit Rerun",schema:"InterventionUnitRerun"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"},"422":{description:"Unprocessable Entity",schema:"any"}}},{path:"/v2/intervention_unit_reruns/{id}",method:"GET",summary:"Get Intervention Unit Rerun by ID",tags:["InterventionUnitReruns"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention Unit Rerun ID"}],responses:{"200":{description:"Intervention Unit Rerun",schema:"InterventionUnitRerun"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"}}}],InterventionUnits:[{path:"/v2/intervention_units",method:"GET",summary:"Get a list of Intervention Units",tags:["InterventionUnits"],parameters:[{name:"company","in":"query",type:"integer",required:false,description:"Search by Company ID"},{name:"program","in":"query",type:"integer",required:false,description:"Search by Program ID"},{name:"search","in":"query",type:"string",required:false,description:"Search by intervention name"},{name:"intervention_type","in":"query",type:"string",required:false,description:"Filter by intervention type"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of intervention units per page"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: company,name"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units",method:"POST",summary:"Create an Intervention Unit",tags:["InterventionUnits"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units/{id}",method:"PATCH",summary:"Update Intervention Unit",tags:["InterventionUnits"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/intervention_units/{id}",method:"DELETE",summary:"Delete Intervention Unit",tags:["InterventionUnits"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Intervention ID"}],responses:{"200":{description:"Deleted Intervention Unit",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],MessageProducer:[{path:"/message_producer",method:"POST",summary:"Produce messages for sent data",tags:["MessageProducer"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],NotificationPolicies:[{path:"/v2/notification_policies",method:"GET",summary:"List Notification Policies",tags:["NotificationPolicies"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of notification policies accessible to the current user",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/notification_policies",method:"POST",summary:"Create Notification Policy",tags:["NotificationPolicies"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created notification policy",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"A scope row references a record the user cannot read"},"404":{description:"A scope row references a record that does not exist"}}},{path:"/v2/notification_policies/{id}",method:"GET",summary:"Get Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Notification policy details",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/notification_policies/{id}",method:"PATCH",summary:"Update Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated notification policy",schema:"any"},"400":{description:"Validation error"},"401":{description:"Authentication error",schema:"any"},"403":{description:"A scope row references a record the user cannot read"},"404":{description:"A scope row references a record that does not exist"}}},{path:"/v2/notification_policies/{id}",method:"DELETE",summary:"Delete Notification Policy",tags:["NotificationPolicies"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Notifications:[{path:"/v1/notifications",method:"GET",summary:"List notifications for current user",tags:["Notifications"],parameters:[{name:"start","in":"query",type:"integer",required:false,description:"Search by start time as a Unix timestamp"},{name:"end","in":"query",type:"integer",required:false,description:"Search by end time as a Unix timestamp"},{name:"trigger_type","in":"query",type:"array",required:false,description:"Filter by one or more trigger types"},{name:"notification_type","in":"query",type:"array",required:false,description:"Filter by one or more notification types: banner, desktop, sms, mobile, and email"},{name:"level","in":"query",type:"array",required:false,description:"Filter by one or more notification levels: info, warning, and critical"},{name:"acknowledged","in":"query",type:"boolean",required:false,description:"Filter by whether the notification has been acknowledged"},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}",method:"GET",summary:"Show notification",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}",method:"PATCH",summary:"Update notification",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/{id}/acknowledge",method:"POST",summary:"List notifications for current user",tags:["Notifications"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Notification ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/acknowledge",method:"POST",summary:"Acknowledge multiple notifications",tags:["Notifications"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/acknowledge_all",method:"POST",summary:"Acknowledge all notifications for current user",tags:["Notifications"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/notifications/count/unread",method:"GET",summary:"Get the unread notification count for the current user",tags:["Notifications"],parameters:[{name:"trigger_type","in":"query",type:"array",required:false,description:"Filter by trigger type"}],responses:{"200":{description:"Unread notifications count",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PackageReviews:[{path:"/v2/package_reviews",method:"GET",summary:"List PackageReviews",tags:["PackageReviews"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"query","in":"query",type:"string",required:false,description:"Search by App name"},{name:"status","in":"query",type:"string",required:false,description:"Filter by PackageReview status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews",method:"POST",summary:"Create a PackageReview",tags:["PackageReviews"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created PackageReview",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"GET",summary:"Show PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"PATCH",summary:"Update a PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated PackageReview",schema:"any"},"400":{description:"Package Review not updated",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/package_reviews/{id}",method:"DELETE",summary:"Cancel a PackageReview",tags:["PackageReviews"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"PackageReview ID"}],responses:{"200":{description:"Package Review deleted",schema:"any"},"400":{description:"Package Review not deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PadFracFleets:[{path:"/v2/pad_frac_fleets",method:"GET",summary:"List Pad/Frac Fleet Relations",tags:["PadFracFleets"],parameters:[{name:"frac_fleet_id","in":"query",type:"integer",required:false,description:"Filter by frac_fleet_id"},{name:"pad_id","in":"query",type:"integer",required:false,description:"Filter by pad_id"},{name:"order","in":"query",type:"string",required:false,description:"Order pad frac fleets by 'asc' or 'desc'"},{name:"sort","in":"query",type:"string",required:false,description:"Available sort values - created_at, last_current_at"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"List of Pad/Frac Fleet Relations",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets",method:"POST",summary:"Create Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Pad/Frac Fleet Relation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets/{id}",method:"PATCH",summary:"Patch Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad/Frac Fleet ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Pad/Frac Fleet Relation",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/pad_frac_fleets/{id}",method:"DELETE",summary:"Delete Pad/Frac Fleet Relation",tags:["PadFracFleets"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Pad/Frac Fleet ID"}],responses:{"200":{description:"Pad/Frac Fleet Relation deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PartialWellRerunAppProgresses:[{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}",method:"GET",summary:"Show Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],responses:{"200":{description:"Partial Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}",method:"PATCH",summary:"Update Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{partial_rerun_id}/app_progresses/{id}/restart",method:"PATCH",summary:"Restart Partial Rerun App Progress",tags:["PartialWellRerunAppProgresses"],parameters:[{name:"partial_rerun_id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"id","in":"path",type:"integer",required:true,description:"App Progress ID"}],responses:{"200":{description:"Restarted Well Rerun App Progress",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PartialWellReruns:[{path:"/v2/partial_reruns",method:"GET",summary:"List Partial Well Reruns",tags:["PartialWellReruns"],parameters:[{name:"status","in":"query",type:"any",required:false,description:"Filter by multiple statuses"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company_id"},{name:"rig_id","in":"query",type:"integer",required:false,description:"Filter by rig_id"},{name:"start_timestamp","in":"query",type:"integer",required:false,description:"Filter runs that started later than start_timestamp. start_timestamp is in seconds"},{name:"user_email","in":"query",type:"string",required:false,description:"Filter by user email. Can filter by parts of email"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by source's and target's well id"},{name:"start","in":"query",type:"integer",required:false,description:"Unix timestamp in seconds that filters reruns by created date and are created later than param specified"},{name:"end","in":"query",type:"integer",required:false,description:"Unix timestamp in seconds that filters reruns by created date and are created before than param specified"},{name:"mergeable","in":"query",type:"boolean",required:false,description:"Filter by mergeable status"},{name:"order","in":"query",type:"string",required:false,description:"Order partial well reruns by 'asc' or 'desc'"},{name:"sort","in":"query",type:"string",required:false,description:"Available sort values - id, company, rig, source_well_name, target_well_name, start_timestamp, status, created_at"}],responses:{"200":{description:"List of Partial Well Reruns",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}",method:"GET",summary:"Show Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}",method:"PATCH",summary:"Update Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/app_progress/{app_id}",method:"GET",summary:"Show Partial Well Rerun App Progress",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],responses:{"200":{description:"Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/app_progress/{app_id}",method:"PATCH",summary:"Update Partial Well Rerun App Progress",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"},{name:"app_id","in":"path",type:"integer",required:true,description:"App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/cancel",method:"PATCH",summary:"Change rerun status to canceled",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/fail",method:"PATCH",summary:"Change rerun status to failed",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/restart",method:"PATCH",summary:"Restart partial rerun, which will change its status to running",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/resume",method:"PATCH",summary:"Change rerun status to synchronizing_streams",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/start_merging",method:"PATCH",summary:"Start rerun merging",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/{id}/stop",method:"PATCH",summary:"Change rerun status to stop",tags:["PartialWellReruns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Partial Well Rerun ID"}],responses:{"200":{description:"Updated Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/partial_reruns/list",method:"POST",summary:"List Partial Well Reruns",tags:["PartialWellReruns"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"List of Partial Well Reruns",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/partial_reruns",method:"POST",summary:"Create Partial Well Rerun",tags:["PartialWellReruns"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Partial Well Rerun",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"412":{description:"Well is missing drilling#time stream",schema:"any"}}}],Picklists:[{path:"/v2/picklists",method:"GET",summary:"List picklists",tags:["Picklists"],parameters:[],responses:{"200":{description:"List all picklists visible by the current role",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists",method:"POST",summary:"Create a picklist",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}",method:"GET",summary:"Show a single picklist",tags:["Picklists"],parameters:[{name:"name","in":"path",type:"string",required:false,description:"Picklist name identifier"}],responses:{"200":{description:"Show the picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}",method:"PATCH",summary:"Update picklist",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated picklist",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}/items",method:"POST",summary:"Create a picklist item",tags:["Picklists"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created picklist item",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/picklists/{name}/items/{id}",method:"DELETE",summary:"Delete a picklist item",tags:["Picklists"],parameters:[{name:"id","in":"path",type:"integer",required:false,description:"Picklist ID"}],responses:{"200":{description:"Item deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PlatformSubscriptions:[{path:"/v2/platform_subscriptions",method:"GET",summary:"List Platform Subscriptions",tags:["PlatformSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Platform Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Platform Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions",method:"POST",summary:"Create a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Platform Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/approve",method:"POST",summary:"Approve a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Platform Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/deny",method:"POST",summary:"Deny a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Platform Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{id}/resume",method:"POST",summary:"Resume a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"GET",summary:"Show Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"PATCH",summary:"Update a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Platform Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Platform Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/platform_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Platform Subscription",tags:["PlatformSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Platform Subscription UUID"}],responses:{"200":{description:"Platform Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],ProductSubscriptions:[{path:"/v2/product_subscriptions",method:"GET",summary:"List Product Subscriptions",tags:["ProductSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Product Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Product Subscriptions by subscription name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions",method:"POST",summary:"Create a Product Subscription",tags:["ProductSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Product Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{id}/approve",method:"POST",summary:"Approve a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Product Subscription ID"}],responses:{"200":{description:"Product Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{id}/deny",method:"POST",summary:"Deny a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Product Subscription ID"}],responses:{"200":{description:"Product Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"GET",summary:"Show Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"PATCH",summary:"Update a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Product Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Product Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/product_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Product Subscription",tags:["ProductSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Product Subscription UUID"}],responses:{"200":{description:"Product Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],ProjectFiles:[{path:"/v2/project_folders/{project_folder_id}/project_files",method:"GET",summary:"List ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files",method:"POST",summary:"Create a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created ProjectFile",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"GET",summary:"Show ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"PATCH",summary:"Update a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated ProjectFile",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/project_folders/{project_folder_id}/project_files/{id}",method:"DELETE",summary:"Delete a ProjectFile",tags:["ProjectFiles"],parameters:[{name:"project_folder_id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFile ID"}],responses:{"200":{description:"ProjectFile deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],ProjectFolders:[{path:"/v2/projects/{project_id}/project_folders",method:"GET",summary:"List ProjectFolders",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders",method:"POST",summary:"Create a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created ProjectFolder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"GET",summary:"Show ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"PATCH",summary:"Update a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated ProjectFolder",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{project_id}/project_folders/{id}",method:"DELETE",summary:"Delete a ProjectFolder",tags:["ProjectFolders"],parameters:[{name:"project_id","in":"path",type:"integer",required:true,description:"Project ID"},{name:"id","in":"path",type:"integer",required:true,description:"ProjectFolder ID"}],responses:{"200":{description:"ProjectFolder deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Projects:[{path:"/v2/projects",method:"GET",summary:"List Projects",tags:["Projects"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects",method:"POST",summary:"Create a Project",tags:["Projects"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"GET",summary:"Show Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"POST",summary:"Clone a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Cloned Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"PATCH",summary:"Update a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Project",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/projects/{id}",method:"DELETE",summary:"Delete a Project",tags:["Projects"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Project ID"}],responses:{"200":{description:"Project deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],ProvisioningSubscriptions:[{path:"/v2/provisioning_subscriptions",method:"GET",summary:"List Provisioning Subscriptions",tags:["ProvisioningSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Provisioning Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Provisioning Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions",method:"POST",summary:"Create a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Provisioning Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/app_streams",method:"GET",summary:"Show AppStream info for a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Provisioning response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/approve",method:"POST",summary:"Approve a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Provisioning Subscription ID"}],responses:{"200":{description:"Provisioning Subscription approved"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/deny",method:"POST",summary:"Deny a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Provisioning Subscription ID"}],responses:{"200":{description:"Provisioning Subscription denied"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{id}/resume",method:"POST",summary:"Resume a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Platform Subscription ID"}],responses:{"200":{description:"Provisioning response",schema:"any"},"400":{description:"Error on resuming",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"GET",summary:"Show Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"PATCH",summary:"Update a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Provisioning Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}",method:"DELETE",summary:"Delete a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Provisioning Subscription deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/provisioning_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Provisioning Subscription",tags:["ProvisioningSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Provisioning Subscription UUID"}],responses:{"200":{description:"Provisioning Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],PurchaseSubscriptions:[{path:"/v2/purchase_subscriptions",method:"GET",summary:"List Purchase Subscriptions",tags:["PurchaseSubscriptions"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by status"},{name:"company_id","in":"query",type:"integer",required:false,description:"Filter Purchase Subscriptions by company_id"},{name:"asset_name","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by asset name"},{name:"name","in":"query",type:"string",required:false,description:"Filter Purchase Subscriptions by subscription name or apps name"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}",method:"GET",summary:"Show Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}",method:"PATCH",summary:"Update a Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Purchase Subscription",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/purchase_subscriptions/{uuid}/cancel",method:"POST",summary:"Cancel a Purchase Subscription",tags:["PurchaseSubscriptions"],parameters:[{name:"uuid","in":"path",type:"string",required:true,description:"Purchase Subscription UUID"}],responses:{"200":{description:"Purchase Subscription's status after cancellation"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],RegisteredModels:[{path:"/v2/integration/registered_models",method:"GET",summary:"Show list of Registered Models",tags:["RegisteredModels"],parameters:[{name:"filter","in":"query",type:"string",required:false,description:"Filter by model name"},{name:"uuid","in":"query",type:"string",required:false,description:"Filter by model name"},{name:"alias","in":"query",type:"string",required:false,description:"Filter by model alias (e.g., \"qa\" or \"prod\")"},{name:"company_id","in":"query",type:"string",required:false,description:"Filter by company ID"},{name:"asset_id","in":"query",type:"string",required:false,description:"Filter by asset ID"},{name:"basin","in":"query",type:"string",required:false,description:"Filter by basin name"},{name:"max_results","in":"query",type:"integer",required:false,description:"Limit number of items, Default is 100. Max threshold is 1000."},{name:"order_by","in":"query",type:"array",required:false,description:"List of columns for ordering search results"},{name:"page_token","in":"query",type:"string",required:false,description:"Next page token"},{name:"force","in":"query",type:"boolean",required:false,description:"Use to force request MLFlow API instead of cache"}],responses:{"200":{description:"List of Registered Models",schema:"{ data: any[] }"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],RevoltChat:[{path:"/v2/integration/revolt_chat_sessions",method:"POST",summary:"Create or fetch Revolt Chat session",tags:["RevoltChat"],parameters:[{name:"well_id","in":"query",type:"integer",required:false,description:"Well ID"},{name:"pad_id","in":"query",type:"integer",required:false,description:"Pad ID"}],responses:{"200":{description:"Returns session token and channel info",schema:"{ revolt_session_token: string, revolt_user_id: string, revolt_company_server_id: string, revolt_user_joined_server_id: string, revolt_channel_id: string }"},"401":{description:"Authentication error",schema:"AuthenticationError"},"403":{description:"Authorization error",schema:"AuthorizationError"},"404":{description:"Not found error",schema:"NotFoundError"},"502":{description:"Revolt API error",schema:"{ code: number, message: string }"}}}],SearchSuggestions:[{path:"/v2/search_suggestions",method:"GET",summary:"Search suggestions for App, Workflow and Article",tags:["SearchSuggestions"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search keyword to filter results"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Security:[{path:"/v2/companies/{company_id}/security_policies",method:"GET",summary:"List Company Security Policies",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies",method:"POST",summary:"Create a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Company Security Policy",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"GET",summary:"Show Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"PATCH",summary:"Update a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Company Security Policy",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/companies/{company_id}/security_policies/{id}",method:"DELETE",summary:"Delete a Company Security Policy",tags:["Security"],parameters:[{name:"company_id","in":"path",type:"integer",required:true,description:"Company ID"},{name:"id","in":"path",type:"integer",required:true,description:"Company Security Policy ID"}],responses:{"200":{description:"Company Security Policy deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups",method:"GET",summary:"List Groups",tags:["Security"],parameters:[{name:"users_search","in":"query",type:"string",required:false,description:"Search by users"},{name:"search","in":"query",type:"string",required:false,description:"Search by Group"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups",method:"POST",summary:"Create a Group",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/assign_users",method:"POST",summary:"Assign users to group",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"array",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions",method:"GET",summary:"List Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions",method:"POST",summary:"Create a Permission",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"GET",summary:"Show Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"PATCH",summary:"Update a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/{id}",method:"DELETE",summary:"Delete a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Permission deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/bulk_create",method:"POST",summary:"Create Multiple Permissions with list of abilities",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/bulk_destroy",method:"DELETE",summary:"Delete Multiple Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"ids","in":"query",type:"any",required:true,description:"List of permission IDs to delete"}],responses:{"200":{description:"Permissions deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{group_id}/permissions/grouped",method:"GET",summary:"List Grouped Permissions",tags:["Security"],parameters:[{name:"group_id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"GET",summary:"Show Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"users_search","in":"query",type:"string",required:false,description:"Search by users inside a Group"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"PATCH",summary:"Update a Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}",method:"DELETE",summary:"Delete a Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Group deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{id}/users",method:"GET",summary:"Show Users for a given Group",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Current page of items"},{name:"sort","in":"query",type:"string",required:false,description:"A field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"search","in":"query",type:"string",required:false,description:"Search by first_name, last_name, email"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/{user_id}/permissions/bulk_destroy",method:"DELETE",summary:"Delete Multiple Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"ids","in":"query",type:"any",required:true,description:"List of permission IDs to delete"}],responses:{"200":{description:"Permissions deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/groups/copy_users",method:"POST",summary:"Copy users from one group to another",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Updated Group",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/security_policies",method:"GET",summary:"List Security Policies",tags:["Security"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/security_policies/{id}",method:"GET",summary:"Show Security Policy",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Security Policy ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups",method:"GET",summary:"List Groups for User",tags:["Security"],parameters:[],responses:{"200":{description:"Current Groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups",method:"POST",summary:"Add Group to User",tags:["Security"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Current Groups",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/groups/{id}",method:"DELETE",summary:"Remove a Group from User",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Group ID"}],responses:{"200":{description:"Group Removed"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions",method:"GET",summary:"List Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions",method:"POST",summary:"Create a Permission",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"GET",summary:"Show Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"PATCH",summary:"Update a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Permission",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/{id}",method:"DELETE",summary:"Delete a Permission",tags:["Security"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Permission ID"},{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Permission deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/bulk_create",method:"POST",summary:"Create Multiple Permissions with list of abilities",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/permissions/grouped",method:"GET",summary:"List Grouped Permissions",tags:["Security"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"category","in":"query",type:"string",required:false,description:"Filter permissions by category"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],SignedUrl:[{path:"/v2/signed_url",method:"GET",summary:"Get signed_url from S3",tags:["SignedUrl"],parameters:[{name:"file_name","in":"query",type:"string",required:true,description:"file_name of attachment"},{name:"folder","in":"query",type:"string",required:true,description:"Folder for files"}],responses:{"200":{description:"Successful response",schema:"any"},"400":{description:"Failure response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Forbidden",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],SubscriptionFeatures:[{path:"/v2/subscription_features",method:"GET",summary:"List Subscription Features",tags:["SubscriptionFeatures"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/subscription_features/{id}",method:"GET",summary:"Show Subscription Feature",tags:["SubscriptionFeatures"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Subscription Feature ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Tasks:[{path:"/v2/tasks",method:"GET",summary:"List tasks for asset and application",tags:["Tasks"],parameters:[{name:"asset_id","in":"query",type:"integer",required:true,description:"Asset ID"},{name:"app_key","in":"query",type:"string",required:true,description:"App Key for the background app to execute"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"A field to sort by"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"},{name:"state","in":"query",type:"string",required:false,description:"Filter by task's state"},{name:"output_type","in":"query",type:"boolean",required:false,description:"Filter by outputType property presence"},{name:"include_performer","in":"query",type:"string",required:false,description:"Include performer User in response"}],responses:{"200":{description:"List all queried tasks",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks",method:"POST",summary:"Create a new task",tags:["Tasks"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Show the created task",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}",method:"GET",summary:"Show Task",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}",method:"PATCH",summary:"Update payload of a task. This endpoint can be used with an api key on a running task",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tasks/{id}/{status}",method:"PUT",summary:"Update task status",tags:["Tasks"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Task ID"},{name:"status","in":"query",type:"string",required:true,description:"Status"}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Show the task",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Tiers:[{path:"/v2/tiers",method:"GET",summary:"List Tiers",tags:["Tiers"],parameters:[{name:"segment","in":"query",type:"string",required:false,description:"Filter by segment"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers",method:"POST",summary:"Create a Tier",tags:["Tiers"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Tier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"GET",summary:"Show Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"PATCH",summary:"Update a Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Tier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tiers/{id}",method:"DELETE",summary:"Delete a Tier",tags:["Tiers"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Tier ID"}],responses:{"200":{description:"Tier deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],"Tool Ordering":[{path:"/v2/tool_ordering/orders",method:"GET",summary:"List Tool Orders",tags:["Tool Ordering"],parameters:[{name:"status","in":"query",type:"string",required:false,description:"Filter by exact status"},{name:"active","in":"query",type:"string",required:false,description:"'true' excludes received_on_rig/cancelled/rejected orders; 'false' returns only those"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"List of tool orders for the current company, newest first",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/orders",method:"POST",summary:"Create Tool Order",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created draft order",schema:"any"},"400":{description:"Validation error: invalid asset/vendor, missing components, or bad quantity"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/orders/{id}",method:"GET",summary:"Get Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Tool order details, including components",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Tool order not found"}}},{path:"/v2/tool_ordering/orders/{id}",method:"PATCH",summary:"Update Draft Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated order",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is no longer a draft"}}},{path:"/v2/tool_ordering/orders/{id}",method:"DELETE",summary:"Delete Draft Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is no longer a draft"}}},{path:"/v2/tool_ordering/orders/{id}/acknowledge",method:"POST",summary:"Acknowledge Tool Order (vendor action)",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Order acknowledged; idempotent if already acknowledged",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order not found, draft, or not visible to this vendor"},"409":{description:"Order is not awaiting acknowledgement"}}},{path:"/v2/tool_ordering/orders/{id}/cancel",method:"POST",summary:"Cancel Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Order and its cancellable components cancelled; allowed for the vendor (same-customer active membership) or an internal user with update access",schema:"any"},"400":{description:"reason is missing, not a string, or too long"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized (neither vendor access nor internal update access)"},"404":{description:"Order not found or not visible"},"409":{description:"Order has not been submitted, is already terminal, or a component has shipped"}}},{path:"/v2/tool_ordering/orders/{id}/submit",method:"POST",summary:"Submit Tool Order",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:false},responses:{"200":{description:"Order moved to awaiting_acknowledgement; every component submitted",schema:"any"},"400":{description:"Validation error: inactive vendor, vendor with no eligible notification recipient, an unselectable recipient_user_id, invalid specs, or a tool family over its max quantity"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"},"409":{description:"Order is not a draft"}}},{path:"/v2/tool_ordering/orders/{order_id}/components/{id}/final_specs",method:"PATCH",summary:"Update Order Component Final Specs (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Component final specs and/or serial number updated",schema:"any"},"400":{description:"final_specs is not an object, or the payload is too large"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is read only, or the component is not active"}}},{path:"/v2/tool_ordering/orders/{order_id}/components/{id}/transition",method:"POST",summary:"Transition Order Component Status (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Component transitioned; order status re-derived",schema:"any"},"400":{description:"Unsupported target status, or the transition is not legal from the current status"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is not acknowledged, or is no longer active"}}},{path:"/v2/tool_ordering/orders/{order_id}/proposals",method:"POST",summary:"Submit Component Change Proposal (vendor action)",tags:["Tool Ordering"],parameters:[{name:"order_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created pending proposal",schema:"any"},"400":{description:"proposed_changes is missing/not an object/too large, or reason is invalid"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Vendor access required (code 'not_authorized')"},"404":{description:"Order or component not found or not visible to this vendor"},"409":{description:"Order is terminal, or the component is not active"}}},{path:"/v2/tool_ordering/specifications",method:"GET",summary:"Get Tool Specification Definition",tags:["Tool Ordering"],parameters:[{name:"tool_family","in":"query",type:"string",required:true,description:"Tool family key, e.g. mud_motor; unknown families fall back to the generic definition"}],responses:{"200":{description:"Specification field definitions for the given tool family",schema:"any"},"400":{description:"tool_family query param is required"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendor_contacts",method:"POST",summary:"Add Vendor Contact",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created contact; vendor_name may have created a new vendor",schema:"any"},"400":{description:"Validation error: missing vendor_id/vendor_name, invalid email, or duplicate email on the vendor"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized on the resolved vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"vendor_id not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendor_contacts/{id}",method:"DELETE",summary:"Remove Vendor Contact",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized on the contact's vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Contact not found, or its vendor belongs to another company"}}},{path:"/v2/tool_ordering/vendor_directory",method:"GET",summary:"List Vendor Directory",tags:["Tool Ordering"],parameters:[],responses:{"200":{description:"Distinct-by-email people across the company vendors",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to read vendors, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors",method:"GET",summary:"List Vendors",tags:["Tool Ordering"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Page number"},{name:"per_page","in":"query",type:"integer",required:false,description:"Items per page"}],responses:{"200":{description:"Vendors for the current company, with contacts inlined",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors",method:"POST",summary:"Create Vendor",tags:["Tool Ordering"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created vendor",schema:"any"},"400":{description:"Validation error: blank or duplicate name"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to create vendors, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/tool_ordering/vendors/{id}",method:"PATCH",summary:"Update Vendor",tags:["Tool Ordering"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated vendor",schema:"any"},"400":{description:"Validation error: blank or duplicate name"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to update this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships",method:"GET",summary:"List Vendor Memberships",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""}],responses:{"200":{description:"Memberships for the vendor, with member user name/email inlined",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships",method:"POST",summary:"Add Vendor Membership",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"201":{description:"Created membership; the vendor_tool_order permission group is appended to the user's groups (additively, without touching other groups)",schema:"any"},"400":{description:"user_id is missing or belongs to another company (code 'validation_failed')"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor not found, or belongs to another company"}}},{path:"/v2/tool_ordering/vendors/{vendor_id}/memberships/{id}",method:"PATCH",summary:"Update Vendor Membership",tags:["Tool Ordering"],parameters:[{name:"vendor_id","in":"path",type:"integer",required:true,description:""},{name:"id","in":"path",type:"integer",required:true,description:""}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated membership; active: false revokes access immediately (deactivate, not delete)",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Not authorized to manage this vendor, or Tool Ordering is disabled for the current company (code 'feature_disabled')"},"404":{description:"Vendor or membership not found"}}}],TypeWells:[{path:"/v2/wells/{well_id}/type_wells",method:"GET",summary:"Get typewells from a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],responses:{"200":{description:"List of typewells",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/type_wells",method:"POST",summary:"Add new typewell well to a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"}],requestBody:{contentType:"application/json",schema:"integer",required:true},responses:{"200":{description:"Type well",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/wells/{well_id}/type_wells/{id}",method:"DELETE",summary:"Remove typewell well from a primary well",tags:["TypeWells"],parameters:[{name:"well_id","in":"path",type:"integer",required:true,description:"Well ID"},{name:"id","in":"path",type:"integer",required:true,description:"TypeWell ID"}],responses:{"200":{description:"TypeWell deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Usage:[{path:"/v2/usage",method:"GET",summary:"Returns Usage records",tags:["Usage"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Company ID."},{name:"billable","in":"query",type:"string",required:false,description:"Billable ID or identifier."},{name:"start_at","in":"query",type:"any",required:false,description:"Smallest start_at time of returned records. UNIX timestamp or string."},{name:"end_at","in":"query",type:"any",required:false,description:"Largest end_at time of returned records. UNIX timestamp or string."},{name:"segment","in":"query",type:"string",required:false,description:"Segment of the records to return."},{name:"totals_by","in":"query",type:"string",required:false,description:"Calculate totals grouped by selected value."}],responses:{"200":{description:"Successful response",schema:"any"}}},{path:"/v2/usage/summaries",method:"GET",summary:"Returns UsageSummary records",tags:["Usage"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Company ID."},{name:"billable","in":"query",type:"string",required:false,description:"Billable ID or identifier."},{name:"start_at","in":"query",type:"any",required:false,description:"Smallest start_at time of returned records. UNIX timestamp or string."},{name:"end_at","in":"query",type:"any",required:false,description:"Largest end_at time of returned records. UNIX timestamp or string."},{name:"segment","in":"query",type:"string",required:false,description:"Segment of the records to return."},{name:"totals_by","in":"query",type:"string",required:false,description:"Calculate totals grouped by selected value."}],responses:{"200":{description:"Successful response",schema:"any"}}}],Users:[{path:"/v1/.well-known/jwks.json",method:"GET",operationId:"getJwks",summary:"Get JWKS public keys",description:"Returns JSON Web Key Set (JWKS) containing public keys for verifying RS256-signed JWT tokens. This is a public endpoint that does not require authentication. External services can use these keys to verify tokens issued by this API. Returns an empty keys array if JWKS is not configured.",tags:["Users"],parameters:[],responses:{"200":{description:"JWKS public key set",schema:"any"}}},{path:"/v1/sessions/schemas",method:"GET",summary:"Get available authentication schemas",tags:["Users"],parameters:[{name:"email","in":"query",type:"string",required:false,description:"User email"},{name:"provider","in":"query",type:"string",required:false,description:"Provider name to filter by"},{name:"connection","in":"query",type:"string",required:false,description:"Connection name to filter by"},{name:"with_provider","in":"query",type:"boolean",required:false,description:"Include provider and respond with extended format or not. \"false\" by default."}],responses:{"200":{description:"List of available schemas",schema:"any[]"}}},{path:"/v1/sessions/verification/request",method:"POST",summary:"Request verification code",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"string",required:false},responses:{"200":{description:"Verification code requested",schema:"{ identity_verification: { required: boolean, enabled: boolean, available_modes: string[], enabled_modes: string[] }, triggered: boolean }"}}},{path:"/v1/user_token#1",method:"POST",summary:"Obtain user token via email + password authentication",description:"Authenticates user and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#2",method:"POST",summary:"Obtain user token via Auth0 SSO authentication",description:"Authenticates user via Auth0 and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#3",method:"POST",summary:"Obtain user token via email + password authentication with multi-factor authentication",description:"Authenticates user with MFA and returns JWT tokens. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v1/user_token#4",method:"POST",summary:"Refresh jwt token using refresh_token",description:"Refreshes JWT token using refresh_token. By default returns HMAC tokens (HS256). For JWKS tokens (RS256), include \"X-Token-Format: jwks\" header or add \"token_format: jwks\" to auth params.",tags:["Users"],parameters:[{name:"X-Token-Format","in":"header",type:"string",required:false,description:"Token format (optional): \"jwks\" or \"rsa\" for RSA-signed tokens"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"New JSON Web Token",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys",method:"GET",summary:"List accessible API keys",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys",method:"POST",summary:"Create an API key",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"GET",summary:"Show API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"PATCH",summary:"Update an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}",method:"DELETE",summary:"Delete an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"API key deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}/approve",method:"POST",summary:"Approve and activate an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Approved API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/{id}/deactivate",method:"POST",summary:"Deactivate an API key",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"API key ID"}],responses:{"200":{description:"Deactivated API key",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/api_keys/current",method:"GET",summary:"Show current API key",description:"Returns the API key used to authenticate the request",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users",method:"GET",summary:"List Users",tags:["Users"],parameters:[],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users",method:"POST",summary:"Create a User",tags:["Users"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"GET",summary:"Show User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"PATCH",summary:"Update a User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{id}",method:"DELETE",summary:"Delete a User",tags:["Users"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"User deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers",method:"GET",summary:"List Identity Verifiers for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers",method:"POST",summary:"Create Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"string",required:true},responses:{"200":{description:"Created Identity Verifier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"GET",summary:"Show Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"PATCH",summary:"Update Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],requestBody:{contentType:"application/json",schema:"object",required:false},responses:{"200":{description:"Updated Identity Verifier",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/users/{user_id}/identity_verifiers/{mode}",method:"DELETE",summary:"Delete Specific Identity Verifier for a User",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"mode","in":"path",type:"string",required:true,description:"Identity Verifier Mode"}],responses:{"200":{description:"Identity Verifier deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Identity Verifier not found"}}},{path:"/v2/users/{user_id}/settings",method:"GET",summary:"Get all settings for a user",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings",method:"POST",summary:"Add settings for a user",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated User",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings/{key}",method:"GET",summary:"Get a setting with a key",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"key","in":"path",type:"string",required:true,description:"Settings key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/settings/{key}",method:"DELETE",summary:"Delete a setting with a key",tags:["Users"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"key","in":"path",type:"string",required:true,description:"Settings key"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/export",method:"GET",summary:"Export users by company as csv",tags:["Users"],parameters:[{name:"company_id","in":"query",type:"integer",required:true,description:"Company ID"}],responses:{"200":{description:"Successful response",schema:"object"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/streaks",method:"GET",summary:"User Streaks list",tags:["Users"],parameters:[{name:"ids","in":"query",type:"string",required:false,description:"User IDs"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"string",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],"Well Plan Checklists":[{path:"/v2/well_plan_checklists",method:"GET",summary:"List well plan checklists",tags:["Well Plan Checklists"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plan_checklists/{id}",method:"GET",summary:"Show well plan checklist",tags:["Well Plan Checklists"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan Checklist ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],"Well Planning Dashboards":[{path:"/v2/well_planning_dashboards",method:"GET",summary:"List well planning dashboards",tags:["Well Planning Dashboards"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Filter by asset ID (well)"},{name:"type","in":"query",type:"string",required:false,description:"Filter by type: custom_well_planning_dashboard (default) or default_well_planning_dashboard"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards",method:"POST",summary:"Create a custom planning dashboard for a well",tags:["Well Planning Dashboards"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well planning dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"GET",summary:"Show well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"},{name:"asset_id","in":"query",type:"integer",required:false,description:"Asset ID used for dashboard timezone/unit overrides"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"PATCH",summary:"Update a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well planning dashboard",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{id_or_slug}",method:"DELETE",summary:"Delete a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"id_or_slug","in":"path",type:"string",required:true,description:"Dashboard ID or slug"}],responses:{"200":{description:"Well planning dashboard deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",method:"POST",summary:"Create a dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps",method:"PUT",summary:"Batch update dashboard apps on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"GET",summary:"Show dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"},{name:"filter_asset_id","in":"query",type:"integer",required:false,description:"Data filter's Asset ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"PATCH",summary:"Update dashboard app on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated dashboard app",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/{id}",method:"DELETE",summary:"Delete dashboard app from a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard App ID"}],responses:{"200":{description:"Dashboard app deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_planning_dashboards/{well_planning_dashboard_id_or_slug}/dashboard_apps/bulk_create",method:"POST",summary:"Bulk create dashboard apps on a well planning dashboard",tags:["Well Planning Dashboards"],parameters:[{name:"well_planning_dashboard_id_or_slug","in":"path",type:"string",required:true,description:"Well Planning Dashboard ID or slug"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created dashboard apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],"Well Plans":[{path:"/v2/well_plans",method:"GET",summary:"List well plans",tags:["Well Plans"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"kind","in":"query",type:"string",required:false,description:"Filter by well plan kind"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well ID"},{name:"status","in":"query",type:"string",required:false,description:"Filter by status"},{name:"search","in":"query",type:"string",required:false,description:"Case-insensitive search by well plan name"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans",method:"POST",summary:"Create a well plan",tags:["Well Plans"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created well plan",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"GET",summary:"Show well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"PATCH",summary:"Update well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated well plan",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/{id}",method:"DELETE",summary:"Delete well plan",tags:["Well Plans"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Plan ID"}],responses:{"200":{description:"Well plan deleted",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_plans/copy",method:"POST",summary:"Copy data from one well plan into another",tags:["Well Plans"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Well plan copy created and enqueued for processing",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],WellCache:[{path:"/v1/data/corva/well_cache",method:"GET",summary:"List WellCache Records",tags:["WellCache"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Search by Asset ID"},{name:"company_id","in":"query",type:"integer",required:false,description:"Search by Company ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],WellDrilloutUnitRuns:[{path:"/v2/well_drillout_unit_runs",method:"GET",summary:"List well drillout unit runs",tags:["WellDrilloutUnitRuns"],parameters:[{name:"company_id","in":"query",type:"integer",required:false,description:"Filter by company ID"},{name:"well_id","in":"query",type:"integer",required:false,description:"Filter by well ID"},{name:"drillout_unit_id","in":"query",type:"integer",required:false,description:"Filter by drillout unit ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well_drillout_unit_run.well_id"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of well drillout unit runs per page"},{name:"page","in":"query",type:"integer",required:false,description:"Page number"}],responses:{"200":{description:"List well drillout unit runs",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/well_drillout_unit_runs/{id}",method:"GET",summary:"Get a single well drillout unit run",tags:["WellDrilloutUnitRuns"],parameters:[{name:"id","in":"path",type:"integer",required:true,description:"Well Drillout Unit Run ID"},{name:"fields","in":"query",type:"any",required:false,description:"Respond with only the given list of fields, like well_drillout_unit_run.well_id"}],responses:{"200":{description:"Get well drillout unit run",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],WellView:[{path:"/v2/integration/wellview/bha",method:"GET",summary:"Retrieve Corva BHA/Drillstring data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the BHA dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac",method:"GET",summary:"Retrieve Corva Fracking data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Fracking dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_design",method:"GET",summary:"Retrieve Corva Frac Stage Design data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Design dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_summary",method:"GET",summary:"Retrieve Corva Frac Stage Summary data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Summary dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/frac_stage_summary_calculated",method:"GET",summary:"Retrieve Corva Frac Stage Summary Calculated data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Frac Stage Summary Calculated dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/ingest",method:"POST",summary:"Send data into Corva for processing",tags:["WellView"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Send the data for processing",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/job_settings",method:"GET",summary:"Retrieve Corva Job Settings data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Job Settings dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/plugs",method:"GET",summary:"Retrieve Corva Plugs data",tags:["WellView"],parameters:[{name:"asset_id","in":"query",type:"integer",required:false,description:"Corva Asset ID"},{name:"query","in":"query",type:"string",required:false,description:"Open-ended data query, such as {timestamp#gte#1577836800}. Be sure to URL encode."},{name:"sort","in":"query",type:"string",required:false,description:"Field to sort by, and the direction to sort in (asc is 1, desc is -1)"},{name:"limit","in":"query",type:"integer",required:false,description:"Number of records to retrieve"}],responses:{"200":{description:"List all data for the Plugs dataset",schema:"any[]"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/integration/wellview/resolve",method:"POST",summary:"Resolve an asset based on an array of lookups",tags:["WellView"],parameters:[],requestBody:{contentType:"application/json",schema:"array",required:false},responses:{"200":{description:"Show asset",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],WorkflowRoles:[{path:"/v2/workflow_roles",method:"GET",summary:"List WorkflowRoles",tags:["WorkflowRoles"],parameters:[{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}],Workflows:[{path:"/v2/{workflow_id}/workflow_apps",method:"GET",summary:"List Workflow Apps of a Workflow",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps",method:"PUT",summary:"Update many Workflow Apps",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow Apps",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps/{id}",method:"GET",summary:"Show Workflow App",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow App ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_apps/{id}",method:"PATCH",summary:"Update a Workflow App",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow App ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow App",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks",method:"GET",summary:"List Workflow Content Blocks of a workflow",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks",method:"POST",summary:"Create a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Workflow Content Block",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"GET",summary:"Show Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"PATCH",summary:"Update a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow Content Block",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/{workflow_id}/workflow_content_blocks/{id}",method:"DELETE",summary:"Delete a Workflow Content Block",tags:["Workflows"],parameters:[{name:"workflow_id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"},{name:"id","in":"path",type:"integer",required:true,description:"Workflow Content Block ID"}],responses:{"200":{description:"Workflow Content Block deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows",method:"GET",summary:"List Dashboard Workflows of a Dashboard",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}",method:"GET",summary:"Show Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}",method:"DELETE",summary:"Delete Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Dashboard Workflow deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/change_asset",method:"PUT",summary:"Change Asset of Dashboard Workflows and related Dashboard Apps",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/{id}/ungroup",method:"POST",summary:"Ungroup Dashboard Workflow",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"},{name:"id","in":"path",type:"integer",required:true,description:"Dashboard Workflow ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/users/{user_id}/dashboards/{dashboard_id}/dashboard_workflows/ungroup_all",method:"POST",summary:"Ungroup All Dashboard Workflows for Dashboard",tags:["Workflows"],parameters:[{name:"user_id","in":"path",type:"integer",required:true,description:"User ID"},{name:"dashboard_id","in":"path",type:"integer",required:true,description:"Dashboard ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows",method:"GET",summary:"List Workflows",tags:["Workflows"],parameters:[{name:"segment","in":"query",type:"any",required:false,description:"Workflow segment filter"},{name:"company_id","in":"query",type:"any",required:false,description:"Workflow company filter"},{name:"allow_empty_company","in":"query",type:"string",required:false,description:"While filter by company, allow to add Workflows without company in results"},{name:"visibility","in":"query",type:"string",required:false,description:"Filter by visibility"},{name:"search","in":"query",type:"string",required:false,description:"Search workflow by name/caption"},{name:"page","in":"query",type:"integer",required:false,description:"Number of page"},{name:"per_page","in":"query",type:"integer",required:false,description:"Number of items to list per page"},{name:"sort","in":"query",type:"array",required:false,description:"One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at"},{name:"order","in":"query",type:"string",required:false,description:"A sorting direction"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows",method:"POST",summary:"Create a Workflow",tags:["Workflows"],parameters:[],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Created Workflow",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"GET",summary:"Show workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Successful response",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"PATCH",summary:"Update a Workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],requestBody:{contentType:"application/json",schema:"any",required:true},responses:{"200":{description:"Updated Workflow",schema:"any"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}},{path:"/v2/workflows/{id}",method:"DELETE",summary:"Delete a Workflow",tags:["Workflows"],parameters:[{name:"id","in":"path",type:"string",required:true,description:"Workflow workflow_key or ID"}],responses:{"200":{description:"Workflow deleted"},"401":{description:"Authentication error",schema:"any"},"403":{description:"Authorization error",schema:"any"},"404":{description:"Not found error",schema:"any"}}}]},swaggerUrl:"https://api.corva.ai/documentation/swagger.json"},{name:"corvaDataAPI",modulePath:"clients",importPath:"@corva/ui/clients",description:"Data API client for Corva platform. Used for data-specific endpoints with automatic URL configuration. The shipped declarations type the methods loosely (get resolves to Promise<any>), and an app may carry its own local declaration overrides. Dataset collection reads return arrays of records wrapping the payload in their `data` field — type them with an app-local record DTO and a cast at the response boundary; see get_dataset_types_guide.",methods:[{name:"get",signature:"(path: string, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a GET request. Dataset collection reads resolve to an array of records — `_id`, `timestamp`, `asset_id`, `company_id`, `provider`, `collection`, `version`, optional `app_key`, and the payload under `data` — typed with an app-local record type and a cast at the response boundary; see get_dataset_types_guide. Non-collection endpoints (aggregations, custom routes) return that endpoint's own JSON shape."},{name:"put",signature:"<T>(path: string, content: T, queryParams?: object, requestOptions?: object) => Promise<T>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"content",type:"T",required:true,description:"Request body content"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<T>",description:"Perform a PUT request. Resolves to the updated content."},{name:"patch",signature:"(path: string, content: any, queryParams?: object, requestOptions?: object) => Promise<any>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"content",type:"any",required:true,description:"Request body content"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<any>",description:"Perform a PATCH request"},{name:"post",signature:"(path: string, entity: object[], requestOptions?: object) => Promise<{ failed_count: number; inserted_ids: string[]; messages: string[] }>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"entity",type:"object[]",required:true,description:"Records to insert: the full record envelope minus `_id`, payload under `data`. Type the literal with `satisfies` against your app-local record type (see get_dataset_types_guide)."},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<{ failed_count: number; inserted_ids: string[]; messages: string[] }>",description:"Perform a POST request. Resolves to an insert summary."},{name:"del",signature:"(path: string, queryParams?: object, requestOptions?: object) => Promise<{ deleted_count: number }>",parameters:[{name:"path",type:"string",required:true,description:"API endpoint path"},{name:"queryParams",type:"object",required:false,description:"Query parameters"},{name:"requestOptions",type:"object",required:false,description:"Additional request options"}],returnType:"Promise<{ deleted_count: number }>",description:"Perform a DELETE request. Resolves to a deletion summary."}],keywords:["api","data","http","request","fetch","rest","record","dataset","metrics","get","v1","by","provider","and","create","post","replace","put","delete","many","count","list","aggregate","pipeline","aggregate_summary","summary","return","source","collection","upsert","target","batch_update","batch","update","patch","batch_update_with_object","with","object","retrieve","id","datasets","index","company","name","check","perform","action","message_producer","produce","message","producer","app","key","subscriptions","publish","asset","legacy-data","legacy","without","show"],endpoints:[{path:"/metrics",method:"GET",operationId:"metrics_metrics_get",summary:"Metrics",description:"Endpoint that serves Prometheus metrics.",tags:[],parameters:[],responses:{"200":{description:"Successful Response",schema:"any"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"GET",operationId:"getDataByProviderAndDataset",summary:"Find Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"skip","in":"query",type:"number",required:false,description:"Number of records to skip (default: 0)"},{name:"limit","in":"query",type:"number",required:true,description:"Maximum number of results to return"},{name:"fields","in":"query",type:"string",required:false,description:"Comma separated list of fields to return"},{name:"include_count","in":"query",type:"boolean",required:false,description:"Include total count of matching documents in Total header"},{name:"sort","in":"query",type:"string",required:true,description:"Sort conditions as JSON string"},{name:"query","in":"query",type:"string",required:true,description:"Search conditions"}],responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"POST",operationId:"create_api_v1_data__provider___dataset___post",summary:"Insert new Documents",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: object | object, provider: object | object, collection: object | object, asset_id: object | object, version: number, ... }[] | { data: { company_id: object, provider: object, collection: object, asset_id: object, version: object, ... }[], producer: { app_connection_id: number } }",required:true},responses:{"200":{description:"Successful Response",schema:"{ inserted_ids: string[], failed_count: number, messages: string[] }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"PUT",operationId:"replace_api_v1_data__provider___dataset___put",summary:"Insert new Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"query",type:"string",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"DELETE",operationId:"delete_many_api_v1_data__provider___dataset___delete",summary:"Delete multiple Documents",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"query","in":"query",type:"string",required:true,description:"A query that matches the documents to delete"}],responses:{"200":{description:"Successful Response",schema:"{ deleted_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/count/",method:"GET",operationId:"count_api_v1_data__provider___dataset__count__get",summary:"Count Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"query","in":"query",type:"string",required:true,description:"Search conditions"}],responses:{"200":{description:"Successful Response",schema:"{ count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/list/",method:"POST",operationId:"listDataByProviderAndDataset",summary:"Find Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ query: object, sort: { sort: object }, skip: number, limit: number, fields: string, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/",method:"GET",operationId:"aggregate_api_v1_data__provider___dataset__aggregate__get",summary:"Find Data using MongoDB aggregation pipeline (simple)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"match","in":"query",type:"string",required:true,description:"Match stage"},{name:"group","in":"query",type:"string",required:false,description:"Group stage"},{name:"project","in":"query",type:"string",required:false,description:"Project stage"},{name:"skip","in":"query",type:"number",required:false,description:"Number of records to skip (default: 0)"},{name:"limit","in":"query",type:"number",required:true,description:"Maximum number of results to return"},{name:"sort","in":"query",type:"string",required:true,description:"Sort conditions as JSON string"}],responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/pipeline/",method:"GET",operationId:"aggregate_pipeline_get_api_v1_data__provider___dataset__aggregate_pipeline__get",summary:"Find Data using MongoDB aggregation pipeline (complex)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"stages","in":"query",type:"string",required:true,description:"List of aggregation stages."}],responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/pipeline/",method:"POST",operationId:"aggregate_pipeline_post_api_v1_data__provider___dataset__aggregate_pipeline__post",summary:"Find Data using MongoDB aggregation pipeline (complex)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ stages: object[] }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{source_collection}/aggregate_summary/",method:"POST",operationId:"aggregate_summary_return_api_v1_data__provider___source_collection__aggregate_summary__post",summary:"Aggregate summary data by intervals and return results",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"source_collection","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ match_field: string, operations: \"median\" | \"avg\" | \"min\" | \"max\"[], intervals: { start: number, end: number }[], asset_id: number, exclude_data_fields: string[], ... }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{source_collection}/aggregate_summary/{target_collection}/",method:"POST",operationId:"aggregate_summary_upsert_api_v1_data__provider___source_collection__aggregate_summary__target_collection___post",summary:"Aggregate summary data by intervals and upsert results into target collection",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"source_collection","in":"path",type:"string",required:true,description:""},{name:"target_collection","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ match_field: string, operations: \"median\" | \"avg\" | \"min\" | \"max\"[], intervals: { start: number, end: number }[], asset_id: number, exclude_data_fields: string[], ... }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/batch_update/",method:"PATCH",operationId:"batch_update_api_v1_data__provider___dataset__batch_update__patch",summary:"Batch Document Update",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number | null, ... }[]",required:false},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/batch_update_with_object/",method:"PATCH",operationId:"batch_update_with_object_api_v1_data__provider___dataset__batch_update_with_object__patch",summary:"Batch Document Update with single object value",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ data: { company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }, query: string, limit: number, batch: number, sort: { sort: object } }",required:true},responses:{"200":{description:"Successful Response",schema:"{ updated_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"GET",operationId:"retrieve_api_v1_data__provider___dataset___id___get",summary:"Load Record",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"PUT",operationId:"replace_api_v1_data__provider___dataset___id___put",summary:"Replace Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"PATCH",operationId:"update_api_v1_data__provider___dataset___id___patch",summary:"Update Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"DELETE",operationId:"delete_api_v1_data__provider___dataset___id___delete",summary:"Delete Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ deleted_docs: object[], failed_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/",method:"GET",operationId:"index_api_v1_dataset__get",summary:"Get All Datasets",tags:["datasets"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by dataset name"},{name:"plottable","in":"query",type:"boolean | null",required:false,description:"Filter by plottable datasets"},{name:"temporary","in":"query",type:"boolean | null",required:false,description:"Filter by temporary datasets"}],responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/company/",method:"GET",operationId:"by_company_api_v1_dataset_company__get",summary:"Get Datasets By Company",tags:["datasets"],parameters:[{name:"plottable","in":"query",type:"boolean | null",required:false,description:"Filter by plottable datasets"},{name:"type","in":"query",type:"\"time\" | \"depth\" | \"reference\" | \"timeseries\" | null",required:false,description:"Filter by dataset type: time, depth, reference"}],responses:{"200":{description:"Successful Response",schema:"object"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"GET",operationId:"fetch_api_v1_dataset__provider___name___get",summary:"Get Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"POST",operationId:"create_api_v1_dataset__provider___name___post",summary:"Create Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"PATCH",operationId:"update_api_v1_dataset__provider___name___patch",summary:"Update Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"DELETE",operationId:"delete_api_v1_dataset__provider___name___delete",summary:"Delete Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{index}/",method:"GET",operationId:"fetch_index_api_v1_dataset__provider___dataset__index__index___get",summary:"Get Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"index","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{index}/",method:"DELETE",operationId:"delete_index_api_v1_dataset__provider___dataset__index__index___delete",summary:"Delete Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"index","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/",method:"POST",operationId:"create_index_api_v1_dataset__provider___dataset__index__post",summary:"Create Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{name}/check/",method:"POST",operationId:"check_index_api_v1_dataset__provider___dataset__index__name__check__post",summary:"Check Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{name}/{action}/",method:"POST",operationId:"perform_index_action_api_v1_dataset__provider___dataset__index__name___action___post",summary:"Perform Index Action",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""},{name:"action","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/message_producer/{app_key}",method:"POST",operationId:"produce_api_v1_message_producer__app_key__post",summary:"Produce Messages (corva-api compatibility)",tags:["data"],parameters:[{name:"app_key","in":"path",type:"string | null",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/message_producer/",method:"POST",operationId:"produce_api_v1_message_producer__post",summary:"Produce Messages",tags:["data"],parameters:[{name:"app_key","in":"query",type:"string | null",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/subscriptions/{provider}/{dataset}/{asset_id}/",method:"POST",operationId:"publish_api_v1_subscriptions__provider___dataset___asset_id___post",summary:"Publish data to Corva Subscriptions Server.",description:"Publish data to **Corva Subscriptions Server** channel named `{provider}/{dataset}/{asset_id}`.",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"asset_id","in":"path",type:"number",required:true,description:""}],requestBody:{contentType:"application/json",schema:"object | object[]",required:true},responses:{"204":{description:"Successful Response"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/v1/message_producer/{app_key}",method:"POST",operationId:"produce_v1_message_producer__app_key__post",summary:"Produce Messages (corva-api compatibility)",tags:["data"],parameters:[{name:"app_key","in":"path",type:"string | null",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/v1/message_producer/",method:"POST",operationId:"produce_v1_message_producer__post",summary:"Produce Messages",tags:["data"],parameters:[{name:"app_key","in":"query",type:"string | null",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data",method:"GET",operationId:"index_without_provider_api_legacy_v1_data_get",summary:"Index Without Provider",tags:["legacy-data"],parameters:[],responses:{"200":{description:"Successful Response",schema:"any"}}},{path:"/api/legacy/v1/data/{provider}",method:"GET",operationId:"index_without_dataset_api_legacy_v1_data__provider__get",summary:"Index Without Dataset",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}",method:"GET",operationId:"index_api_legacy_v1_data__provider___dataset__get",summary:"Index",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"GET",operationId:"show_api_legacy_v1_data__provider___dataset___id__get",summary:"Show",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"PUT",operationId:"put_api_legacy_v1_data__provider___dataset___id__put",summary:"Put",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"PATCH",operationId:"patch_api_legacy_v1_data__provider___dataset___id__patch",summary:"Patch",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}}],endpointsByTag:{Other:[{path:"/metrics",method:"GET",operationId:"metrics_metrics_get",summary:"Metrics",description:"Endpoint that serves Prometheus metrics.",tags:[],parameters:[],responses:{"200":{description:"Successful Response",schema:"any"}}}],data:[{path:"/api/v1/data/{provider}/{dataset}/",method:"GET",operationId:"getDataByProviderAndDataset",summary:"Find Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"skip","in":"query",type:"number",required:false,description:"Number of records to skip (default: 0)"},{name:"limit","in":"query",type:"number",required:true,description:"Maximum number of results to return"},{name:"fields","in":"query",type:"string",required:false,description:"Comma separated list of fields to return"},{name:"include_count","in":"query",type:"boolean",required:false,description:"Include total count of matching documents in Total header"},{name:"sort","in":"query",type:"string",required:true,description:"Sort conditions as JSON string"},{name:"query","in":"query",type:"string",required:true,description:"Search conditions"}],responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"POST",operationId:"create_api_v1_data__provider___dataset___post",summary:"Insert new Documents",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: object | object, provider: object | object, collection: object | object, asset_id: object | object, version: number, ... }[] | { data: { company_id: object, provider: object, collection: object, asset_id: object, version: object, ... }[], producer: { app_connection_id: number } }",required:true},responses:{"200":{description:"Successful Response",schema:"{ inserted_ids: string[], failed_count: number, messages: string[] }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"PUT",operationId:"replace_api_v1_data__provider___dataset___put",summary:"Insert new Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"query",type:"string",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/",method:"DELETE",operationId:"delete_many_api_v1_data__provider___dataset___delete",summary:"Delete multiple Documents",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"query","in":"query",type:"string",required:true,description:"A query that matches the documents to delete"}],responses:{"200":{description:"Successful Response",schema:"{ deleted_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"GET",operationId:"retrieve_api_v1_data__provider___dataset___id___get",summary:"Load Record",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"PUT",operationId:"replace_api_v1_data__provider___dataset___id___put",summary:"Replace Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"PATCH",operationId:"update_api_v1_data__provider___dataset___id___patch",summary:"Update Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/{id}/",method:"DELETE",operationId:"delete_api_v1_data__provider___dataset___id___delete",summary:"Delete Document",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ deleted_docs: object[], failed_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/",method:"GET",operationId:"aggregate_api_v1_data__provider___dataset__aggregate__get",summary:"Find Data using MongoDB aggregation pipeline (simple)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"match","in":"query",type:"string",required:true,description:"Match stage"},{name:"group","in":"query",type:"string",required:false,description:"Group stage"},{name:"project","in":"query",type:"string",required:false,description:"Project stage"},{name:"skip","in":"query",type:"number",required:false,description:"Number of records to skip (default: 0)"},{name:"limit","in":"query",type:"number",required:true,description:"Maximum number of results to return"},{name:"sort","in":"query",type:"string",required:true,description:"Sort conditions as JSON string"}],responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/pipeline/",method:"GET",operationId:"aggregate_pipeline_get_api_v1_data__provider___dataset__aggregate_pipeline__get",summary:"Find Data using MongoDB aggregation pipeline (complex)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"stages","in":"query",type:"string",required:true,description:"List of aggregation stages."}],responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/aggregate/pipeline/",method:"POST",operationId:"aggregate_pipeline_post_api_v1_data__provider___dataset__aggregate_pipeline__post",summary:"Find Data using MongoDB aggregation pipeline (complex)",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ stages: object[] }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/batch_update_with_object/",method:"PATCH",operationId:"batch_update_with_object_api_v1_data__provider___dataset__batch_update_with_object__patch",summary:"Batch Document Update with single object value",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ data: { company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number, ... }, query: string, limit: number, batch: number, sort: { sort: object } }",required:true},responses:{"200":{description:"Successful Response",schema:"{ updated_count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/batch_update/",method:"PATCH",operationId:"batch_update_api_v1_data__provider___dataset__batch_update__patch",summary:"Batch Document Update",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string | null, collection: string | null, asset_id: number | null, version: number | null, ... }[]",required:false},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/count/",method:"GET",operationId:"count_api_v1_data__provider___dataset__count__get",summary:"Count Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"query","in":"query",type:"string",required:true,description:"Search conditions"}],responses:{"200":{description:"Successful Response",schema:"{ count: number }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{dataset}/list/",method:"POST",operationId:"listDataByProviderAndDataset",summary:"Find Data",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ query: object, sort: { sort: object }, skip: number, limit: number, fields: string, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ _id: string | null, company_id: number | null, asset_id: number | null, version: number, provider: string, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{source_collection}/aggregate_summary/",method:"POST",operationId:"aggregate_summary_return_api_v1_data__provider___source_collection__aggregate_summary__post",summary:"Aggregate summary data by intervals and return results",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"source_collection","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ match_field: string, operations: \"median\" | \"avg\" | \"min\" | \"max\"[], intervals: { start: number, end: number }[], asset_id: number, exclude_data_fields: string[], ... }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/data/{provider}/{source_collection}/aggregate_summary/{target_collection}/",method:"POST",operationId:"aggregate_summary_upsert_api_v1_data__provider___source_collection__aggregate_summary__target_collection___post",summary:"Aggregate summary data by intervals and upsert results into target collection",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"source_collection","in":"path",type:"string",required:true,description:""},{name:"target_collection","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ match_field: string, operations: \"median\" | \"avg\" | \"min\" | \"max\"[], intervals: { start: number, end: number }[], asset_id: number, exclude_data_fields: string[], ... }",required:true},responses:{"200":{description:"Successful Response",schema:"object[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/message_producer/",method:"POST",operationId:"produce_api_v1_message_producer__post",summary:"Produce Messages",tags:["data"],parameters:[{name:"app_key","in":"query",type:"string | null",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/message_producer/{app_key}",method:"POST",operationId:"produce_api_v1_message_producer__app_key__post",summary:"Produce Messages (corva-api compatibility)",tags:["data"],parameters:[{name:"app_key","in":"path",type:"string | null",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/subscriptions/{provider}/{dataset}/{asset_id}/",method:"POST",operationId:"publish_api_v1_subscriptions__provider___dataset___asset_id___post",summary:"Publish data to Corva Subscriptions Server.",description:"Publish data to **Corva Subscriptions Server** channel named `{provider}/{dataset}/{asset_id}`.",tags:["data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"asset_id","in":"path",type:"number",required:true,description:""}],requestBody:{contentType:"application/json",schema:"object | object[]",required:true},responses:{"204":{description:"Successful Response"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/v1/message_producer/",method:"POST",operationId:"produce_v1_message_producer__post",summary:"Produce Messages",tags:["data"],parameters:[{name:"app_key","in":"query",type:"string | null",required:false,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/v1/message_producer/{app_key}",method:"POST",operationId:"produce_v1_message_producer__app_key__post",summary:"Produce Messages (corva-api compatibility)",tags:["data"],parameters:[{name:"app_key","in":"path",type:"string | null",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ app_connection_id: number | null, data: { timestamp: object, collection: object }[] | { timestamp: object, collection: object, measured_depth: object }[] | null, force_schedules: boolean, produce_as: string | null, rerun_begins: number | null, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}}],datasets:[{path:"/api/v1/dataset/",method:"GET",operationId:"index_api_v1_dataset__get",summary:"Get All Datasets",tags:["datasets"],parameters:[{name:"search","in":"query",type:"string",required:false,description:"Search by dataset name"},{name:"plottable","in":"query",type:"boolean | null",required:false,description:"Filter by plottable datasets"},{name:"temporary","in":"query",type:"boolean | null",required:false,description:"Filter by temporary datasets"}],responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }[]"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/",method:"POST",operationId:"create_index_api_v1_dataset__provider___dataset__index__post",summary:"Create Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{index}/",method:"GET",operationId:"fetch_index_api_v1_dataset__provider___dataset__index__index___get",summary:"Get Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"index","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{index}/",method:"DELETE",operationId:"delete_index_api_v1_dataset__provider___dataset__index__index___delete",summary:"Delete Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"index","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{name}/{action}/",method:"POST",operationId:"perform_index_action_api_v1_dataset__provider___dataset__index__name___action___post",summary:"Perform Index Action",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""},{name:"action","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{dataset}/index/{name}/check/",method:"POST",operationId:"check_index_api_v1_dataset__provider___dataset__index__name__check__post",summary:"Check Index",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ name: string, fields: object[], unique: boolean, required: boolean, status: string, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"GET",operationId:"fetch_api_v1_dataset__provider___name___get",summary:"Get Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"POST",operationId:"create_api_v1_dataset__provider___name___post",summary:"Create Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"PATCH",operationId:"update_api_v1_dataset__provider___name___patch",summary:"Update Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],requestBody:{contentType:"application/json",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }",required:true},responses:{"200":{description:"Successful Response",schema:"{ company_id: number | null, provider: string, name: string, description: string | null, schema: object, ... }"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/{provider}/{name}/",method:"DELETE",operationId:"delete_api_v1_dataset__provider___name___delete",summary:"Delete Dataset",tags:["datasets"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"name","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/v1/dataset/company/",method:"GET",operationId:"by_company_api_v1_dataset_company__get",summary:"Get Datasets By Company",tags:["datasets"],parameters:[{name:"plottable","in":"query",type:"boolean | null",required:false,description:"Filter by plottable datasets"},{name:"type","in":"query",type:"\"time\" | \"depth\" | \"reference\" | \"timeseries\" | null",required:false,description:"Filter by dataset type: time, depth, reference"}],responses:{"200":{description:"Successful Response",schema:"object"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}}],"legacy-data":[{path:"/api/legacy/v1/data",method:"GET",operationId:"index_without_provider_api_legacy_v1_data_get",summary:"Index Without Provider",tags:["legacy-data"],parameters:[],responses:{"200":{description:"Successful Response",schema:"any"}}},{path:"/api/legacy/v1/data/{provider}",method:"GET",operationId:"index_without_dataset_api_legacy_v1_data__provider__get",summary:"Index Without Dataset",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}",method:"GET",operationId:"index_api_legacy_v1_data__provider___dataset__get",summary:"Index",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"GET",operationId:"show_api_legacy_v1_data__provider___dataset___id__get",summary:"Show",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"PUT",operationId:"put_api_legacy_v1_data__provider___dataset___id__put",summary:"Put",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}},{path:"/api/legacy/v1/data/{provider}/{dataset}/{id}",method:"PATCH",operationId:"patch_api_legacy_v1_data__provider___dataset___id__patch",summary:"Patch",tags:["legacy-data"],parameters:[{name:"provider","in":"path",type:"string",required:true,description:""},{name:"dataset","in":"path",type:"string",required:true,description:""},{name:"id","in":"path",type:"string",required:true,description:""}],responses:{"200":{description:"Successful Response",schema:"any"},"422":{description:"Validation Error",schema:"{ code: number, message: string }"}}}]},swaggerUrl:"https://data.corva.ai/api/v1/openapi.json"},{name:"socketClient",modulePath:"clients",importPath:"@corva/ui/clients",description:"WebSocket client for real-time data subscriptions. Supports both v1 and v2 subscription protocols.",methods:[{name:"subscribe",signature:"(subscription: SubscriptionConfig, options?: { onDataReceive?: Function }) => UnsubscribeFn",parameters:[{name:"subscription",type:"SubscriptionConfig",required:true,description:"Subscription configuration with collection/dataset and query"},{name:"options",type:"{ onDataReceive?: Function }",required:false,description:"Callback options for receiving data"}],returnType:"() => void",description:"Subscribe to real-time data updates. Returns an unsubscribe function."},{name:"onConnectionChange",signature:"(handler: (status: ConnectionStatus) => void) => UnsubscribeFn",parameters:[{name:"handler",type:"(status: ConnectionStatus) => void",required:true,description:"Handler for connection status changes"}],returnType:"() => void",description:"Listen for WebSocket connection status changes (connected, disconnected, reconnecting, error)"}],keywords:["websocket","socket","realtime","subscribe","subscription","stream","live"]},{name:"clientStorage",modulePath:"clients/clientStorage",importPath:"@corva/ui/clients",description:"Client-side storage utilities for managing local data persistence.",methods:[],keywords:["storage","local","session","persist","cache"]},{name:"jsonApi",modulePath:"clients/jsonApi",importPath:"@corva/ui/clients",description:"JSON API utilities for parsing and formatting API requests/responses.",methods:[],keywords:["json","api","parse","format","serialize"]},{name:"subscriptions",modulePath:"clients/subscriptions",importPath:"@corva/ui/clients",description:"Subscription management utilities for real-time data streams.",methods:[],keywords:["subscribe","subscription","realtime","stream"]},{name:"corvaUrls",modulePath:"clients/corvaUrls",importPath:"@corva/ui/clients",description:"URL utilities for constructing Corva platform URLs.",methods:[],keywords:["url","link","path","route"]},{name:"sso",modulePath:"clients/sso",importPath:"@corva/ui/clients",description:"Single Sign-On utilities for authentication flows.",methods:[],keywords:["sso","auth","login","authentication","oauth"]}];
|
|
@@ -19743,6 +19790,16 @@ var entries = [{
|
|
|
19743
19790
|
category: "components-v2",
|
|
19744
19791
|
importPath: "@corva/ui/componentsV2",
|
|
19745
19792
|
searchText: "radioandcheckboxgroup radioandcheckboxgroup"
|
|
19793
|
+
}, {
|
|
19794
|
+
id: "component-v2-RadioAndCheckboxIcons",
|
|
19795
|
+
type: "component",
|
|
19796
|
+
name: "RadioAndCheckboxIcons",
|
|
19797
|
+
description: "",
|
|
19798
|
+
keywords: ["radioandcheckboxicons"],
|
|
19799
|
+
tags: [],
|
|
19800
|
+
category: "components-v2",
|
|
19801
|
+
importPath: "@corva/ui/componentsV2",
|
|
19802
|
+
searchText: "radioandcheckboxicons radioandcheckboxicons"
|
|
19746
19803
|
}, {
|
|
19747
19804
|
id: "component-v2-RadioAndCheckboxLabel",
|
|
19748
19805
|
type: "component",
|
|
@@ -22463,6 +22520,16 @@ var entries = [{
|
|
|
22463
22520
|
category: "constants",
|
|
22464
22521
|
importPath: "@corva/ui/constants",
|
|
22465
22522
|
searchText: "classnames common css class names used across components classnames constant config"
|
|
22523
|
+
}, {
|
|
22524
|
+
id: "constant-DRAGGING_ATTRIBUTE",
|
|
22525
|
+
type: "constant",
|
|
22526
|
+
name: "DRAGGING_ATTRIBUTE",
|
|
22527
|
+
description: "Constant exported from attachments",
|
|
22528
|
+
keywords: ["dragging_attribute", "g_", "dragging", "attribute", "constant", "config"],
|
|
22529
|
+
tags: [],
|
|
22530
|
+
category: "constants",
|
|
22531
|
+
importPath: "@corva/ui/constants",
|
|
22532
|
+
searchText: "dragging_attribute constant exported from attachments dragging_attribute g_ dragging attribute constant config"
|
|
22466
22533
|
}, {
|
|
22467
22534
|
id: "client-corvaAPI",
|
|
22468
22535
|
type: "client",
|
|
@@ -26195,11 +26262,11 @@ var entries = [{
|
|
|
26195
26262
|
searchText: "counter counter css module classes for numeric display styling. includes badge styles for counters and notifications. counter number css style digit badge notification indicator counterbadge counterbadge16 counterbadge24 counterbadge32 counterbadgefixed16 counterbadgefixed24 counterbadgefixed32 counterbadgelimited16 counterbadgelimited24 counterbadgelimited32"
|
|
26196
26263
|
}];
|
|
26197
26264
|
var byCategory = {
|
|
26198
|
-
"components-v2": ["component-v2-Accordion", "component-v2-AppCommonsProvider", "component-v2-AppContainer", "component-v2-AppDqPopover", "component-v2-AppFooter", "component-v2-AppHeader", "component-v2-AppInfoMessage", "component-v2-AppSettings", "component-v2-AppSettingsDivider", "component-v2-AppSizeProvider", "component-v2-Autocomplete", "component-v2-Avatar", "component-v2-AvatarGroup", "component-v2-BadgeBase", "component-v2-BadgeComment", "component-v2-BadgeCounter", "component-v2-BadgeDot", "component-v2-Breadcrumbs", "component-v2-Button", "component-v2-ButtonIcon", "component-v2-ButtonLive", "component-v2-ButtonText", "component-v2-ChartHelper", "component-v2-Checkbox", "component-v2-CheckboxGroup", "component-v2-Chip", "component-v2-ChipAlert", "component-v2-ChipIndicator", "component-v2-ColorPicker", "component-v2-CompletionsOffsetWellPicker", "component-v2-CopyToClipboard", "component-v2-Counter", "component-v2-DatePicker", "component-v2-DragHandle", "component-v2-EmptyState", "component-v2-FileIcon", "component-v2-FilesDropzone", "component-v2-FilesLoader", "component-v2-FilesProcessor", "component-v2-Grid", "component-v2-Header", "component-v2-HideInNativeApp", "component-v2-Hint", "component-v2-Hotkey", "component-v2-ImageViewer", "component-v2-IndicatorLive", "component-v2-Label", "component-v2-LiveDotIndicator", "component-v2-LoaderCircular", "component-v2-LoaderLinear", "component-v2-LoaderLogo", "component-v2-Menu", "component-v2-Modal", "component-v2-ModalWindow", "component-v2-OffsetWellsButton", "component-v2-PadModeSelect", "component-v2-Paper", "component-v2-Popover", "component-v2-PopoverPanel", "component-v2-Popper", "component-v2-Radio", "component-v2-RadioAndCheckboxGroup", "component-v2-RadioAndCheckboxLabel", "component-v2-RadioGroup", "component-v2-Select", "component-v2-Skeleton", "component-v2-Slider", "component-v2-SliderAdvanced", "component-v2-Stepper", "component-v2-Switch", "component-v2-Tabs", "component-v2-Tag", "component-v2-TemplatesControl", "component-v2-Text", "component-v2-TextEndTruncated", "component-v2-TextInput", "component-v2-TextInputNext", "component-v2-TextLink", "component-v2-TextMiddleTruncated", "component-v2-ToggleButtons", "component-v2-Tooltip", "component-v2-UniversalLink", "component-v2-WellArchivedMessage"],
|
|
26265
|
+
"components-v2": ["component-v2-Accordion", "component-v2-AppCommonsProvider", "component-v2-AppContainer", "component-v2-AppDqPopover", "component-v2-AppFooter", "component-v2-AppHeader", "component-v2-AppInfoMessage", "component-v2-AppSettings", "component-v2-AppSettingsDivider", "component-v2-AppSizeProvider", "component-v2-Autocomplete", "component-v2-Avatar", "component-v2-AvatarGroup", "component-v2-BadgeBase", "component-v2-BadgeComment", "component-v2-BadgeCounter", "component-v2-BadgeDot", "component-v2-Breadcrumbs", "component-v2-Button", "component-v2-ButtonIcon", "component-v2-ButtonLive", "component-v2-ButtonText", "component-v2-ChartHelper", "component-v2-Checkbox", "component-v2-CheckboxGroup", "component-v2-Chip", "component-v2-ChipAlert", "component-v2-ChipIndicator", "component-v2-ColorPicker", "component-v2-CompletionsOffsetWellPicker", "component-v2-CopyToClipboard", "component-v2-Counter", "component-v2-DatePicker", "component-v2-DragHandle", "component-v2-EmptyState", "component-v2-FileIcon", "component-v2-FilesDropzone", "component-v2-FilesLoader", "component-v2-FilesProcessor", "component-v2-Grid", "component-v2-Header", "component-v2-HideInNativeApp", "component-v2-Hint", "component-v2-Hotkey", "component-v2-ImageViewer", "component-v2-IndicatorLive", "component-v2-Label", "component-v2-LiveDotIndicator", "component-v2-LoaderCircular", "component-v2-LoaderLinear", "component-v2-LoaderLogo", "component-v2-Menu", "component-v2-Modal", "component-v2-ModalWindow", "component-v2-OffsetWellsButton", "component-v2-PadModeSelect", "component-v2-Paper", "component-v2-Popover", "component-v2-PopoverPanel", "component-v2-Popper", "component-v2-Radio", "component-v2-RadioAndCheckboxGroup", "component-v2-RadioAndCheckboxIcons", "component-v2-RadioAndCheckboxLabel", "component-v2-RadioGroup", "component-v2-Select", "component-v2-Skeleton", "component-v2-Slider", "component-v2-SliderAdvanced", "component-v2-Stepper", "component-v2-Switch", "component-v2-Tabs", "component-v2-Tag", "component-v2-TemplatesControl", "component-v2-Text", "component-v2-TextEndTruncated", "component-v2-TextInput", "component-v2-TextInputNext", "component-v2-TextLink", "component-v2-TextMiddleTruncated", "component-v2-ToggleButtons", "component-v2-Tooltip", "component-v2-UniversalLink", "component-v2-WellArchivedMessage"],
|
|
26199
26266
|
"components-v1": ["component-v1-AddComment", "component-v1-AdvancedSlider", "component-v1-AnchorsList", "component-v1-Annotations", "component-v1-AppIcon", "component-v1-AppVersionsSelect", "component-v1-AssetEditor", "component-v1-AssetEditorV2", "component-v1-AssetNameLabel", "component-v1-AssetsMultipleSelector", "component-v1-AttachFileButton", "component-v1-Attachment", "component-v1-AttachmentLightbox", "component-v1-AttachmentPreview", "component-v1-Autocomplete", "component-v1-Avatar", "component-v1-BICOffsetPickerDialog", "component-v1-Breadcrumbs", "component-v1-Button", "component-v1-Casing", "component-v1-ChartButton", "component-v1-ChartButtons", "component-v1-ChartWrapper", "component-v1-AxisDropdown", "component-v1-ChartSelect", "component-v1-DragToZoomButton", "component-v1-ZoomInButton", "component-v1-ZoomOutButton", "component-v1-PanButton", "component-v1-ResetZoomButton", "component-v1-HideAxesButton", "component-v1-ChartTypeButton", "component-v1-ChartActionsList", "component-v1-Checkbox", "component-v1-Chip", "component-v1-ColorPicker", "component-v1-ColorPickerPalette", "component-v1-Comment", "component-v1-CommentCard", "component-v1-CommentComposer", "component-v1-CommentInput", "component-v1-CommentInputNext", "component-v1-CommentPin", "component-v1-CommentsInfo", "component-v1-ContextMenuItem", "component-v1-CopyToClipboard", "component-v1-Counter", "component-v1-CustomSelect", "component-v1-DatePicker", "component-v1-DateTimePicker", "component-v1-DevCenter", "component-v1-DisabledSettingsMessage", "component-v1-DocumentViewer", "component-v1-Drillstring", "component-v1-EChartsWrapper", "component-v1-EditableItem", "component-v1-EmbeddedApp", "component-v1-EmptyState", "component-v1-EmptyView", "component-v1-ErrorBoundary", "component-v1-FeedCard", "component-v1-FeedItem", "component-v1-FeedItemCard", "component-v1-FileIcon", "component-v1-FilePreview", "component-v1-FilesDropzone", "component-v1-FilesLoader", "component-v1-FilesLoaderV2", "component-v1-FilesProcessor", "component-v1-FolderMenuItem", "component-v1-FolderMenuItemWithLinks", "component-v1-Formula", "component-v1-GoogleDocsViewer", "component-v1-GradientManager", "component-v1-GradientPicker", "component-v1-HeaderLayout", "component-v1-HelpCenter", "component-v1-Hint", "component-v1-IconButton", "component-v1-IconMenu", "component-v1-InfiniteList", "component-v1-LabelsCounter", "component-v1-LoadingIndicator", "component-v1-MenuItem", "component-v1-MiddleTruncate", "component-v1-MiddleTruncatedText", "component-v1-Modal", "component-v1-NewCommentCursor", "component-v1-NewDocumentViewer", "component-v1-Notifications", "component-v1-OffsetWellButton", "component-v1-OffsetWellChips", "component-v1-OffsetWellMap", "component-v1-OffsetWellPickerV2", "component-v1-OffsetWellPickerV3", "component-v1-OffsetWellPickerV4", "component-v1-OffsetWellPickerV5", "component-v1-PadModeSelect", "component-v1-PadOffsetsPicker", "component-v1-PadOffsetsPickerV2", "component-v1-ParameterCharts", "component-v1-PinnableFilters", "component-v1-Popover", "component-v1-Popper", "component-v1-PostInput", "component-v1-PostPreviewDialog", "component-v1-PriceInput", "component-v1-RangeSlider", "component-v1-RealTimeValuesSidebar", "component-v1-ResizableTable", "component-v1-Search", "component-v1-SearchInput", "component-v1-Select", "component-v1-SettingEditors", "component-v1-SlateFormattedText", "component-v1-StageDesignVActual", "component-v1-StatusBadge", "component-v1-Stepper", "component-v1-StyledMenuItem", "component-v1-SwitchControl", "component-v1-Table", "component-v1-Tabs", "component-v1-TextField", "component-v1-TextLink", "component-v1-Toaster", "component-v1-Tooltip", "component-v1-TracesEditModal", "component-v1-TruncatedText", "component-v1-UserCard", "component-v1-UserMention", "component-v1-VirtualizedTable", "component-v1-WellSummary"],
|
|
26200
26267
|
hooks: ["hook-useSubscriptions", "hook-useOutsideClick", "hook-useEscPress", "hook-useDevCenterApp", "hook-useSignedURL", "hook-useSharedDCStore", "hook-useResizeObserver", "hook-useIsAssetViewer", "hook-useLoadedData", "hook-usePadSelectorSelectedWells", "hook-useWellnessAlerts", "hook-useAppCommentsMode", "hook-useSetAppCommentsMode", "hook-useAppCommons", "hook-useAppSettingPinning", "hook-useGlobalOffsetWellsSync"],
|
|
26201
26268
|
utils: ["util-StageDesignVActualUtils", "util-alerts", "util-audio", "util-casing", "util-chartSeries", "util-completion", "util-convert", "util-csvExport", "util-devcenter", "util-drillstring", "util-drillstringUtils", "util-fluidCheckUtils", "util-formatting", "util-ga", "util-goals", "util-goalsConfig", "util-lasParser", "util-main", "util-mapUnits", "util-metricsUtils", "util-mobileDetect", "util-nativeMessages", "util-notifications", "util-feed", "util-permissions", "util-reports", "util-time", "util-torqueAndHookloadUtils", "util-accuracy", "util-dashboardReports", "util-apps", "util-themeVariables", "util-env", "util-fileExtension", "util-bha", "util-delay", "util-downloadBlob", "util-getSingleAsset", "util-enableHighchartsDelayedTooltip", "util-components", "util-convertArray", "util-convertImmutables", "util-convertImmutablesByBatch", "util-convertKeysToCamelCase", "util-convertKeysToSnakeCase", "util-convertValue", "util-createNotification", "util-formatMentionText", "util-getAllUnitTypes", "util-getConvertKeys", "util-getDefaultImperialUnit", "util-getDefaultUnits", "util-getLocalStorageItem", "util-getUniqueUnitsByType", "util-getUnitDescription", "util-getUnitDisplay", "util-getUnitPlural", "util-getUnitPreference", "util-getUnitSingular", "util-getUnitSystem", "util-getUnitsByType", "util-getUserUnits", "util-jsonaDataFormatter", "util-mapbox", "util-removeNotification", "util-resolveWellHubSlug", "util-sharedDCStore", "util-showErrorNotification", "util-showInfoNotification", "util-showNeutralNotification", "util-showSuccessNotification", "util-showToast", "util-showWarningNotification", "util-subscribeForUserUnitsUpdates", "util-updateLocalStorageItem", "util-updateUserUnits", "util-isSuggestionsListOpened", "util-stripMentionMarkup", "util-formatFileSize"],
|
|
26202
|
-
constants: ["constant-goals", "constant-segment", "constant-alerts", "constant-apps", "constant-casing", "constant-drillstring", "constant-completion", "constant-appPackages", "constant-notifications", "constant-feed", "constant-bha", "constant-localStorageKeys", "constant-DEV_CENTER_CLI_APP_ID", "constant-ASSET_TYPES", "constant-CORVA_COMPANY_ID", "constant-CORVA_COMPANY_NAME", "constant-CORVA_COMPANY_PROVIDER", "constant-DRILLING_WELL_SUMMARY", "constant-COMPLETION_WELL_SUMMARY", "constant-DRILLOUT_WELL_SUMMARY", "constant-RIG_ACTIVITY_COLORS", "constant-DEFAULT_COLUMN_MAPPER_UNITS", "constant-componentsSettings", "constant-CLASSNAMES"],
|
|
26269
|
+
constants: ["constant-goals", "constant-segment", "constant-alerts", "constant-apps", "constant-casing", "constant-drillstring", "constant-completion", "constant-appPackages", "constant-notifications", "constant-feed", "constant-bha", "constant-localStorageKeys", "constant-DEV_CENTER_CLI_APP_ID", "constant-ASSET_TYPES", "constant-CORVA_COMPANY_ID", "constant-CORVA_COMPANY_NAME", "constant-CORVA_COMPANY_PROVIDER", "constant-DRILLING_WELL_SUMMARY", "constant-COMPLETION_WELL_SUMMARY", "constant-DRILLOUT_WELL_SUMMARY", "constant-RIG_ACTIVITY_COLORS", "constant-DEFAULT_COLUMN_MAPPER_UNITS", "constant-componentsSettings", "constant-CLASSNAMES", "constant-DRAGGING_ATTRIBUTE"],
|
|
26203
26270
|
clients: ["client-corvaAPI", "client-corvaDataAPI", "client-socketClient", "client-clientStorage", "client-jsonApi", "client-subscriptions", "client-corvaUrls", "client-sso"],
|
|
26204
26271
|
permissions: ["permission-usePermissions", "permission-PERMISSIONS", "permission-ABILITIES", "permission-parsePermission", "permission-stringifyPermission", "permission-withPermissionsHOC", "permission-useProvidePermissions", "permission-ProvidePermissions", "permission-usePermissionsContext"],
|
|
26205
26272
|
icons: ["icon-DownSmallIcon", "icon-UpSmallIcon", "icon-RightSmallIcon", "icon-LeftSmallIcon", "icon-LeftSmallDownIcon", "icon-LeftSmallUpIcon", "icon-RightSmallDownIcon", "icon-RightSmallUpIcon", "icon-ArrowDownIcon", "icon-ArrowUpIcon", "icon-ArrowRightIcon", "icon-ArrowLeftIcon", "icon-ArrowLeftDownIcon", "icon-ArrowLeftUpIcon", "icon-ArrowRightDownIcon", "icon-ArrowRightUpIcon", "icon-CircularConnectionIcon", "icon-CornerUpRightIcon", "icon-CornerUpLeftIcon", "icon-CornerRightUpIcon", "icon-CornerRightDownIcon", "icon-CornerLeftUpIcon", "icon-CornerLeftDownIcon", "icon-CornerDownRightIcon", "icon-CornerDownLeftIcon", "icon-DownIcon", "icon-UpIcon", "icon-RightIcon", "icon-LeftIcon", "icon-DoubleDownIcon", "icon-DoubleLeftIcon", "icon-DoubleRightIcon", "icon-DoubleUpIcon", "icon-RightOneIcon", "icon-LeftOneIcon", "icon-DownOneIcon", "icon-UpOneIcon", "icon-FillIcon", "icon-GoEndIcon", "icon-GoStartIcon", "icon-ToBottomOneIcon", "icon-ToTopOneIcon", "icon-DownloadIcon", "icon-UploadIcon", "icon-LoginIcon", "icon-LogoutIcon", "icon-ShareIcon", "icon-ShareThreeIcon", "icon-ExpandTextInputIcon", "icon-CollapseTextInputIcon", "icon-FullScreenIcon", "icon-FullScreenOneIcon", "icon-OffScreenOneIcon", "icon-OffScreenIcon", "icon-OffScreenTwoIcon", "icon-FullScreenTwoIcon", "icon-SortAmountDownIcon", "icon-SortAmountUpIcon", "icon-SortFourIcon", "icon-SortThreeIcon", "icon-SortTwoIcon", "icon-SwitchIcon", "icon-ClickToFoldIcon", "icon-SortIcon", "icon-BackIcon", "icon-ShareTwoIcon", "icon-SlidingVerticalIcon", "icon-SlidingHorizontalIcon", "icon-TrendingUpIcon", "icon-InvertLeftIcon", "icon-BackOneIcon", "icon-InvertRightIcon", "icon-GoAheadIcon", "icon-UndoIcon", "icon-RedoIcon", "icon-RotationHorizontalIcon", "icon-RotationVerticalIcon", "icon-RefreshIcon", "icon-SpannerIcon", "icon-PlusIcon", "icon-MinusIcon", "icon-AddFourIcon", "icon-AddIcon", "icon-ReduceIcon", "icon-ReduceOneIcon", "icon-CommentIcon", "icon-CommentOneIcon", "icon-MessageIcon", "icon-MessageOneIcon", "icon-MessageSentIcon", "icon-DragIcon", "icon-ApplicationMenuIcon", "icon-ActivitySourceIcon", "icon-VerticalTidyUpIcon", "icon-SystemIcon", "icon-MemoryOneIcon", "icon-AllApplicationIcon", "icon-MoreAppIcon", "icon-ApplicationTwoIcon", "icon-ServerIcon", "icon-AppSwitchIcon", "icon-ChartHistogramOneIcon", "icon-ChartHistogramIcon", "icon-ChartHistogramTwoIcon", "icon-ChartLineAreaIcon", "icon-ChartLineIcon", "icon-ChartPieIcon", "icon-ChartProportionIcon", "icon-PieThreeIcon", "icon-PieTwoIcon", "icon-HistogramIcon", "icon-RankingIcon", "icon-ChartStockIcon", "icon-BubbleChartIcon", "icon-ZoomInIcon", "icon-ZoomOutIcon", "icon-LocalPinIcon", "icon-LocalTwoIcon", "icon-LocalIcon", "icon-FiveFiveIcon", "icon-MoveInOneIcon", "icon-AverageIcon", "icon-ScatterAlignmentIcon", "icon-WriteIcon", "icon-EditIcon", "icon-EditTwoIcon", "icon-DeleteIcon", "icon-DeleteOneIcon", "icon-DeleteFourIcon", "icon-CopyIcon", "icon-CopyOneIcon", "icon-LockIcon", "icon-UnlockIcon", "icon-FolderOpenIcon", "icon-FolderClosedIcon", "icon-PencilIcon", "icon-ScreenshotOneIcon", "icon-LeftAlignmentIcon", "icon-CenterAlignmentIcon", "icon-FilterIcon", "icon-EqualizerIcon", "icon-TreeListIcon", "icon-CheckSmallIcon", "icon-CloseSmallIcon", "icon-CautionIcon", "icon-AttentionIcon", "icon-InfoIcon", "icon-CheckOneIcon", "icon-CloseOneIcon", "icon-HelpIcon", "icon-HamburgerButtonIcon", "icon-MoreIcon", "icon-MoreOneIcon", "icon-MoreTwoIcon", "icon-MoreThreeIcon", "icon-LeftBarIcon", "icon-ShareOneIcon", "icon-homeIcon", "icon-HomeTwoIcon", "icon-SendIcon", "icon-PreviewOpenIcon", "icon-PreviewCloseOneIcon", "icon-PreviewCloseIcon", "icon-SettingTwoIcon", "icon-SettingOneIcon", "icon-SettingIcon", "icon-SettingThreeIcon", "icon-SettingConfigIcon", "icon-TableFileIcon", "icon-CalendarDotIcon", "icon-CalendarThreeIcon", "icon-CalendarIcon", "icon-TimeIcon", "icon-StopwatchIcon", "icon-HistoryIcon", "icon-AlarmClockIcon", "icon-UserIcon", "icon-AddUserIcon", "icon-RightUserIcon", "icon-WrongUserIcon", "icon-ReduceUserIcon", "icon-PeopleIcon", "icon-PeoplePlusOneIcon", "icon-PeoplePlusIcon", "icon-PeopleMinusOneIcon", "icon-PeopleMinusIcon", "icon-PeopleDeleteOneIcon", "icon-PeopleDeleteIcon", "icon-PeoplesIcon", "icon-PeoplesTwoIcon", "icon-ContrastViewIcon", "icon-RemindDisableIcon", "icon-RemindIcon", "icon-AlarmIcon", "icon-ReportIcon", "icon-LikeIcon", "icon-TipsIcon", "icon-PlatteIcon", "icon-DetectionIcon", "icon-LinkIcon", "icon-RocketOneIcon", "icon-RocketIcon", "icon-SunIcon", "icon-SunOneIcon", "icon-MoonIcon", "icon-PuzzleIcon", "icon-PowerIcon", "icon-BroadcastIcon", "icon-ShareSysIcon", "icon-SignalOneIcon", "icon-SignalStrengthIcon", "icon-AutoFocusIcon", "icon-PennantIcon", "icon-FlagIcon", "icon-TagOneIcon", "icon-LabelIcon", "icon-RssIcon", "icon-LinkOneIcon", "icon-LinkTwoIcon", "icon-PaperclipIcon", "icon-LoadingFourIcon", "icon-LoadingOneIcon", "icon-LoadingIcon", "icon-PauseOneIcon", "icon-PauseIcon", "icon-PlayOneIcon", "icon-TerminalIcon", "icon-InstructionIcon", "icon-CodeIcon", "icon-CodeOneIcon", "icon-DeleteKeyIcon", "icon-DeleteTwoIcon", "icon-ShieldAddIcon", "icon-HarmIcon", "icon-ProtectIcon", "icon-SwitchButtonIcon", "icon-LaptopComputerIcon", "icon-PrinterTwoIcon", "icon-PrinterIcon", "icon-PictureIcon", "icon-HandleRoundIcon", "icon-LayersIcon", "icon-SmilingFaceIcon", "icon-StarIcon", "icon-ThumbsUpIcon", "icon-ThermometerIcon", "icon-RulerIcon", "icon-AddOneIcon", "icon-CloseIcon", "icon-RotateIcon", "icon-MapDrawIcon", "icon-MultiRectangleIcon", "icon-PushpinIcon", "icon-SpeedIcon", "icon-VerticalLinesIcon", "icon-PaletteIcon", "icon-PickerIcon", "icon-LineChartIcon", "icon-ExpandIcon", "icon-CollapseIcon", "icon-BarChartIcon", "icon-ApplicationIcon", "icon-FiveIcon", "icon-MoveInIcon", "icon-AdjustmentIcon", "icon-AlignVerticallyIcon", "icon-AlignHorizontallyIcon", "icon-DataSwitchingIcon", "icon-TransferDataIcon", "icon-DataIcon", "icon-IconParkProvider", "icon-AddMessageIcon", "icon-DragOneIcon", "icon-AttentionIcon", "icon-CollapseIcon", "icon-DashboardIcon", "icon-ExpandIcon", "icon-ExpandIcon", "icon-FolderClosedIcon", "icon-FolderClosedFilledIcon", "icon-FolderOpenedIcon", "icon-GreaterOrEqualIcon", "icon-LessOrEqualIcon", "icon-SearchIcon", "icon-SearchOneIcon", "icon-WellhubIcon", "icon-MultiRulerIcon", "icon-CheckboxIcon", "icon-CheckboxCheckedIcon", "icon-CheckboxIndeterminateIcon", "icon-RadioIcon", "icon-RadioCheckedIcon", "icon-SimulFracIcon", "icon-ZipperFracIcon", "icon-CautionFilledIcon", "icon-MoreAppIcon", "icon-PadIcon", "icon-DrilloutUnitIcon", "icon-FracFleetIcon", "icon-GlobalIcon", "icon-ProgramIcon", "icon-RigIcon", "icon-WellIcon", "icon-GapIcon", "icon-PinIcon", "icon-CloseOneFilledIcon", "icon-AttentionFilledIcon", "icon-CheckOneFilledIcon", "icon-ArchiveIcon", "icon-ArchiveCancelIcon", "icon-UnarchiveIcon", "icon-ArchivedIcon", "icon-InterventionUnitIcon", "icon-CloudDeleteIcon", "icon-LassoIcon", "icon-RadiusIcon", "icon-ErrorOpsIcon", "icon-DataTypeOpsIcon", "icon-FalsePositiveOpsIcon", "icon-CalibrationOpsIcon", "icon-CriticalOpsIcon", "icon-CompanyIcon", "icon-ArchiveOneIcon", "icon-ParseBotFusionIcon", "icon-ConnectIcon", "icon-PuzzleOneIcon", "icon-FeedIcon", "icon-PromptIcon", "icon-CompaniesIcon", "icon-ClipboardAiIcon", "icon-KeyIcon", "icon-AtSignCrossedIcon", "icon-MappingManualIcon", "icon-MappingIcon", "icon-MetricsIcon", "icon-DropsIcon", "icon-ClipboardSearchIcon", "icon-TemplateIcon", "icon-ClipboardMetricsIcon", "icon-ClipboardBuilderIcon", "icon-UnitConversionIcon", "icon-NPTIcon", "icon-GuidedFracIcon"],
|
|
@@ -26497,6 +26564,7 @@ var byTag = {
|
|
|
26497
26564
|
group: ["component-v2-Radio"],
|
|
26498
26565
|
buttons: ["component-v2-Radio", "component-v2-RadioGroup"],
|
|
26499
26566
|
radioandcheckboxgroup: ["component-v2-RadioAndCheckboxGroup"],
|
|
26567
|
+
radioandcheckboxicons: ["component-v2-RadioAndCheckboxIcons"],
|
|
26500
26568
|
radioandcheckboxlabel: ["component-v2-RadioAndCheckboxLabel"],
|
|
26501
26569
|
radiogroup: ["component-v2-RadioGroup"],
|
|
26502
26570
|
works: ["component-v2-RadioGroup"],
|