openapi: 3.2.0 info: version: v2.222.1 title: Corva Assets API description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API' termsOfService: https://www.corva.ai/terms-and-conditions/ contact: name: Corva API Team email: support@corva.ai security: - api_key: [] tags: - name: Assets description: 'Manage company assets: Programs, Pads, Rigs, Wells, Frac Fleets, and Wirelines' paths: /v2/favorites: get: summary: List favorites tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List user favorites content: application/json: schema: properties: programs: properties: data: type: array items: $ref: '#/components/schemas/Program' rigs: properties: data: type: array items: $ref: '#/components/schemas/Rig' wells: properties: data: type: array items: $ref: '#/components/schemas/Well' pads: properties: data: type: array items: $ref: '#/components/schemas/Pad' frac_fleets: properties: data: type: array items: $ref: '#/components/schemas/FracFleet' drillout_units: properties: data: type: array items: $ref: '#/components/schemas/DrilloutUnit' wirelines: properties: data: type: array items: $ref: '#/components/schemas/Wireline' parameters: - in: query name: fields description: 'Filter response fields, example: fields=rig.name,rig.active_well,well.name' schema: type: string description: Returns all of the favorites that are saved in a user's settings.favorites key. operationId: getV2Favorites x-operation-id-source: derived /v2/assets: get: summary: List assets tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List assets content: application/json: schema: type: array items: $ref: '#/components/schemas/Asset' parameters: - in: query name: types description: List of asset types schema: type: string items: type: string enum: - program - rig - well - in: query name: status description: Search by asset status (wells only; status is null for other asset types) schema: type: string enum: - active - idle - paused - complete - deleting - in: query name: visibility description: Search by asset visibility schema: type: string enum: - visible - visible_to_admin - deleted - in: query name: ids description: List of asset IDs to filter by schema: items: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: parent_asset_id description: Search by parent asset ID schema: type: integer - in: query name: api_number description: Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored schema: type: string - in: query name: search description: Search by asset ID, asset name, api_number or customer_well_id schema: type: string - in: query name: start description: Search by start time as a Unix timestamp schema: type: integer format: timestamp - in: query name: end description: Search by end time as a Unix timestamp schema: type: integer format: timestamp - in: query name: long_start description: Search by lon_lat coordinate area schema: type: float - in: query name: long_end description: Search by lon_lat coordinate area schema: type: float - in: query name: lat_start description: Search by lon_lat coordinate area schema: type: float - in: query name: lat_end description: Search by lon_lat coordinate area schema: type: float - in: query name: company_id description: Search by Company ID schema: type: integer - in: query name: api_number description: Search by one API number or multiple API numbers using api_number[] or comma-separated values; dashes are ignored schema: type: string - in: query name: fields description: Respond with only the given list of fields, like asset.asset_type. See example response for fields. schema: items: type: string - in: query name: per_page description: Number of items to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name,-last_active_at' schema: type: string enum: - name - last_active_at - status - rig - program - well - company - well_end - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc - in: query name: range_filter_field description: Filtering datetime with start/end schema: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than or equal to the given timestamp schema: type: datetime - in: query name: last_active_drilling_before description: Return records where last_drilling_at is smaller than the given timestamp schema: type: datetime - in: query name: last_active_drilling_after description: Return records where last_drilling_at is greater than or equal to the given timestamp schema: type: datetime - in: query name: include_rig_id description: Add rig_id to response(only works with Asset::Rig) schema: type: boolean - in: query name: include_type_wells description: Add type wells to response(only works with Asset::Well) schema: type: boolean - in: query name: include_intervention_units description: Add intervention units to response schema: type: boolean - in: query name: polygon_coords description: Filter by assets within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed. schema: items: type: object properties: latitude: type: float description: Latitude coordinate of the polygon point longitude: type: float description: Longitude coordinate of the polygon point example: value: - latitude: 29.0 longitude: -96.0 - latitude: 31.0 longitude: -96.0 - latitude: 31.0 longitude: -94.0 - latitude: 29.0 longitude: -94.0 operationId: getV2Assets x-operation-id-source: derived /v2/assets/{id}: get: summary: Get asset by ID tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Show asset content: application/json: schema: $ref: '#/components/schemas/Asset' parameters: - in: path name: id description: Asset ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like asset.asset_type schema: items: type: string operationId: getV2AssetsById x-operation-id-source: derived /v2/assets/{id}/settings: get: summary: Get asset settings tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Asset settings, merged with optional connection settings content: application/json: schema: $ref: '#/components/schemas/Asset' parameters: - in: path name: id description: Asset ID schema: type: integer required: true - in: query name: app_key description: App Key schema: type: string - in: query name: segment description: Used with app_key schema: type: string enum: - drilling - completion - intervention default: drilling - in: query name: source_type description: Used with app_key schema: type: string enum: - drilling - drillout - frac - pumpdown - wireline default: drilling - in: query name: log_type description: Used with source_type and app_key schema: type: string enum: - time - depth default: time - in: query name: app_connection_id description: App Connection ID schema: type: integer - in: query name: app_stream_id description: App Stream ID, used with app_key schema: type: integer operationId: getV2AssetsByIdSettings x-operation-id-source: derived /v2/assets/{id}/type_wells: get: summary: List type well assets tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Type well assets content: application/json: schema: $ref: '#/components/schemas/Asset' parameters: - in: path name: id description: Asset ID schema: type: integer required: true operationId: getV2AssetsByIdTypeWells x-operation-id-source: derived /v2/assets/{id}/type_well: post: summary: Create a new type_well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Newly created type well object content: application/json: schema: $ref: '#/components/schemas/TypeWell' parameters: - in: path name: id description: Asset ID schema: type: integer required: true requestBody: content: application/json: schema: type: integer example: offset_well_id: 56789 description: Offset Well Id required: true operationId: postV2AssetsByIdTypeWell x-operation-id-source: derived /v2/assets/{id}/type_wells/{type_well_id}: delete: summary: Delete type_well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Delete type well object content: application/json: schema: $ref: '#/components/schemas/TypeWell' parameters: - in: path name: id description: Asset ID schema: type: integer required: true - in: path name: type_well_id required: true description: Type Well Id schema: type: integer operationId: deleteV2AssetsByIdTypeWellsByTypeWellId x-operation-id-source: derived /v2/assets/{id}/reruns: get: summary: Return reruns for the asset tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Reruns content: application/json: schema: type: array items: $ref: '#/components/schemas/Rerun' parameters: - in: path name: id description: Asset ID schema: type: integer required: true operationId: getV2AssetsByIdReruns x-operation-id-source: derived /v2/assets/{id}/ancestor_ids: get: summary: Return the ancestor_ids for the asset tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Ancestors content: application/json: schema: $ref: '#/components/schemas/AncestorsResponse' parameters: - in: path name: id description: Asset ID schema: type: integer required: true operationId: getV2AssetsByIdAncestorIds x-operation-id-source: derived /v2/assets/resolve: post: summary: Resolve old-style assets to new-style assets tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Resolution results content: application/json: schema: $ref: '#/components/schemas/AssetResolver' requestBody: content: application/json: schema: {} description: Array of asset IDs to convert required: true operationId: postV2AssetsResolve x-operation-id-source: derived /v2/assets/autocomplete: get: summary: Return autocompletion tokens tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Search results content: application/json: schema: $ref: '#/components/schemas/AssetAutocomplete' parameters: - in: query name: field required: true schema: type: string enum: - area - in: query name: search description: Filter by a wildcard search schema: type: string - in: query name: company_id description: Corva admins only. Scope to a particular company. schema: type: integer operationId: getV2AssetsAutocomplete x-operation-id-source: derived /v2/programs: get: summary: List programs tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List programs content: application/json: schema: type: array items: $ref: '#/components/schemas/Program' parameters: - in: query name: ids description: List of program IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: name description: Search by program name schema: type: string - in: query name: fields description: Respond with only the given list of fields, like program.name schema: items: type: string - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: per_page description: Number of programs to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name' schema: type: string enum: - name - company default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc operationId: getV2Programs x-operation-id-source: derived post: summary: Create a program tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created program content: application/json: schema: $ref: '#/components/schemas/Program' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramPayload' description: Program Payload required: true operationId: postV2Programs x-operation-id-source: derived /v2/programs/{id}: get: summary: Get a single program tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get program content: application/json: schema: $ref: '#/components/schemas/Program' parameters: - in: path name: id description: Program ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like program.name schema: items: type: string operationId: getV2ProgramsById x-operation-id-source: derived patch: summary: Update a program tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated program content: application/json: schema: $ref: '#/components/schemas/Program' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramPayload' description: Program Payload required: true operationId: patchV2ProgramsById x-operation-id-source: derived delete: summary: Delete a program tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Program deleted parameters: - in: path name: id description: Program ID required: true schema: type: integer operationId: deleteV2ProgramsById x-operation-id-source: derived /v2/programs/clusters: get: summary: Get programs clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/ProgramCluster' parameters: - in: query name: ids description: List of program IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2ProgramsClusters x-operation-id-source: derived /v2/pads: get: summary: List pads tags: - Assets operationId: pads responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List pads content: application/json: schema: type: array items: $ref: '#/components/schemas/Pad' parameters: - in: query name: ids description: List of pad IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: frac_fleet description: Search by Frac Fleet ID schema: type: integer - in: query name: current_frac_fleet description: Search by Frac Fleet ID where it is the current Frac Fleet on the Pad schema: type: integer - in: query name: drillout_unit description: Search by Drillout Unit ID schema: type: integer - in: query name: search description: Search by pad name schema: type: string - in: query name: fields description: Respond with only the given list of fields, like pad.name schema: items: type: string - in: query name: active description: Return records that have an active well schema: type: boolean - in: query name: current description: Return records that are current based on PadFracFleet schema: type: boolean - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: datetime - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: well_ids description: Filter by array of well ids schema: items: type: integer - in: query name: per_page description: Number of pads to list per page schema: type: integer - in: query name: page description: Number of page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: company,name' schema: type: string enum: - name - company - program - drillout_unit - last_active_at default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc post: summary: Create a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created pad content: application/json: schema: $ref: '#/components/schemas/Pad' requestBody: content: application/json: schema: $ref: '#/components/schemas/PadPayload' description: Pad Payload required: true operationId: postV2Pads x-operation-id-source: derived /v2/pads/{id}: get: summary: Get a single pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get pad content: application/json: schema: $ref: '#/components/schemas/Pad' parameters: - in: path name: id description: Pad ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like pad.name schema: items: type: string operationId: getV2PadsById x-operation-id-source: derived patch: summary: Update a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' parameters: - in: path name: id description: Pad ID required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/PadPayload' description: Pad Payload required: true operationId: patchV2PadsById x-operation-id-source: derived delete: summary: Delete a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Pad deleted parameters: - in: path name: id description: Pad ID required: true schema: type: integer operationId: deleteV2PadsById x-operation-id-source: derived /v2/pads/{id}/frac_fleets: post: summary: Add a frac fleet to a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' parameters: - in: path name: id description: Pad ID required: true requestBody: content: application/json: schema: {} description: ID of a Frac Fleet to set to be this Pad's current Frac Fleet operationId: postV2PadsByIdFracFleets x-operation-id-source: derived /v2/pads/{pad_id}/frac_fleets/{id}: delete: summary: Delete a frac fleet from a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' parameters: - in: path name: pad_id description: Pad ID required: true - in: path name: id description: Frac Fleet ID required: true operationId: deleteV2PadsByPadIdFracFleetsById x-operation-id-source: derived /v2/pads/{pad_id}/app_wells: get: summary: Retrieve wells and app stream details for a pad filtered by app.source_type tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Pad Details content: application/json: schema: $ref: '#/components/schemas/PadDetails' parameters: - in: path name: pad_id description: Pad ID required: true schema: type: integer - in: query name: dashboard_app_id description: Find app by Dashboard app id schema: type: integer - in: query name: app_id description: Find app by app id schema: type: integer - in: query name: app_key description: Find app by app key schema: type: string operationId: getV2PadsByPadIdAppWells x-operation-id-source: derived /v2/pads/{id}/wells: get: summary: Retrieve well and app stream details for a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Pad Details content: application/json: schema: $ref: '#/components/schemas/PadDetails' description: Retrieve the wells and nested app streams for a pad. parameters: - in: path name: id description: Pad ID required: true - in: query name: segment description: Segments to filter the wells and app streams by schema: type: string enum: - drilling - completion - intervention - in: query name: source_type description: Source Types to filter the wells and app streams by schema: type: string enum: - drilling - drillout - frac - pumpdown - wireline - in: query name: log_type description: Log Types to filter the wells and app streams by schema: type: string enum: - time - depth - in: query name: status description: Statuses to filter app streams by schema: type: string enum: - active - paused - idle - complete - in: query name: include_intervention_units description: Include intervention units in the response operationId: getV2PadsByIdWells x-operation-id-source: derived post: summary: Add a well to a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' description: Set one or more wells so that they belong to a pad. parameters: - in: path name: id description: Pad ID required: true requestBody: content: application/json: schema: {} description: Well IDs required: true operationId: postV2PadsByIdWells x-operation-id-source: derived /v2/pads/{pad_id}/wells/{id}: delete: summary: Delete a well from a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' description: Remove a well from a pad. Also removes the well from the pad.active_wells list, if found. parameters: - in: path name: pad_id description: Pad ID required: true - in: path name: id description: Well ID required: true operationId: deleteV2PadsByPadIdWellsById x-operation-id-source: derived /v2/pads/{id}/active_wells: post: summary: Add an active well to a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/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. parameters: - in: path name: id description: Pad ID required: true requestBody: content: application/json: schema: {} description: Well IDs required: true operationId: postV2PadsByIdActiveWells x-operation-id-source: derived /v2/pads/{pad_id}/active_wells/{id}: delete: summary: Delete an active well from a pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated pad content: application/json: schema: $ref: '#/components/schemas/Pad' description: Remove a well from a pad.active_wells list. parameters: - in: path name: pad_id description: Pad ID required: true - in: path name: id description: Well ID required: true operationId: deleteV2PadsByPadIdActiveWellsById x-operation-id-source: derived /v2/pads/clusters: get: summary: Get pads clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/PadCluster' parameters: - in: query name: ids description: List of pad IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: frac_fleet description: Search by Frac Fleet ID schema: type: integer - in: query name: current_frac_fleet description: Search by Frac Fleet ID where it is the current Frac Fleet on the Pad schema: type: integer - in: query name: drillout_unit description: Search by Drillout Unit ID schema: type: integer - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: integer - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2PadsClusters x-operation-id-source: derived /v2/rigs: get: summary: List rigs tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List rigs content: application/json: schema: type: array items: $ref: '#/components/schemas/Rig' parameters: - in: query name: ids description: List of rig IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: active_well description: Search by active well ID schema: type: integer - in: query name: has_active_well description: Return rigs that have an active well schema: type: integer - in: query name: search description: Search by rig name schema: type: string - in: query name: app_key description: Return rigs that have been part of any product subscription that included the given app schema: type: string - in: query name: fields description: Respond with only the given list of fields, like rig.name schema: items: type: string - in: query name: active description: Return records that have an active well schema: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: datetime - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: existing_partial_reruns description: Filter by existing partial reruns schema: type: boolean - in: query name: per_page description: Number of rigs to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: program,name' schema: type: string enum: - name - program - company - last_active_at default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc operationId: getV2Rigs x-operation-id-source: derived post: summary: Create a rig tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created rig content: application/json: schema: $ref: '#/components/schemas/Rig' requestBody: content: application/json: schema: $ref: '#/components/schemas/RigPayload' description: Rig Payload required: true operationId: postV2Rigs x-operation-id-source: derived /v2/rigs/{id}: get: summary: Get a single rig tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get rig content: application/json: schema: $ref: '#/components/schemas/Rig' parameters: - in: path name: id description: Rig ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like rig.name schema: items: type: string operationId: getV2RigsById x-operation-id-source: derived patch: summary: Update a rig tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated rig content: application/json: schema: $ref: '#/components/schemas/Rig' requestBody: content: application/json: schema: $ref: '#/components/schemas/RigPayload' description: Rig Payload required: true operationId: patchV2RigsById x-operation-id-source: derived delete: summary: Delete a rig tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Rig deleted parameters: - in: path name: id description: Rig ID required: true schema: type: integer operationId: deleteV2RigsById x-operation-id-source: derived /v2/rigs/clusters: get: summary: Get rigs clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/RigCluster' parameters: - in: query name: ids description: List of rig IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: active_well description: Search by active well ID schema: type: integer - in: query name: has_active_well description: Return rigs that have an active well schema: type: integer - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: integer - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2RigsClusters x-operation-id-source: derived /v2/rigs/{rig_id}/active_well/well_cache: get: summary: Get well_cache record for the active well on the rig tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Well Cache Record content: application/json: schema: $ref: '#/components/schemas/WellCacheRecord' parameters: - in: query name: rig_id description: Rig ID schema: type: integer - in: header name: Serializer description: 'Controls how the data is serialized. Options: "drilling-widget"' schema: type: string operationId: getV2RigsByRigIdActiveWellWellCache x-operation-id-source: derived /v2/drillout_units: get: summary: List drillout units tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List drillout units content: application/json: schema: type: array items: $ref: '#/components/schemas/DrilloutUnit' parameters: - in: query name: ids description: List of drillout unit IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: well description: Search by Well ID schema: type: integer - in: query name: search description: Search by drillout unit name schema: type: string - in: query name: app_key description: Return drillout units that have been part of any product subscription that included the given app schema: type: string - in: query name: fields description: Respond with only the given list of fields, like drillout_unit.name schema: items: type: string - in: query name: active description: Return records that have an active well schema: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: datetime - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: per_page description: Number of drillout units to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: company,name' schema: type: string enum: - name - program - company - pad - well - last_active_at default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc operationId: getV2DrilloutUnits x-operation-id-source: derived post: summary: Create a drillout unit tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created drillout unit content: application/json: schema: $ref: '#/components/schemas/DrilloutUnit' requestBody: content: application/json: schema: $ref: '#/components/schemas/DrilloutUnitPayload' description: Drillout Unit Payload required: true operationId: postV2DrilloutUnits x-operation-id-source: derived /v2/drillout_units/{id}: get: summary: Get a single drillout unit tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get drillout unit content: application/json: schema: $ref: '#/components/schemas/DrilloutUnit' parameters: - in: path name: id description: Drillout Unit ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like drillout_unit.name schema: items: type: string operationId: getV2DrilloutUnitsById x-operation-id-source: derived patch: summary: Update a drillout unit tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated drillout unit content: application/json: schema: $ref: '#/components/schemas/DrilloutUnit' requestBody: content: application/json: schema: $ref: '#/components/schemas/DrilloutUnitPayload' description: Drillout Unit Payload required: true operationId: patchV2DrilloutUnitsById x-operation-id-source: derived delete: summary: Delete a drillout unit tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Drillout Unit deleted parameters: - in: path name: id description: Drillout Unit ID required: true schema: type: integer operationId: deleteV2DrilloutUnitsById x-operation-id-source: derived /v2/drillout_units/clusters: get: summary: Get drillout units clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/DrilloutUnitCluster' parameters: - in: query name: ids description: List of drillout unit IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: well description: Search by Well ID schema: type: integer - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: integer - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2DrilloutUnitsClusters x-operation-id-source: derived /v2/wells: get: summary: List wells tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List wells content: application/json: schema: type: array items: $ref: '#/components/schemas/Well' parameters: - in: query name: ids description: List of well IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: drillout_unit description: Search by Drillout Unit ID schema: type: integer - in: query name: frac_fleet description: Search by Frac Fleet ID schema: type: integer - in: query name: status description: Search by well status schema: type: string enum: - unknown - active - paused - complete - idle - deleting - deletion_paused - archived - in: query name: state description: Search by well state schema: type: string enum: - permitted - planned - drilling - drilled_not_completed - completions - completed - drillouts - producing - intervention - in: query name: visibility description: Search by well visibility schema: type: string enum: - visible - visible_to_admin - deleted - template - in: query name: identifier description: Search by well identifier schema: type: string - in: query name: area description: Search by well area schema: type: string - in: query name: search description: Search by well name schema: type: string - in: query name: asset_id description: Filter by asset ID schema: type: integer - in: query name: fields description: Respond with only the given list of fields, like well.name schema: items: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: datetime - in: query name: last_active_drilling_before description: Return records where last_drilling_at is smaller than the given timestamp schema: type: datetime - in: query name: last_active_drilling_after description: Return records where last_drilling_at is greater than the given timestamp schema: type: datetime - in: query name: per_page description: Number of wells to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: company,status,visibility,name' schema: type: string enum: - company - rig - program - name - status - visibility - identifier - last_active_at default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: filter_by_completed_streams description: Search by wells that have completed app_streams schema: type: string - in: query name: include_completed_idle_paused_stream description: Add has_completed_idle_paused_stream attribute to response schema: type: boolean - in: query name: app_segment description: Add app segment value to find out completed streams schema: type: string enum: - drilling - completion - intervention - in: query name: app_stream_source_type description: Search by wells with app_streams by source_type schema: type: string enum: - drilling - drillout - frac - pumpdown - wireline - lithology - in: query name: existing_partial_reruns description: Filter by existing partial reruns schema: type: boolean - in: query name: distance description: Hash - latitude/longitude. Will return distance from point specified to well location for each well found. schema: longitude: float latitude: float example: longitude: 50.3435 latitude: -100.234 - in: query name: point_and_distance description: Filter by wells between geo point and distance in miles. Subject point is the center of the circle. schema: distance: float subject_point: type: object example: distance: 200.5 subject_point: latitude: 61 longitude: 61 - in: query name: polygon_coords description: Filter by wells within a polygon defined by an array of coordinate points. Minimum 3 points required. The polygon will be automatically closed. schema: items: type: object properties: latitude: type: float description: Latitude coordinate of the polygon point longitude: type: float description: Longitude coordinate of the polygon point example: value: - latitude: 29.0 longitude: -96.0 - latitude: 31.0 longitude: -96.0 - latitude: 31.0 longitude: -94.0 - latitude: 29.0 longitude: -94.0 - in: query name: well_start_before description: Filter by well_start_before in seconds timestamp schema: type: integer - in: query name: well_start_after description: Filter by well_start_after in seconds timestamp schema: type: integer - in: query name: is_asset_viewer description: Filter by custom_property is_asset_viewer schema: type: boolean - in: query name: archivation_date_before description: Filter by archivation_date_before in seconds timestamp schema: type: integer - in: query name: archivation_date_after description: Filter by archivation_date_after in seconds timestamp schema: type: integer - in: query name: archivation_performer_id description: Filter by archivation_performer_id schema: type: array - in: query name: intervention_unit_event_id description: Filter by intervention_unit_event_id schema: type: array - in: query name: intervention_unit_id description: Filter by intervention_unit_id schema: type: array operationId: getV2Wells x-operation-id-source: derived post: summary: Create a well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created well content: application/json: schema: $ref: '#/components/schemas/Well' requestBody: content: application/json: schema: $ref: '#/components/schemas/WellPayload' description: Well Payload required: true operationId: postV2Wells x-operation-id-source: derived /v2/wells/{id}: get: summary: Get a single well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get well content: application/json: schema: $ref: '#/components/schemas/Well' parameters: - in: path name: id description: Well ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like well.name schema: items: type: string operationId: getV2WellsById x-operation-id-source: derived patch: summary: Update a well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated well content: application/json: schema: $ref: '#/components/schemas/Well' requestBody: content: application/json: schema: $ref: '#/components/schemas/WellPayload' description: Well Payload required: true operationId: patchV2WellsById x-operation-id-source: derived delete: summary: Delete a well tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Well deleted parameters: - in: path name: id description: Well ID required: true schema: type: integer operationId: deleteV2WellsById x-operation-id-source: derived /v2/wells/clusters: get: summary: Get wells clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Well clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/WellCluster' parameters: - in: query name: ids description: List of well IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: drillout_unit description: Search by Drillout Unit ID schema: type: integer - in: query name: frac_fleet description: Search by Frac Fleet ID schema: type: integer - in: query name: status description: Search by well status schema: type: string enum: - unknown - active - paused - complete - idle - deleting - deletion_paused - archived - in: query name: state description: Search by well state schema: type: string enum: - permitted - planned - drilling - drilled_not_completed - completions - completed - drillouts - producing - intervention - in: query name: visibility description: Search by well visibility schema: type: string enum: - visible - visible_to_admin - deleted - template - in: query name: identifier description: Search by well identifier schema: type: string - in: query name: area description: Search by well area schema: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: integer - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2WellsClusters x-operation-id-source: derived /v2/frac_fleets: get: summary: List frac fleets tags: - Assets operationId: fracFleets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List frac fleets content: application/json: schema: type: array items: $ref: '#/components/schemas/FracFleet' parameters: - in: query name: ids description: List of frac fleet IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: current_pad description: Search by Pad ID where it is the current Pad for the Frac Fleet schema: type: integer - in: query name: search description: Search by frac fleet name schema: type: string - in: query name: app_key description: Return frac fleets that have been part of any product subscription that included the given app schema: type: string - in: query name: fields description: Respond with only the given list of fields, like frac fleet.name schema: items: type: string - in: query name: active description: Return records that have an active well schema: type: string - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: datetime - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: datetime - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: per_page description: Number of frac fleets to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name' schema: type: string enum: - name - company - last_active_at default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc post: summary: Create a frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created frac fleet content: application/json: schema: $ref: '#/components/schemas/FracFleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/FracFleetPayload' description: Frac Fleet Payload required: true operationId: postV2FracFleets x-operation-id-source: derived /v2/frac_fleets/{id}: get: summary: Get a single frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get frac fleet content: application/json: schema: $ref: '#/components/schemas/FracFleet' parameters: - in: path name: id description: Frac Fleet ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like frac_fleet.name schema: items: type: string operationId: getV2FracFleetsById x-operation-id-source: derived patch: summary: Update a frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated frac fleet content: application/json: schema: $ref: '#/components/schemas/FracFleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/FracFleetUpdatePayload' description: Frac Fleet Payload required: true operationId: patchV2FracFleetsById x-operation-id-source: derived delete: summary: Delete a frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Frac Fleet deleted parameters: - in: path name: id description: Frac Fleet ID required: true schema: type: integer operationId: deleteV2FracFleetsById x-operation-id-source: derived /v2/frac_fleets/{id}/pads: post: summary: Add one or more pads to a frac fleet, or set the current pad tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated frac fleet content: application/json: schema: $ref: '#/components/schemas/FracFleet' parameters: - in: path name: id description: Frac Fleet ID required: true requestBody: content: application/json: schema: {} description: ID of a Pad to set to be this Frac Fleet's current Pad operationId: postV2FracFleetsByIdPads x-operation-id-source: derived /v2/frac_fleets/{frac_fleet_id}/pads/{id}: delete: summary: Delete a pad from a frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated frac fleet content: application/json: schema: $ref: '#/components/schemas/FracFleet' parameters: - in: path name: frac_fleet_id description: Frac Fleet ID required: true - in: path name: id description: Pad ID required: true operationId: deleteV2FracFleetsByFracFleetIdPadsById x-operation-id-source: derived /v2/frac_fleets/{frac_fleet_id}/active_wells/well_cache: get: summary: Get well_cache records for the active wells on the frac fleet tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Well Cache Record content: application/json: schema: $ref: '#/components/schemas/WellCacheRecord' parameters: - in: query name: frac_fleet_id description: Frac Fleet ID schema: type: integer - in: header name: Serializer description: 'Controls how the data is serialized. Options: "completions-widget"' schema: type: string operationId: getV2FracFleetsByFracFleetIdActiveWellsWellCache x-operation-id-source: derived /v2/frac_fleets/clusters: get: summary: Get frac fleets clustered based on their location tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Clusters content: application/json: schema: type: array items: $ref: '#/components/schemas/FracFleetCluster' parameters: - in: query name: ids description: List of frac fleet IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: program description: Search by Program ID schema: type: integer - in: query name: pad description: Search by Pad ID schema: type: integer - in: query name: current_pad description: Search by Pad ID where it is the current Pad for the Frac Fleet schema: type: integer - in: query name: active_before description: Return records where last_active_at is smaller than the given timestamp schema: type: integer - in: query name: active_after description: Return records where last_active_at is greater than the given timestamp schema: type: integer - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: cluster_radius description: Defines how big clusters are returned. schema: type: float default: 1.0 operationId: getV2FracFleetsClusters x-operation-id-source: derived /v2/wirelines: get: summary: List wirelines tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: List wirelines content: application/json: schema: type: array items: $ref: '#/components/schemas/Wireline' parameters: - in: query name: ids description: List of wireline IDs to filter by schema: items: type: integer - in: query name: company description: Search by Company ID schema: type: integer - in: query name: search description: Search by wireline name schema: type: string - in: query name: fields description: Respond with only the given list of fields, like wireline.name schema: items: type: string - in: query name: lat_start description: 'Latitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: lat_end description: 'Latitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_start description: 'Longitude start. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: long_end description: 'Longitude end. Requires all parameters: lat_start, lat_end, long_start and long_end to be defined.' schema: type: float - in: query name: per_page description: Number of wirelines to list per page schema: type: integer - in: query name: sort description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name' schema: type: string enum: - name default: name - in: query name: order description: A sorting direction schema: type: string enum: - asc - desc default: asc operationId: getV2Wirelines x-operation-id-source: derived post: summary: Create a wireline tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created wireline content: application/json: schema: $ref: '#/components/schemas/Wireline' requestBody: content: application/json: schema: $ref: '#/components/schemas/WirelinePayload' description: Wireline Payload required: true operationId: postV2Wirelines x-operation-id-source: derived /v2/wirelines/{id}: get: summary: Get a single wireline tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Get wireline content: application/json: schema: $ref: '#/components/schemas/Wireline' parameters: - in: path name: id description: Wireline ID schema: type: integer required: true - in: query name: fields description: Respond with only the given list of fields, like wireline.name schema: items: type: string operationId: getV2WirelinesById x-operation-id-source: derived patch: summary: Update a wireline tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated wireline content: application/json: schema: $ref: '#/components/schemas/Wireline' requestBody: content: application/json: schema: $ref: '#/components/schemas/WirelinePayload' description: Wireline Payload required: true operationId: patchV2WirelinesById x-operation-id-source: derived delete: summary: Delete a wireline tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Wireline deleted parameters: - in: path name: id description: Wireline ID required: true schema: type: integer operationId: deleteV2WirelinesById x-operation-id-source: derived /v2/rig_templates: get: summary: List rig templates tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplateList' parameters: - in: query name: rig_id description: Filter rig templates by rig_id schema: type: integer format: int64 - in: query name: company_id description: Filter rig templates by company_id schema: type: integer format: int64 - in: query name: search description: Search rig templates by rig name schema: type: string operationId: getV2RigTemplates x-operation-id-source: derived post: summary: Create a rig template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created rig template content: application/json: schema: $ref: '#/components/schemas/RigTemplate' requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplatePayload' description: Rig Template Payload required: true operationId: postV2RigTemplates x-operation-id-source: derived /v2/rig_templates/aggregated_values: get: summary: Get aggregated values from rig template items tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: properties: data: type: array items: type: string operationId: getRigTemplatesAggregatedValues parameters: - in: query name: rig_template_id description: Rig Template ID (provide one of rig_id, well_id, or rig_template_id) schema: type: integer format: int64 - in: query name: rig_id description: Rig ID (provide one of rig_id, well_id, or rig_template_id) schema: type: integer format: int64 - in: query name: well_id description: Well ID (provide one of rig_id, well_id, or rig_template_id) schema: type: integer format: int64 - in: query name: rig_template_category_name description: Name of the rig template category required: true schema: type: string - in: query name: rig_template_item_field description: 'Field from rig template item data to aggregate (default: name)' schema: type: string /v2/rig_templates/{id}: get: summary: Show Rig Template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplate' parameters: - in: path name: id description: Rig Template ID required: true schema: type: integer format: int64 operationId: getV2RigTemplatesById x-operation-id-source: derived patch: summary: Update a Rig Template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated Rig Template content: application/json: schema: $ref: '#/components/schemas/RigTemplate' parameters: - in: path name: id description: Rig Template ID required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplatePayload' description: Rig Template Payload required: true operationId: patchV2RigTemplatesById x-operation-id-source: derived delete: summary: Delete a Rig Template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Rig Template deleted parameters: - in: path name: id description: Rig Template ID required: true schema: type: integer operationId: deleteV2RigTemplatesById x-operation-id-source: derived /v2/rig_template_categories: get: summary: List rig template categories tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategoryList' operationId: getV2RigTemplateCategories x-operation-id-source: derived post: summary: Create a rig template category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created rig template category content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategory' requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategoryPayload' description: Rig Template Category Payload required: true operationId: postV2RigTemplateCategories x-operation-id-source: derived /v2/rig_template_categories/{id}: get: summary: Show Rig Template Category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategory' parameters: - in: path name: id description: Rig Template Category ID required: true schema: type: integer format: int64 operationId: getV2RigTemplateCategoriesById x-operation-id-source: derived patch: summary: Update a Rig Template Category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated Rig Template Category content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategory' parameters: - in: path name: id description: Rig Template Category ID required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplateCategoryPayload' description: Rig Template Category Payload required: true operationId: patchV2RigTemplateCategoriesById x-operation-id-source: derived delete: summary: Delete a Rig Template Category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Rig Template Category deleted parameters: - in: path name: id description: Rig Template Category ID required: true schema: type: integer operationId: deleteV2RigTemplateCategoriesById x-operation-id-source: derived /v2/rig_templates/{rig_template_id}/rig_template_items: get: summary: List items of rig template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplateItemList' parameters: - in: path name: rig_template_id description: Rig Template ID required: true schema: type: integer format: int64 operationId: getV2RigTemplatesByRigTemplateIdRigTemplateItems x-operation-id-source: derived post: summary: Create a rig template item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created Rig Template Item content: application/json: schema: $ref: '#/components/schemas/RigTemplateItem' parameters: - in: path name: rig_template_id description: Rig Template ID required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplateItemPayload' description: Rig Template Item Payload required: true operationId: postV2RigTemplatesByRigTemplateIdRigTemplateItems x-operation-id-source: derived /v2/rig_templates/{rig_template_id}/rig_template_items/{id}: get: summary: Show Rig Template Item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': type: object description: Successful response content: application/json: schema: $ref: '#/components/schemas/RigTemplateItem' parameters: - in: path name: rig_template_id description: Rig Template ID required: true schema: type: integer format: int64 - in: path name: id description: Rig Template Item ID required: true schema: type: integer format: int64 operationId: getV2RigTemplatesByRigTemplateIdRigTemplateItemsById x-operation-id-source: derived patch: summary: Update Rig Template Item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated Rig Template Item content: application/json: schema: $ref: '#/components/schemas/RigTemplateItem' parameters: - in: path name: rig_template_id description: Rig Template ID required: true schema: type: integer format: int64 - in: path name: id description: Rig Template Item ID required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/RigTemplateItemPayload' description: Rig Template Item Payload required: true operationId: patchV2RigTemplatesByRigTemplateIdRigTemplateItemsById x-operation-id-source: derived delete: summary: Delete a Rig Template Item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Rig Template Item deleted parameters: - in: path name: rig_template_id description: Rig Template ID required: true schema: type: integer format: int64 - in: path name: id description: Rig Template Item ID required: true schema: type: integer format: int64 operationId: deleteV2RigTemplatesByRigTemplateIdRigTemplateItemsById x-operation-id-source: derived /v2/intervention_unit_templates: get: summary: List intervention unit templates tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateList' parameters: - in: query name: intervention_unit_id description: Filter templates by intervention unit ID schema: type: integer format: int64 - in: query name: company_id description: Filter templates by company ID schema: type: integer format: int64 - in: query name: search description: Search templates by intervention unit name schema: type: string operationId: getV2InterventionUnitTemplates x-operation-id-source: derived post: summary: Create an intervention unit template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created intervention unit template content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplate' requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplatePayload' required: true operationId: postV2InterventionUnitTemplates x-operation-id-source: derived /v2/intervention_unit_templates/aggregated_values: get: summary: Get aggregated values from intervention unit template items tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: properties: data: type: array items: type: string parameters: - in: query name: intervention_unit_template_id schema: type: integer format: int64 - in: query name: intervention_unit_id schema: type: integer format: int64 - in: query name: intervention_unit_event_id schema: type: integer format: int64 - in: query name: intervention_unit_template_category_name required: true schema: type: string - in: query name: intervention_unit_template_item_field schema: type: string operationId: getV2InterventionUnitTemplatesAggregatedValues x-operation-id-source: derived /v2/intervention_unit_templates/{id}: get: summary: Show an intervention unit template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplate' parameters: - in: path name: id required: true schema: type: integer format: int64 operationId: getV2InterventionUnitTemplatesById x-operation-id-source: derived patch: summary: Update an intervention unit template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated intervention unit template parameters: - in: path name: id required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplatePayload' required: true operationId: patchV2InterventionUnitTemplatesById x-operation-id-source: derived delete: summary: Delete an intervention unit template tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Intervention unit template deleted parameters: - in: path name: id required: true schema: type: integer format: int64 operationId: deleteV2InterventionUnitTemplatesById x-operation-id-source: derived /v2/intervention_unit_template_categories: get: summary: List intervention unit template categories tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateCategoryList' operationId: getV2InterventionUnitTemplateCategories x-operation-id-source: derived post: summary: Create an intervention unit template category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created intervention unit template category requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateCategoryPayload' required: true operationId: postV2InterventionUnitTemplateCategories x-operation-id-source: derived /v2/intervention_unit_template_categories/{id}: get: summary: Show an intervention unit template category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response parameters: - in: path name: id required: true schema: type: integer format: int64 operationId: getV2InterventionUnitTemplateCategoriesById x-operation-id-source: derived patch: summary: Update an intervention unit template category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated intervention unit template category parameters: - in: path name: id required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateCategoryPayload' required: true operationId: patchV2InterventionUnitTemplateCategoriesById x-operation-id-source: derived delete: summary: Delete an intervention unit template category tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Intervention unit template category deleted parameters: - in: path name: id required: true schema: type: integer format: int64 operationId: deleteV2InterventionUnitTemplateCategoriesById x-operation-id-source: derived /v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items: get: summary: List intervention unit template items tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateItemList' parameters: - in: path name: intervention_unit_template_id required: true schema: type: integer format: int64 operationId: getV2InterventionUnitTemplatesByInterventionUnitTemplateIdInterventionUnitTemplateItems x-operation-id-source: derived post: summary: Create an intervention unit template item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Created intervention unit template item parameters: - in: path name: intervention_unit_template_id required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateItemPayload' required: true operationId: postV2InterventionUnitTemplatesByInterventionUnitTemplateIdInterventionUnitTemplateItems x-operation-id-source: derived /v2/intervention_unit_templates/{intervention_unit_template_id}/intervention_unit_template_items/{id}: get: summary: Show an intervention unit template item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Successful response parameters: - in: path name: intervention_unit_template_id required: true schema: type: integer format: int64 - in: path name: id required: true schema: type: integer format: int64 operationId: getV2InterventionUnitTemplatesByInterventionUnitTemplateIdInterventionUnitTemplateItemsById x-operation-id-source: derived patch: summary: Update an intervention unit template item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Updated intervention unit template item parameters: - in: path name: intervention_unit_template_id required: true schema: type: integer format: int64 - in: path name: id required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/InterventionUnitTemplateItemPayload' required: true operationId: patchV2InterventionUnitTemplatesByInterventionUnitTemplateIdInterventionUnitTemplateItemsById x-operation-id-source: derived delete: summary: Delete an intervention unit template item tags: - Assets responses: '401': description: Authentication error content: application/json: schema: $ref: '#/components/schemas/AuthenticationError' '403': description: Authorization error content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' '404': description: Not found error content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '200': description: Intervention unit template item deleted parameters: - in: path name: intervention_unit_template_id required: true schema: type: integer format: int64 - in: path name: id required: true schema: type: integer format: int64 operationId: deleteV2InterventionUnitTemplatesByInterventionUnitTemplateIdInterventionUnitTemplateItemsById x-operation-id-source: derived components: schemas: WirelinePayload: properties: name: type: string example: name: My Wireline InterventionUnitTemplateItemList: properties: data: type: array items: $ref: '#/components/schemas/InterventionUnitTemplateItem' InterventionUnitTemplatePayload: properties: intervention_unit_template: type: object properties: intervention_unit_id: type: integer format: int64 company_id: type: integer format: int64 edr_provider_id: type: integer format: int64 column_mapper_template_channel_id: type: integer format: int64 settings: type: object intervention_unit_template_items_attributes: type: array items: properties: id: type: integer format: int64 intervention_unit_template_category_id: type: integer format: int64 data: type: object _destroy: type: boolean InterventionUnitTemplateList: properties: data: type: array items: $ref: '#/components/schemas/InterventionUnitTemplate' InterventionUnitTemplate: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 intervention_unit_id: type: integer format: int64 company_id: type: integer format: int64 settings: type: object created_by_id: type: integer format: int64 created_by_name: type: string last_edited_by_id: type: integer format: int64 last_updated_by_name: type: string created_at: type: string format: date-time updated_at: type: string format: date-time FracFleetCluster: properties: cid: type: integer center: type: string radius: type: float frac_fleet_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 frac_fleet_ids: - 123 - 124 RigTemplateCategoryIndex: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 name: type: string settings: type: object schema: type: object example: id: 12345 type: rig_template_category attributes: id: 12345 name: Category Name settings: {} schema: {} InterventionUnitTemplateItemPayload: properties: intervention_unit_template_item: type: object properties: intervention_unit_template_category_id: type: integer format: int64 parent_intervention_unit_template_item_id: type: integer format: int64 data: type: object nested_intervention_unit_template_items_attributes: type: array items: properties: id: type: integer format: int64 intervention_unit_template_category_id: type: integer format: int64 data: type: object _destroy: type: boolean RigTemplateList: properties: data: type: array items: $ref: '#/components/schemas/RigTemplateIndex' FracFleetUpdatePayload: properties: name: type: string contract_data: type: object example: name: Updating Frac Fleet program_id: 9232 billing_company_ids: - 456 - 1234 - 5678 contract_data: something: value AuthenticationError: required: - code - message properties: code: type: integer format: int32 message: type: string example: code: 401 message: Missing authentication. Please try again. ProgramPayload: properties: name: type: string example: name: My Program PadDetails: example: data: - id: '7232' type: well attributes: asset_id: 8823 name: My Pad Well 1 status: active relationships: app_streams: data: - id: '1' type: app_stream - id: '7' type: app_stream - id: '11392' type: well attributes: asset_id: 19423 name: My Pad Well 2 status: active relationships: app_streams: data: - id: '17' type: app_stream included: - id: '1' type: app_stream attributes: id: '1' status: complete segment: drilling source_type: drilling log_type: time first_active_at: '2020-01-01T00:00:00.000Z' last_active_at: '2020-01-01T00:00:00.000Z' - id: '7' type: app_stream attributes: id: '1' status: active segment: completion source_type: frac log_type: time first_active_at: '2020-01-01T00:00:00.000Z' last_active_at: '2020-01-01T00:00:00.000Z' - id: '17' type: app_stream attributes: id: '1' status: active segment: drilling source_type: drilling log_type: time first_active_at: '2020-01-01T00:00:00.000Z' last_active_at: '2020-01-01T00:00:00.000Z' InterventionUnitTemplateItem: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 intervention_unit_template_id: type: integer format: int64 intervention_unit_template_category_id: type: integer format: int64 parent_intervention_unit_template_item_id: type: integer format: int64 data: type: object items: type: array created_at: type: string format: date-time updated_at: type: string format: date-time RigTemplateItem: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 rig_template_id: type: integer format: int64 rig_template_category_id: type: integer format: int64 parent_rig_template_item_id: type: integer format: int64 data: type: object created_at: type: string format: date-time updated_at: type: string format: date-time items: type: array rig_template_category: type: object properties: data: $ref: '#/components/schemas/RigTemplateCategory' example: id: 12345 type: rig_template_item attributes: id: 12345 rig_template_id: 1 rig_template_category_id: 2 parent_rig_template_item_id: null data: key: value created_at: '2025-12-17T10:00:00Z' updated_at: '2025-12-17T10:00:00Z' items: [] rig_template_category: data: id: 2 type: rig_template_category attributes: id: 2 name: Category Name settings: key: value schema: key: value RigTemplateItemIndex: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 rig_template_id: type: integer format: int64 rig_template_category_id: type: integer format: int64 parent_rig_template_item_id: type: integer format: int64 data: type: object items: type: array example: id: 12345 type: rig_template_item attributes: id: 12345 rig_template_id: 1 rig_template_category_id: 2 parent_rig_template_item_id: null data: {} items: [] ProgramCluster: properties: cid: type: integer center: type: string radius: type: float program_ids: type: array asset_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 program_ids: - 123 - 124 asset_ids: - 123 - 124 Program: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string example: id: 7926 type: program attributes: name: My Program relationships: company: data: id: 823 type: company InterventionUnitTemplateCategoryPayload: properties: intervention_unit_template_category: type: object properties: name: type: string settings: type: object schema: type: object Rerun: required: - id - type properties: id: type: string type: type: string attributes: type: object properties: asset_id: type: integer format: int64 primary: type: boolean created_at: type: datetime updated_at: type: datetime source_asset: type: boolean settings: type: object relationships: type: object example: id: '1243' type: rerun attributes: asset_id: 123 primary: null created_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00.000Z' source_asset: true settings: {} relationships: {} Wireline: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string example: id: 1184 type: wireline attributes: name: My Wireline relationships: company: data: id: 823 type: company AncestorsResponse: example: data: id: 123 attributes: ancestor_ids: - 121 - 122 RigTemplateCategory: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 name: type: string settings: type: object schema: type: object created_at: type: string format: date-time updated_at: type: string format: date-time example: id: 12345 type: rig_template_category attributes: id: 12345 name: Category Name settings: {} schema: {} created_at: '2025-12-17T10:00:00Z' updated_at: '2025-12-17T10:00:00Z' RigTemplateCategoryList: properties: data: type: array items: $ref: '#/components/schemas/RigTemplateCategoryIndex' RigTemplateItemList: properties: data: type: array items: $ref: '#/components/schemas/RigTemplateItemIndex' RigPayload: properties: name: type: string edr_provider: type: string billing_company_ids: type: array settings: type: object example: name: My Rig edr_provider: EDR billing_company_ids: - 9595 - 4129 PadPayload: properties: name: type: string program: type: integer example: name: My Pad program_id: 482 drillout_unit_id: 923 AssetResolver: properties: programs: type: array items: properties: ? '{:properties=>##:object, :properties=>##:integer, :format=>:string}>, :type=>#:string}>, :attributes=>#:object, :properties=>##:int64}>}>}>}>}>}>}' : type: object properties: id: type: integer format: string type: type: string attributes: type: object properties: asset_id: type: int64 rigs: type: array items: properties: ? '{:properties=>##:object, :properties=>##:integer, :format=>:string}>, :type=>#:string}>, :attributes=>#:object, :properties=>##:int64}>}>}>}>}>}>}' : type: object properties: id: type: integer format: string type: type: string attributes: type: object properties: asset_id: type: int64 wells: type: array items: properties: ? '{:properties=>##:object, :properties=>##:integer, :format=>:string}>, :type=>#:string}>, :attributes=>#:object, :properties=>##:int64}>}>}>}>}>}>}' : type: object properties: id: type: integer format: string type: type: string attributes: type: object properties: asset_id: type: int64 example: programs: - data: id: '8283' type: program attributes: asset_id: 5547 rigs: - data: id: '1149' type: rig attributes: asset_id: 10592 wells: - data: id: '93' type: well attributes: asset_id: 98283 DrilloutUnitCluster: properties: cid: type: integer center: type: string radius: type: float drillout_unit_ids: type: array well_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 drillout_unit_ids: - 123 - 124 well_ids: - 123 - 124 Rig: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string edr_provider: type: string settings: type: object relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string billing_companies: type: object properties: data: type: array example: id: 1184 type: rig attributes: name: My Rig edr_provider: some provider settings: {} relationships: company: data: id: 823 type: company billing_companies: data: - id: 923 type: company - id: 928 type: company program: data: id: 23 type: program active_well: data: id: 123092 type: well last_active_well: data: id: 123092 type: well Asset: required: - id - type properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: string format: uuid name: type: string visible_rerun_id: type: integer description: If the asset has been rerun and the rerun has been set visible, the ID of the rerun asset is returned here. merging_rerun_as_source: type: boolean merging_rerun_as_target: type: boolean running_rerun_as_source: type: boolean running_rerun_as_target: type: boolean source_well: type: object description: If the asset has been created during rerun this property will contain mane and ID of source well properties: id: type: integer name: type: string rig_changed_at: type: datetime format: timestamp description: Datetime when the rig was last changed. Returned for Asset::Well. country: type: string relationships: type: object example: id: 7926 type: asset attributes: company_id: 123 company_name: My Company type: Asset::Well asset_type: well timezone: America/Chicago lon_lat: longitude: -103.0 latitude: 32.0 created_at: '2020-01-01T00:00:00.000Z' last_active_at: '2020-01-01T00:00:00.000Z' status: active state: drilling visibility: visible rig_changed_at: '2026-06-20T20:01:35.000Z' name: The Best Well parent_asset_id: 12345 parent_asset_name: A Big Rig root_asset_id: 123 root_asset_name: The Permian Program api_number: 00-111-22222 county: Eddy country: United States basin: Permian area: Midland string_design: '4' merging_rerun_as_source: false merging_rerun_as_target: true running_rerun_as_source: false running_rerun_as_target: false top_hole: raw: 32.000000, -103.000000 coordinates: - 32.0 - -103.0 bottom_hole: {} contractor_name: The Contractor directional_driller: The DD mud_company: The Mud Company customer_well_id: customer-id-909488abtx original_well_id: '4444' original_well_created_at: '2020-01-01T00:00:00.000Z' settings: day_shift_start_time: 06:00 spud_release: [] last_mongo_refresh: '2020-01-01T00:00:00.000Z' stats: spud_at: '2020-01-01T00:00:00.000Z' well_start: 100 well_end: 1000 total_cost: 10000 total_time: 999 total_depth: 10000 first_active_at: 149900000 witsml_data_frequency: 5 source_well: id: 12345 name: Rerun Source Well custom_properties: anything: goes relationships: company: data: id: '123' type: company parent_asset: data: id: '12345' type: asset active_child: data: id: '54321' type: asset last_active_child: data: id: '54321' type: asset InterventionUnitTemplateCategoryList: properties: data: type: array items: $ref: '#/components/schemas/InterventionUnitTemplateCategory' RigCluster: properties: cid: type: integer center: type: string radius: type: float rig_ids: type: array asset_ids: type: array active_well_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 rig_ids: - 123 - 124 asset_ids: - 123 - 124 active_well_ids: - 123 - 124 InterventionUnitTemplateCategory: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 name: type: string settings: type: object schema: type: object created_at: type: string format: date-time updated_at: type: string format: date-time PadCluster: properties: cid: type: integer center: type: string radius: type: float pad_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 pad_ids: - 123 - 124 WellPayload: properties: name: type: string identifier: type: string status: type: string state: type: string visibility: type: string area: type: string custom_properties: type: object settings: type: object qc_by: type: integer qc_at: type: integer format: timestamp rig_classification: type: string enum: - land - platform - floating floating_vessel_subtype: type: string enum: - semi_submersible - drill_ship platform_rig_type: type: string enum: - fixed_platform - jackup_rig customer_well_id: type: string alternative_names: type: array alternative_wellbore_names: type: array wellbore_name: type: string example: name: My Well identifier: 42-501-20130-03-00 status: active state: drilling visibility: visible area: San Pedro custom_properties: key: value company_id: 1 pad_id: 2 rig_id: 3 program_id: 4 drillout_unit_id: 5 customer_well_id: customer-id-909488abtx settings: county: '' basin: '' api_number: 1234 timezone: America/New_York drilling_afe_number: '' contractor_name: '' directional_driller: '' mud_company: '' string_design: 4 target_formation: '' day_shift_start_time: 8 spud_release: rig_up: '1' spud: '1' release: '1' id: 10 top_hole: raw: 40,20 coordinates: - 40 - 20 bottom_hole: raw: 40,20 coordinates: - 40 - 20 lon_lat: longitude: 40 latitude: 20 qc_by: 123 qc_at: 1433487600 rig_classification: floating floating_vessel_subtype: semi_submersible platform_rig_type: fixed_platform alternative_names: - Name - New alternative_wellbore_names: - Wellbore Name - New Wellbore wellbore_name: Wellbore1 TypeWell: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 subject_well_id: type: integer format: int64 offset_well_id: type: integer format: int64 subject_well_asset_id: type: integer format: int64 offset_well_asset_id: type: integer format: int64 example: id: 555 type: type_well attributes: id: 555 subject_well_id: 123 offset_well_id: 456 subject_well_asset_id: 7527348 offset_well_asset_id: 12347575 FracFleet: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string current_pad_id: type: integer format: int64 relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string billing_companies: type: object properties: data: type: array program: type: object properties: data: type: object properties: id: type: string type: type: string pads: type: object properties: data: type: array example: id: 1184 type: frac_fleet attributes: name: My Frac Fleet current_pad_id: 772 relationships: company: data: id: 823 type: company billing_companies: data: - id: 923 type: company - id: 928 type: company program: data: id: 9923 type: program pads: data: - id: 772 type: pad included: - id: 9923 type: program attributes: name: My Program - id: 902 type: pad_frac_fleet attributes: current: true last_current_at: '2020-01-01T00:00:00.000Z' pad: id: 8834 name: My Pad created_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00.000Z' frac_fleet: id: 9642 name: My Frac Fleet created_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00.000Z' - id: 923 type: company attributes: name: My Program - id: 928 type: company attributes: name: My Program AssetAutocomplete: properties: data: type: array example: data: - Enclave Oil Rig - San Francisco - Enclave Oil Rig, Dock RigTemplatePayload: properties: rig_template: type: object properties: rig_id: type: integer format: int64 company_id: type: integer format: int64 edr_provider_id: type: integer format: int64 column_mapper_template_channel_id: type: integer format: int64 settings: type: object rig_template_items_attributes: type: array items: properties: id: type: integer format: int64 description: Required for updates, omit for new items rig_template_category_id: type: integer format: int64 data: type: object _destroy: type: boolean description: Set to true to delete the item (only for updates) example: rig_template: rig_id: 1 company_id: 100 settings: {} rig_template_items_attributes: - rig_template_category_id: 2 data: key: value AuthorizationError: required: - code - message properties: code: type: integer format: int32 message: type: string example: code: 403 message: Access denied DrilloutUnitPayload: properties: name: type: string pad_id: type: integer well_id: type: integer billing_company_ids: type: array example: name: My Drillout Unit pad_id: 823 well_id: 22812 billing_company_ids: - 456 - 45 - 98 Well: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string identifier: type: string status: type: string state: type: string visibility: type: string area: type: string custom_properties: type: object settings: type: object stats: type: object last_active_at: type: datetime format: timestamp last_drilling_at: type: datetime format: timestamp qc_by: type: integer qc_at: type: integer format: timestamp rig_classification: type: string enum: - land - platform - floating floating_vessel_subtype: type: string enum: - semi_submersible - drill_ship platform_rig_type: type: string enum: - fixed_platform - jackup_rig rerun: type: boolean rig_changed_at: type: datetime format: timestamp description: Datetime when the rig was last changed. customer_well_id: type: string air_gap: type: float ground_elevation: type: float water_depth: type: float wellbore_name: type: string alternative_names: type: array alternative_wellbore_names: type: array ready_for_archive: type: object properties: ready_for_archive: type: boolean ready_to_arhive_errors: type: array items: type: string relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string program: type: object properties: data: type: object properties: id: type: string type: type: string pad: type: object properties: data: type: object properties: id: type: string type: type: string rig: type: object properties: data: type: object properties: id: type: string type: type: string drillout_unit: type: object properties: data: type: object properties: id: type: string type: type: string example: id: 1184 type: well attributes: name: My Well status: active state: drilling rig_changed_at: '2026-06-20T20:01:35.000Z' customer_well_id: customer-id-909488abtx rerun: false alternative_names: - Name - New alternative_wellbore_names: - Wellbore Name - New Wellbore ready_for_archive: ready_for_archive: false ready_to_arhive_errors: - Well status is not in complete, idle - Well was updated recently relationships: company: data: id: 823 type: company program: data: id: 23 type: program pad: data: id: 3909 type: rig rig: data: id: 6621 type: rig drillout_unit: data: id: 923 type: drillout_unit RigTemplate: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 rig_id: type: integer format: int64 company_id: type: integer format: int64 settings: type: object created_at: type: string format: date-time updated_at: type: string format: date-time created_by_id: type: integer format: int64 created_by_name: type: string last_edited_by_id: type: integer format: int64 last_updated_by_name: type: string edr_provider_id: type: integer format: int64 column_mapper_template_channel_id: type: integer format: int64 rig_template_items: type: object properties: data: type: array items: $ref: '#/components/schemas/RigTemplateItem' relationships: type: object properties: created_by: type: object properties: data: type: object properties: id: type: integer format: int64 type: type: string last_edited_by: type: object properties: data: type: object properties: id: type: integer format: int64 type: type: string example: id: 12345 type: rig_template attributes: id: 12345 rig_id: 1 company_id: 100 settings: {} created_at: '2025-12-17T10:00:00Z' updated_at: '2025-12-17T10:00:00Z' created_by_id: 100 created_by_name: John Doe (john.doe@example.com) last_edited_by_id: 100 last_updated_by_name: John Doe (john.doe@example.com) rig_template_items: data: [] relationships: created_by: data: id: 100 type: user last_edited_by: data: id: 100 type: user NotFoundError: required: - code - message properties: code: type: integer format: int32 message: type: string example: code: 404 message: Not found RigTemplateIndex: properties: id: type: integer format: int64 type: type: string attributes: type: object properties: id: type: integer format: int64 rig_id: type: integer format: int64 company_id: type: integer format: int64 settings: type: object created_by_id: type: integer format: int64 created_by_name: type: string last_edited_by_id: type: integer format: int64 last_updated_by_name: type: string edr_provider_id: type: integer format: int64 column_mapper_template_channel_id: type: integer format: int64 example: id: 12345 type: rig_template attributes: id: 12345 rig_id: 1 company_id: 100 settings: {} created_by_id: 100 created_by_name: John Doe (john.doe@example.com) last_edited_by_id: 100 last_updated_by_name: John Doe (john.doe@example.com) edr_provider_id: null column_mapper_template_channel_id: null DrilloutUnit: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string program: type: object properties: data: type: object properties: id: type: string type: type: string pad: type: object properties: data: type: object properties: id: type: string type: type: string well: type: object properties: data: type: object properties: id: type: string type: type: string billing_companies: type: object properties: data: type: array example: id: 9232 type: drillout_unit attributes: name: My Drillout Unit relationships: company: data: id: 823 type: company program: data: id: 23 type: program pad: data: id: 1094 type: pad well: data: id: 123092 type: well billing_companies: data: - id: 923 type: company - id: 928 type: company RigTemplateCategoryPayload: properties: rig_template_category: type: object properties: name: type: string settings: type: object schema: type: object example: rig_template_category: name: Category Name settings: {} schema: {} Pad: required: - id properties: id: type: integer format: int64 attributes: type: object properties: id: type: string format: uuid name: type: string current_frac_fleet_id: type: integer format: int64 last_active_at: type: string format: date-time active: type: boolean parent_frac_fleet_id: type: integer format: int64 current: type: boolean relationships: type: object properties: company: type: object properties: data: type: object properties: id: type: string type: type: string program: type: object properties: data: type: object properties: id: type: string type: type: string drillout_unit: type: object properties: data: type: object properties: id: type: string type: type: string pad_frac_fleets: type: object properties: data: type: array wells: type: object properties: data: type: array active_wells: type: object properties: data: type: array example: id: 9210 type: pad attributes: name: My Pad current_frac_fleet_id: 782 last_active_at: '2020-01-01T00:00:00.000Z' active: true parent_frac_fleet_id: 782 current: true relationships: company: data: id: 823 type: company program: data: id: 9913 type: program drillout_unit: data: id: 273 type: drillout_unit pad_frac_fleets: data: - id: 923 type: pad_frac_fleet - id: 928 type: pad_frac_fleet wells: data: - id: 16771 type: well - id: 16919 type: well - id: 17231 type: well active_wells: data: - id: 16771 type: well - id: 16919 type: well included: - id: 902 type: pad_frac_fleet attributes: current: true last_current_at: '2020-01-01T00:00:00.000Z' pad: id: 8834 name: My Pad created_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00.000Z' frac_fleet: id: 9642 name: My Frac Fleet created_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00.000Z' - id: 16771 type: well attributes: name: 'Well #1' - id: 16919 type: well attributes: name: 'Well #2' - id: 17231 type: well attributes: name: 'Well #3' - id: 273 type: drillout_unit attributes: name: 'Drillout Unit #1' RigTemplateItemPayload: properties: rig_template_item: type: object properties: parent_rig_template_item_id: type: integer format: int64 data: type: object nested_rig_template_items_attributes: type: array items: properties: parent_rig_template_item_id: type: integer format: int64 data: type: object example: rig_template_item: parent_rig_template_item_id: null data: key: value nested_rig_template_items_attributes: - data: key: child_value FracFleetPayload: properties: name: type: string example: name: My Frac Fleet program_id: 9232 WellCluster: properties: cid: type: integer center: type: string radius: type: float well_ids: type: array asset_ids: type: array example: cid: 1 center: longitude: 45.4845 latitude: 46.3234 radius: 0.282855334465 well_ids: - 123 - 124 asset_ids: - 123 - 124 WellCacheRecord: example: asset_id: 1 well_id: 2 company_id: 1 timestamp: 149900000 last_active_at: 149900000 location: type: Point coordinates: longitude: 45.4845 latitude: 46.3234 corva#wits: data: state: Drilling hole_depth: 1234 bit_depth: 1234 corva#data-drillstring: {} securitySchemes: api_key: type: apiKey name: authorization in: header