openapi: 3.1.0 info: title: ComboCurve REST v1 custom-columns v1 projects API version: v1 description: 'ComboCurve REST API for oil & gas well forecasting, type curves, production data, reserves and economics. Base URL https://api.combocurve.com. Authentication requires two headers: a signed bearer token (Authorization) generated from a Service Account Key, and an x-api-key. Derived by API Evangelist from the official public ComboCurve Postman collection.' contact: name: ComboCurve API Support url: https://forum.api.combocurve.com/ servers: - url: https://api.combocurve.com description: Production security: - apiKeyAuth: [] bearerAuth: [] tags: - name: v1 projects description: projects operations paths: /v1/projects: head: operationId: head-projects summary: head-projects tags: - v1 projects description: Returns metadata about the existing project documents. parameters: - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-projects summary: get-projects tags: - v1 projects description: Returns a list of project documents. parameters: - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-projects summary: post-projects tags: - v1 projects description: Inserts a list of project documents. requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{id}: delete: operationId: delete-project-by-id summary: delete-project-by-id tags: - v1 projects description: Delete the project document that matches the given id. parameters: - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-project-by-id summary: get-project-by-id tags: - v1 projects description: Returns the project document that matches the given id. parameters: - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/company-wells: delete: operationId: delete-project-company-wells summary: delete-project-company-wells tags: - v1 projects description: Remove the company wells documents that match the given filters from the projectId scope. parameters: - name: projectId in: path required: true schema: type: string - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: id in: query required: false schema: type: string description: filter by id responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded head: operationId: head-project-company-wells summary: head-project-company-wells tags: - v1 projects description: Returns metadata about the existing company well documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: api10 in: query required: false schema: type: string description: filter by api10 - name: api12 in: query required: false schema: type: string description: filter by api12 - name: county in: query required: false schema: type: string description: filter by county - name: state in: query required: false schema: type: string description: filter by state - name: wellName in: query required: false schema: type: string description: filter by wellName - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: inptID in: query required: false schema: type: string description: filter by inptID - name: api14 in: query required: false schema: type: string description: filter by api14 - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: currentOperator in: query required: false schema: type: string description: filter by dataSource responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-project-company-wells summary: get-project-company-wells tags: - v1 projects description: Returns a list of company well documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: api10 in: query required: false schema: type: string description: filter by api10 - name: api12 in: query required: false schema: type: string description: filter by api12 - name: county in: query required: false schema: type: string description: filter by county - name: state in: query required: false schema: type: string description: filter by state - name: wellName in: query required: false schema: type: string description: filter by wellName - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: inptID in: query required: false schema: type: string description: filter by inptID - name: api14 in: query required: false schema: type: string description: filter by api14 - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: currentOperator in: query required: false schema: type: string description: filter by dataSource responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-project-company-wells summary: post-project-company-wells tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: dataSource: type: string chosenID: type: string id: type: string projectCustomHeader: type: string projectCustomHeader1: type: string projectCustomHeader2: type: string projectCustomHeader3: type: string projectCustomHeader4: type: string projectCustomHeader5: type: string projectCustomHeader6: type: string projectCustomHeader7: type: string projectCustomHeader8: type: string projectCustomHeader9: type: string projectCustomHeader10: type: string projectCustomHeader11: type: string projectCustomHeader12: type: string projectCustomHeader13: type: string projectCustomHeader14: type: string projectCustomHeader15: type: string projectCustomHeader16: type: string projectCustomHeader17: type: string projectCustomHeader18: type: string projectCustomHeader19: type: string projectCustomHeader20: type: string projectCustomHeader21: type: string projectCustomHeader22: type: string projectCustomHeader23: type: string projectCustomHeader24: type: string projectCustomHeader25: type: string projectCustomHeader26: type: string projectCustomHeader27: type: string projectCustomHeader28: type: string projectCustomHeader29: type: string projectCustomHeader30: type: string projectCustomHeader31: type: string projectCustomHeader32: type: string projectCustomHeader33: type: string projectCustomHeader34: type: string projectCustomHeader35: type: string projectCustomHeader36: type: string projectCustomHeader37: type: string projectCustomHeader38: type: string projectCustomHeader39: type: string projectCustomHeader40: type: string projectCustomHeader41: type: string projectCustomHeader42: type: string projectCustomHeader43: type: string projectCustomHeader44: type: string projectCustomHeader45: type: string projectCustomHeader46: type: string projectCustomHeader47: type: string projectCustomHeader48: type: string projectCustomHeader49: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-project-company-wells summary: patch-project-company-wells tags: - v1 projects description: Updates only the custom project headers for existing wells in the project parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: dataSource: type: string chosenID: type: string id: type: string projectCustomHeader: type: string projectCustomHeader1: type: string projectCustomHeader2: type: string projectCustomHeader3: type: string projectCustomHeader4: type: string projectCustomHeader5: type: string projectCustomHeader6: type: string projectCustomHeader7: type: string projectCustomHeader8: type: string projectCustomHeader9: type: string projectCustomHeader10: type: string projectCustomHeader11: type: string projectCustomHeader12: type: string projectCustomHeader13: type: string projectCustomHeader14: type: string projectCustomHeader15: type: string projectCustomHeader16: type: string projectCustomHeader17: type: string projectCustomHeader18: type: string projectCustomHeader19: type: string projectCustomHeader20: type: string projectCustomHeader21: type: string projectCustomHeader22: type: string projectCustomHeader23: type: string projectCustomHeader24: type: string projectCustomHeader25: type: string projectCustomHeader26: type: string projectCustomHeader27: type: string projectCustomHeader28: type: string projectCustomHeader29: type: string projectCustomHeader30: type: string projectCustomHeader31: type: string projectCustomHeader32: type: string projectCustomHeader33: type: string projectCustomHeader34: type: string projectCustomHeader35: type: string projectCustomHeader36: type: string projectCustomHeader37: type: string projectCustomHeader38: type: string projectCustomHeader39: type: string projectCustomHeader40: type: string projectCustomHeader41: type: string projectCustomHeader42: type: string projectCustomHeader43: type: string projectCustomHeader44: type: string projectCustomHeader45: type: string projectCustomHeader46: type: string projectCustomHeader47: type: string projectCustomHeader48: type: string projectCustomHeader49: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/company-wells/{id}: get: operationId: get-project-company-well-by-id summary: get-project-company-well-by-id tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/daily-productions: delete: operationId: delete-project-daily-productions summary: delete-project-daily-productions tags: - v1 projects description: Delete the daily productions documents that match the given filters. parameters: - name: projectId in: path required: true schema: type: string - name: well in: query required: false schema: type: string description: (Required) filter by well ID - name: startDate in: query required: false schema: type: string description: filter by startDate - name: endDate in: query required: false schema: type: string description: filter by endDate responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded head: operationId: head-projects-daily-productions summary: head-projects-daily-productions tags: - v1 projects description: Returns metadata about the existing daily production documents in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-projects-daily-productions summary: get-projects-daily-productions tags: - v1 projects description: Returns a list of daily production documents in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-projects-daily-productions summary: post-projects-daily-productions tags: - v1 projects description: Upserts a list of daily production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date bottomHolePressure: type: number casingHeadPressure: type: number choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string flowlinePressure: type: number gas: type: number gasInjection: type: number gasLiftInjectionPressure: type: number hoursOn: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number tubingHeadPressure: type: number vesselSeparatorPressure: type: number water: type: number waterInjection: type: number well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-projects-daily-productions summary: put-projects-daily-productions tags: - v1 projects description: Upserts a list of daily production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date bottomHolePressure: type: number casingHeadPressure: type: number choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string flowlinePressure: type: number gas: type: number gasInjection: type: number gasLiftInjectionPressure: type: number hoursOn: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number tubingHeadPressure: type: number vesselSeparatorPressure: type: number water: type: number waterInjection: type: number well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-projects-daily-productions summary: patch-projects-daily-productions tags: - v1 projects description: Patch a list of daily production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date bottomHolePressure: type: number casingHeadPressure: type: number choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string flowlinePressure: type: number gas: type: number gasInjection: type: number gasLiftInjectionPressure: type: number hoursOn: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number tubingHeadPressure: type: number vesselSeparatorPressure: type: number water: type: number waterInjection: type: number well: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts: head: operationId: head-forecasts summary: head-forecasts tags: - v1 projects description: Returns metadata about the existing forecast documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: runDate in: query required: false schema: type: string description: filter by runDate - name: type in: query required: false schema: type: string description: filter by type - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-forecasts summary: get-forecasts tags: - v1 projects description: Returns a list of forecast documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: runDate in: query required: false schema: type: string description: filter by runDate, can be used for incremental pull - name: type in: query required: false schema: type: string description: filter by type - name: tag in: query required: false schema: type: string description: filter by tag - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-forecasts summary: post-forecasts tags: - v1 projects description: Inserts a list of forecasts documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string type: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{id}: get: operationId: get-forecast-by-id summary: get-forecast-by-id tags: - v1 projects description: Returns the forecast document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-forecast-by-id summary: delete-forecast-by-id tags: - v1 projects description: Delete the Forecast that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: deleteTypeCurves in: query required: false schema: type: string description: deletes all type-curves associated with the forecastId responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-forecast summary: patch-forecast tags: - v1 projects description: Updates Forecast. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: name: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{id}/wells: post: operationId: post-wells-to-forecast summary: post-wells-to-forecast tags: - v1 projects description: Inserts a list of well into a forecast. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: wellIds: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/parameters/{wellId}/{phase}/{series}: post: operationId: post-projects-forecast-segment-parameters summary: post-projects-forecast-segment-parameters tags: - v1 projects description: Inserts a list of segments in a forecast for a defined well, phase, and series. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: wellId in: path required: true schema: type: string - name: phase in: path required: true schema: type: string - name: series in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: segmentType: type: string startDate: type: string endDate: type: string qStart: type: number qEnd: type: number diEffSec: type: number b: type: number targetDSwEffSec: type: number flatValue: type: number slope: type: number realizedDEffSw: type: number d: type: number dEff: type: number calculatedField: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-projects-forecast-segment-parameters summary: put-projects-forecast-segment-parameters tags: - v1 projects description: Updates all segments with provided list of new segments for a defined well, phase, and series. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: wellId in: path required: true schema: type: string - name: phase in: path required: true schema: type: string - name: series in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: segmentType: type: string startDate: type: string endDate: type: string qStart: type: number qEnd: type: number diEffSec: type: number b: type: number targetDSwEffSec: type: number flatValue: type: number slope: type: number realizedDEffSw: type: number d: type: number dEff: type: number calculatedField: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-projects-forecast-segment-parameters summary: delete-projects-forecast-segment-parameters tags: - v1 projects description: Removes all of the segments for a defined well, phase, and series parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: wellId in: path required: true schema: type: string - name: phase in: path required: true schema: type: string - name: series in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/parameters: put: operationId: put-version-two-projects-forecast-segment-parameters summary: put-version-two-projects-forecast-segment-parameters tags: - v1 projects description: Updates multiple forecast segments for multiple wells, phases, and series in a single request. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: well: type: string forecastType: type: string phase: type: string series: type: string segments: type: array items: type: object properties: segmentType: type: string startDate: type: string endDate: type: string qStart: type: number qEnd: type: number diEffSec: type: number b: type: number targetDSwEffSec: type: number flatValue: type: number slope: type: number realizedDEffSw: type: number d: type: number dEff: type: number calculatedField: type: string dataFrequency: type: string basePhase: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/aries: head: operationId: head-aries-forecast summary: head-aries-forecast tags: - v1 projects description: Returns metadata about the aries forecast documents scoped to projectId project and forecastId forecast. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-aries-forecast summary: get-aries-forecast tags: - v1 projects description: Returns a list of aries forecast scoped to projectId project and forecastId forecast. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: well in: query required: false schema: type: string description: filter by well - name: pSeries in: query required: false schema: type: string description: filter by pSeries - name: startDate in: query required: false schema: type: string description: filter by startDate, can be used for incremental pull - name: selectedIdKey in: query required: false schema: type: string description: filter by selectedIdKey - name: endingCondition in: query required: false schema: type: string description: filter by endingCondition - name: forecastUnit in: query required: false schema: type: string description: filter by forecastUnit - name: toLife in: query required: false schema: type: string description: filter by toLife - name: dataResolution in: query required: false schema: type: string description: filter by dataResolution - name: includeZeroForecast in: query required: false schema: type: string description: filter by includeZeroForecast - name: forecastStartToLatestProd in: query required: false schema: type: string description: filter by forecastStartToLatestProd - name: forecastHistoryMatch in: query required: false schema: type: string description: filter by forecastHistoryMatch responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/outputs: head: operationId: head-forecast-outputs summary: head-forecast-outputs tags: - v1 projects description: Returns metadata about the existing forecast data documents scoped to projectId project and forecastId forecast. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: forecastedAt in: query required: false schema: type: string description: filter by forecastedAt - name: phase in: query required: false schema: type: string description: filter by phase - name: reviewedAt in: query required: false schema: type: string description: filter by reviewedAt - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-forecast-outputs summary: get-forecast-outputs tags: - v1 projects description: Returns a list of forecast data documents scoped to projectId project and forecastId forecast. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: forecastedAt in: query required: false schema: type: string description: filter by forecastedAt, can be used for incremental pull - name: phase in: query required: false schema: type: string description: filter by phase - name: reviewedAt in: query required: false schema: type: string description: filter by reviewedAt, can be used for incremental pull - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/outputs/{id}: get: operationId: get-forecast-output-by-id summary: get-forecast-output-by-id tags: - v1 projects description: Returns the forecast data document that matches the given id scoped to projectId project and forecastId forecast. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/daily-volumes: head: operationId: head-forecast-daily-volumes summary: head-forecast-daily-volumes tags: - v1 projects description: Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-forecast-daily-volumes summary: get-forecast-daily-volumes tags: - v1 projects description: Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: well in: query required: false schema: type: string description: filter by well - name: startDate in: query required: false schema: type: string description: filter by startDate. Returns all records with a startDate greater than or equal to the specified value. - name: endDate in: query required: false schema: type: string description: filter by endDate. Returns all records with a endDate less than or equal to the specified value. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/monthly-volumes: head: operationId: head-forecast-monthly-volumes summary: head-forecast-monthly-volumes tags: - v1 projects description: Returns metadata about the existing forecast volumes scoped to projectId project, forecastId forecast, and well. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-forecast-monthly-volumes summary: get-forecast-monthly-volumes tags: - v1 projects description: Returns a list of forecast volumes scoped to projectId project, forecastId forecast, and well. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: well in: query required: false schema: type: string description: filter by well - name: startDate in: query required: false schema: type: string description: filter by startDate. Returns all records with a startDate greater than or equal to the specified value. - name: endDate in: query required: false schema: type: string description: filter by endDate. Returns all records with a endDate less than or equal to the specified value. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/run: post: operationId: post-forecast-run summary: post-forecast-run tags: - v1 projects description: 'Starts an asynchronous forecast run for the specified forecast. Always returns `202 Accepted` immediately with a `jobId` that can be polled via `GET .../run/{jobId}`. The server resolves the orchestrator (`autoFullForecast` or `customStreamsForecast`) automatically from the forecast''s `type` field — callers do not choose. **Mode A (defaults):** Send an empty body `{}`. The server uses ComboCurve''s built-in defaults for the forecast type. **Mode B (saved configuration):** Send `{ "configurationId": "..." }`. The server loads the saved forecast configuration, validates that its `forecastType` matches the target forecast''s `type`, and runs it verbatim. Company-enforced forecast settings are applied server-side in both modes, matching the behaviour of the client UI.' parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: configurationId: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/forecasts/{forecastId}/run/{jobId}: get: operationId: get-forecast-run-status summary: get-forecast-run-status tags: - v1 projects description: Returns the current status of a forecast run. The `jobId` must belong to the forecast identified by `forecastId` in the URL — callers cannot use this endpoint to poll arbitrary task IDs. parameters: - name: projectId in: path required: true schema: type: string - name: forecastId in: path required: true schema: type: string - name: jobId in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/monthly-productions: delete: operationId: delete-project-monthly-productions summary: delete-project-monthly-productions tags: - v1 projects description: Delete the monthly productions documents that match the given filters. parameters: - name: projectId in: path required: true schema: type: string - name: well in: query required: false schema: type: string description: (Required) filter by well ID - name: startDate in: query required: false schema: type: string description: filter by startDate - name: endDate in: query required: false schema: type: string description: filter by endDate responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded head: operationId: head-projects-monthly-productions summary: head-projects-monthly-productions tags: - v1 projects description: Returns metadata about the existing monthly production documents in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-projects-monthly-productions summary: get-projects-monthly-productions tags: - v1 projects description: Returns a list of monthly production documents in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: well in: query required: false schema: type: string description: filter by well - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-projects-monthly-productions summary: post-projects-monthly-productions tags: - v1 projects description: Upserts a list of monthly production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string daysOn: type: number gas: type: number gasInjection: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number water: type: number waterInjection: type: number well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-projects-monthly-productions summary: put-projects-monthly-productions tags: - v1 projects description: Upserts a list of monthly production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string daysOn: type: number gas: type: number gasInjection: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number water: type: number waterInjection: type: number well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-projects-monthly-productions summary: patch-projects-monthly-productions tags: - v1 projects description: Patch a list of monthly production documents in projectId scope. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: date: type: string format: date choke: type: number chosenID: type: string co2Injection: type: number customNumber0: type: number customNumber1: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number dataSource: type: string daysOn: type: number gas: type: number gasInjection: type: number ngl: type: number oil: type: number operationalTag: type: string steamInjection: type: number water: type: number waterInjection: type: number well: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios: head: operationId: head-scenarios summary: head-scenarios tags: - v1 projects description: Returns metadata about the existing scenario documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-scenarios summary: get-scenarios tags: - v1 projects description: Returns a list of scenario documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-project-scenarios summary: post-project-scenarios tags: - v1 projects description: Inserts a list of scenario documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-project-scenarios summary: put-project-scenarios tags: - v1 projects description: Update a list of scenario documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-project-scenarios summary: delete-project-scenarios tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: name in: query required: false schema: type: string description: The name of the scenario to delete. If this is not provided, the id parameter must be provided. - name: id in: query required: false schema: type: string description: The id of the scenario to delete. If this is not provided, the name parameter must be provided. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/head: delete: operationId: delete-scenarios summary: delete-scenarios tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: name in: query required: false schema: type: string description: (Required) The name of the scenario to delete. If this is not provided, the id parameter must be provided. - name: id in: query required: false schema: type: string description: (Required) The id of the scenario to delete. If this is not provided, the name parameter must be provided. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{id}: get: operationId: get-scenario-by-id summary: get-scenario-by-id tags: - v1 projects description: Returns the scenario document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/lookup-tables: head: operationId: head-scenario-lookup-tables summary: head-scenario-lookup-tables tags: - v1 projects description: Returns metadata about the existing scenario lookup table documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-scenario-lookup-tables summary: get-scenario-lookup-tables tags: - v1 projects description: Returns a list of scenario lookup table documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-scenario-lookup-tables summary: post-scenario-lookup-tables tags: - v1 projects description: Inserts a list of scenario lookup table documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string rules: type: array items: type: object properties: filter: type: array items: type: object properties: key: type: string operator: type: string value: type: object properties: description: type: string capex: type: string dates: type: string expenses: type: string ownershipReversion: type: string pricing: type: string differentials: type: string productionTaxes: type: string productionVsFit: type: string reservesCategory: type: string risking: type: string operations: type: string streamProperties: type: string forecast: type: string schedule: type: string caseInsensitiveMatching: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-scenario-lookup-tables summary: put-scenario-lookup-tables tags: - v1 projects description: Replace or create a list of scenario lookup table documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string rules: type: array items: type: object properties: filter: type: array items: type: object properties: key: type: string operator: type: string value: type: object properties: description: type: string capex: type: string dates: type: string expenses: type: string ownershipReversion: type: string pricing: type: string differentials: type: string productionTaxes: type: string productionVsFit: type: string reservesCategory: type: string risking: type: string operations: type: string streamProperties: type: string forecast: type: string schedule: type: string caseInsensitiveMatching: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/lookup-tables/{id}: get: operationId: get-scenario-lookup-table-by-id summary: get-scenario-lookup-table-by-id tags: - v1 projects description: Returns the scenario lookup table document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-scenario-lookup-table-by-id summary: delete-scenario-lookup-table-by-id tags: - v1 projects description: Delete the scenario lookup table document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs: head: operationId: head-econ-runs summary: head-econ-runs tags: - v1 projects description: Returns metadata about the existing econ run documents scoped to projectId project and scenarioId scenario. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: runDate in: query required: false schema: type: string description: filter by runDate, can be used for incremental pull - name: tags in: query required: false schema: type: string description: filter by tag name responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-econ-runs summary: get-econ-runs tags: - v1 projects description: Returns a list of econ run documents scoped to projectId project and scenarioId scenario. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: runDate in: query required: false schema: type: string description: filter by runDate - name: tags in: query required: false schema: type: string description: filter by tag name responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{id}: get: operationId: get-econ-run-by-id summary: get-econ-run-by-id tags: - v1 projects description: Returns the econ run document that matches the given id scoped to projectId project and scenarioId scenario. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/monthly-econ-results: get: operationId: get-monthly-econ-result-by-id summary: get-monthly-econ-result-by-id tags: - v1 projects description: Returns econ monthly result columns that matches the provided econ run id. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: columns in: query required: false schema: type: string description: (Required) List of columns separated by commas, do not follow commas with spaces, e.g. "column1,column2" - name: startDate in: query required: false schema: type: string description: Date at which to start the returned monthly result, e.g. "2019-01-01" - name: endDate in: query required: false schema: type: string description: Date at which to end the returned monthly result, e.g. "2020-01-01" - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/monthly-exports: head: operationId: head-monthly-exports summary: head-monthly-exports tags: - v1 projects description: Returns metadata about the existing econ monthly documents scoped to projectId project, scenarioId scenario and econRunId econ run. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: comboName in: query required: false schema: type: string description: filter by comboName - name: date in: query required: false schema: type: string description: filter by date - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-monthly-exports summary: post-monthly-exports tags: - v1 projects description: Create an monthly export of econ monthly documents scoped to projectId project, scenarioId scenario and econRunId econ run. Response id should be used to get the results. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: comboName in: query required: false schema: type: string description: filter by comboName - name: date in: query required: false schema: type: string description: filter by date - name: well in: query required: false schema: type: string description: filter by well responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/monthly-exports/{id}: get: operationId: get-monthly-export-by-id summary: get-monthly-export-by-id tags: - v1 projects description: Returns the econ monthly documents that matches the given monthly export id scoped to projectId project, scenarioId scenario and econRunId econ run, monthly export must be created before. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: concurrency in: query required: false schema: type: string description: maximum number of concurrent requests to make to the underlying datastore responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/one-liners: head: operationId: head-one-liners summary: head-one-liners tags: - v1 projects description: Returns metadata about the existing econ one liners documents scoped to projectId project, scenarioId scenario and econRunId econ run. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: comboName in: query required: false schema: type: string description: filter by comboName - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-one-liners summary: get-one-liners tags: - v1 projects description: Returns a list of econ one liner documents scoped to projectId project, scenarioId scenario and econRunId econ run. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: comboName in: query required: false schema: type: string description: filter by comboName - name: well in: query required: false schema: type: string description: filter by well responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/one-liners/{id}: get: operationId: get-one-liner-by-id summary: get-one-liner-by-id tags: - v1 projects description: Returns the econ one liner document that matches the given id scoped to projectId project, scenarioId scenario and econRunId econ run. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/one-liners/combo-names: get: operationId: get-one-liners-combo-names summary: get-one-liners-combo-names tags: - v1 projects description: Returns a list of combo names contained in the one liner documents that are scoped to project, scenario and econ run. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econRunId in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/combos: head: operationId: head-scenario-combos-count summary: head-scenario-combos-count tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-scenario-combos-read summary: get-scenario-combos-read tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: savedName in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-scenario-combos-upsert summary: post-scenario-combos-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: savedName: type: string combos: type: array items: type: object properties: comboName: type: string qualifiers: type: array items: type: object properties: assumption: type: string qualifierName: type: string selected: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-scenario-combos-upsert summary: put-scenario-combos-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: savedName: type: string combos: type: array items: type: object properties: comboName: type: string qualifiers: type: array items: type: object properties: assumption: type: string qualifierName: type: string selected: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-scenario-combos-delete summary: delete-scenario-combos-delete tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: savedName in: query required: false schema: type: string description: '(Required) ' - name: comboIds in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/qualifiers: get: operationId: get-qualifiers-read summary: get-qualifiers-read tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econName in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-qualifiers-upsert summary: post-qualifiers-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: econModel: type: string name: type: string newName: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-qualifiers-upsert summary: put-qualifiers-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: econModel: type: string name: type: string newName: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-qualifiers-delete summary: delete-qualifiers-delete tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: econNames in: query required: false schema: type: string description: '(Required) ' - name: qualifierNames in: query required: false schema: type: string description: '(Required) ' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/well-assignments: get: operationId: get-scenario-wells-read summary: get-scenario-wells-read tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-scenario-wells-upsert summary: post-scenario-wells-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-scenario-wells-upsert summary: put-scenario-wells-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-scenario-wells-delete summary: delete-scenario-wells-delete tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: wells in: query required: false schema: type: string description: '(Required) ' responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/assignments/lookup-tables: get: operationId: get-scenario-lookup-tables-assignments summary: get-scenario-lookup-tables-assignments tags: - v1 projects description: Returns lookup table assignments for the scenario. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: column in: query required: false schema: type: string description: Filter by scenario column(s). - name: qualifierName in: query required: false schema: type: string description: Filter by qualifier name. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-scenario-lookup-tables-assignments summary: put-scenario-lookup-tables-assignments tags: - v1 projects description: Create or update lookup table assignments. Accepts a single assignment object or an array (max 500). parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: column: type: string lookUpTableId: type: string wellIds: type: array items: type: string qualifierName: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/assignments/lookup-tables/{lookupTableId}: get: operationId: get-scenario-lookup-tables-assignments-by-id summary: get-scenario-lookup-tables-assignments-by-id tags: - v1 projects description: Returns lookup table assignments for the given lookup table ID. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: lookupTableId in: path required: true schema: type: string - name: column in: query required: false schema: type: string description: Filter by scenario column(s). - name: qualifierName in: query required: false schema: type: string description: Filter by qualifier name. responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-scenario-lookup-tables-assignments summary: delete-scenario-lookup-tables-assignments tags: - v1 projects description: Unassign wells from a lookup table. Body is an array of well IDs (ObjectIds) to unassign (max 500). parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: lookupTableId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/scenarios/{scenarioId}/assignments/econ-models: get: operationId: get-scenario-econ-model-assignments summary: get-scenario-econ-model-assignments tags: - v1 projects description: Returns econ model assignments for the scenario, grouped by well. parameters: - name: projectId in: path required: true schema: type: string - name: scenarioId in: path required: true schema: type: string - name: model in: query required: false schema: type: string description: Filter by econ model type(s) (API camelCase name). - name: qualifierName in: query required: false schema: type: string description: Filter by qualifier name. - name: wellId in: query required: false schema: type: string description: Filter by well ID(s) (ObjectId). Up to 100 values. - name: take in: query required: false schema: type: integer description: Maximum number of records to return (1–500). - name: skip in: query required: false schema: type: integer description: Number of records to skip. - name: cursor in: query required: false schema: type: string description: Cursor for cursor-based pagination (base64-encoded). responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves: head: operationId: head-type-curves summary: head-type-curves tags: - v1 projects description: Returns metadata about the existing type curve documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: name in: query required: false schema: type: string description: filter by name - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-type-curves summary: get-type-curves tags: - v1 projects description: Returns a list of type curve documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: name in: query required: false schema: type: string description: filter by name - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-type-curves summary: post-type-curves tags: - v1 projects description: Creates one or more type curve documents scoped to the given project. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: fits: type: object properties: gas: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number oil: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number water: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number forecast: type: string name: type: string regressionType: type: string wells: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-type-curves summary: put-type-curves tags: - v1 projects description: Updates one or more type curve documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: fits: type: object properties: gas: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number oil: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number water: type: object properties: align: type: boolean resolution: type: string normalize: type: boolean best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number type: type: string ratio: type: object properties: best: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p10: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p50: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string p90: type: object properties: segments: type: array items: type: object properties: b: type: number diEffSec: type: number diNominal: type: number endDate: type: string format: date qEnd: type: number qStart: type: number realizedDSwEffSec: type: number targetDSwEffSec: type: number segmentIndex: type: integer segmentType: type: string startDate: type: string format: date swDate: type: string format: date slope: type: number flatValue: type: number qSw: type: number basePhase: type: string normalizations: type: object properties: perfLateralLength: type: number normalizationType: type: string eur: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number peak: type: object properties: type: type: string slope: type: number intercept: type: number coefficient: type: number exponent: type: number base: type: string selectedNumericalTarget: type: string target: type: object properties: eur: type: number acre_spacing: type: number azimuth: type: number casing_id: type: number choke_size: type: number cluster_count: type: number cum_boe: type: number cum_boe_per_perforated_interval: type: number cum_gas: type: number cum_gas_per_perforated_interval: type: number cum_gor: type: number cum_mmcfge: type: number cum_mmcfge_per_perforated_interval: type: number cum_oil: type: number cum_oil_per_perforated_interval: type: number cum_water: type: number cum_water_per_perforated_interval: type: number custom_number_0: type: number custom_number_1: type: number custom_number_10: type: number custom_number_11: type: number custom_number_12: type: number custom_number_13: type: number custom_number_14: type: number custom_number_15: type: number custom_number_16: type: number custom_number_17: type: number custom_number_18: type: number custom_number_19: type: number custom_number_2: type: number custom_number_3: type: number custom_number_4: type: number custom_number_5: type: number custom_number_6: type: number custom_number_7: type: number custom_number_8: type: number custom_number_9: type: number distance_from_base_of_zone: type: number distance_from_top_of_zone: type: number elevation: type: number first_12_boe: type: number first_12_boe_per_perforated_interval: type: number first_12_gas: type: number first_12_gas_per_perforated_interval: type: number first_12_gor: type: number first_12_mmcfge: type: number first_12_mmcfge_per_perforated_interval: type: number first_12_oil: type: number first_12_oil_per_perforated_interval: type: number first_12_water: type: number first_12_water_per_perforated_interval: type: number first_6_boe: type: number first_6_boe_per_perforated_interval: type: number first_6_gas: type: number first_6_gas_per_perforated_interval: type: number first_6_gor: type: number first_6_mmcfge: type: number first_6_mmcfge_per_perforated_interval: type: number first_6_oil: type: number first_6_oil_per_perforated_interval: type: number first_6_water: type: number first_6_water_per_perforated_interval: type: number first_additive_volume: type: number first_cluster_count: type: number first_fluid_per_perforated_interval: type: number first_fluid_volume: type: number first_max_injection_pressure: type: number first_max_injection_rate: type: number first_prop_weight: type: number first_proppant_per_fluid: type: number first_proppant_per_perforated_interval: type: number first_stage_count: type: number first_test_flow_tbg_press: type: number first_test_gas_vol: type: number first_test_gor: type: number first_test_oil_vol: type: number first_test_water_vol: type: number footage_in_landing_zone: type: number formation_thickness_mean: type: number gas_specific_gravity: type: number ground_elevation: type: number hz_well_spacing_any_zone: type: number hz_well_spacing_same_zone: type: number initial_respress: type: number initial_restemp: type: number landing_zone_base: type: number landing_zone_top: type: number last_12_boe: type: number last_12_boe_per_perforated_interval: type: number last_12_gas: type: number last_12_gas_per_perforated_interval: type: number last_12_gor: type: number last_12_mmcfge: type: number last_12_mmcfge_per_perforated_interval: type: number last_12_oil: type: number last_12_oil_per_perforated_interval: type: number last_12_water: type: number last_12_water_per_perforated_interval: type: number last_month_boe: type: number last_month_boe_per_perforated_interval: type: number last_month_gas: type: number last_month_gas_per_perforated_interval: type: number last_month_gor: type: number last_month_mmcfge: type: number last_month_mmcfge_per_perforated_interval: type: number last_month_oil: type: number last_month_oil_per_perforated_interval: type: number last_month_water: type: number last_month_water_per_perforated_interval: type: number lateral_length: type: number lease_number: type: number lower_perforation: type: number matrix_permeability: type: number measured_depth: type: number month_produced: type: number num_treatment_records: type: number oil_api_gravity: type: number oil_specific_gravity: type: number perf_lateral_length: type: number refrac_additive_volume: type: number refrac_cluster_count: type: number refrac_fluid_per_perforated_interval: type: number refrac_fluid_volume: type: number refrac_max_injection_pressure: type: number refrac_max_injection_rate: type: number refrac_prop_weight: type: number refrac_proppant_per_fluid: type: number refrac_proppant_per_perforated_interval: type: number refrac_stage_count: type: number stage_spacing: type: number surfaceLatitude: type: number surfaceLongitude: type: number thickness: type: number toeLatitude: type: number toeLongitude: type: number total_additive_volume: type: number total_cluster_count: type: number total_fluid_per_perforated_interval: type: number total_fluid_volume: type: number total_prop_weight: type: number total_proppant_per_fluid: type: number total_proppant_per_perforated_interval: type: number total_stage_count: type: number true_vertical_depth: type: number tubing_depth: type: number tubing_id: type: number upper_perforation: type: number vt_well_spacing_any_zone: type: number vt_well_spacing_same_zone: type: number forecast: type: string name: type: string regressionType: type: string wells: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-type-curves summary: delete-type-curves tags: - v1 projects description: Delete the type curve documents that match the given filters. parameters: - name: projectId in: path required: true schema: type: string - name: name in: query required: false schema: type: string description: filter by name - name: id in: query required: false schema: type: string description: filter by id responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/{id}: get: operationId: get-type-curve-by-id summary: get-type-curve-by-id tags: - v1 projects description: Returns the type curve document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/{id}/fits/daily: get: operationId: get-type-curve-daily-fits summary: get-type-curve-daily-fits tags: - v1 projects description: Returns the daily volume fit information for the type curve document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: skip record - name: take in: query required: false schema: type: integer description: take amount of record to be returned responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/{id}/fits/monthly: get: operationId: get-type-curve-monthly-fits summary: get-type-curve-monthly-fits tags: - v1 projects description: Returns the monthly volume fit information for the type curve document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: skip record - name: take in: query required: false schema: type: integer description: take amount of record to be returned responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/{id}/representative-wells: get: operationId: get-type-curve-representative-wells summary: get-type-curve-representative-wells tags: - v1 projects description: Returns the well representative information for the type curve document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: skip record - name: take in: query required: false schema: type: integer description: take amount of record to be returned responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/lookup-tables: head: operationId: head-type-curve-lookup-tables summary: head-type-curve-lookup-tables tags: - v1 projects description: Returns metadata about the existing type curve lookup table documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-type-curve-lookup-tables summary: get-type-curve-lookup-tables tags: - v1 projects description: Returns a list of type curve lookup table documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-type-curve-lookup-tables summary: post-type-curve-lookup-tables tags: - v1 projects description: Inserts a list of type curve lookup table documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string rules: type: array items: type: object properties: filter: type: array items: type: object properties: key: type: string operator: type: string value: type: object properties: description: type: string typeCurve: type: string phase: type: string resolution: type: string applyNormalization: type: boolean applySeries: type: string fpdSource: type: string riskFactorOil: type: number riskFactorGas: type: number riskFactorWater: type: number fixedDate: type: string format: date caseInsensitiveMatching: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-type-curve-lookup-tables summary: put-type-curve-lookup-tables tags: - v1 projects description: Replace or create a list of type curve lookup table documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string rules: type: array items: type: object properties: filter: type: array items: type: object properties: key: type: string operator: type: string value: type: object properties: description: type: string typeCurve: type: string phase: type: string resolution: type: string applyNormalization: type: boolean applySeries: type: string fpdSource: type: string riskFactorOil: type: number riskFactorGas: type: number riskFactorWater: type: number fixedDate: type: string format: date caseInsensitiveMatching: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/type-curves/lookup-tables/{id}: get: operationId: get-type-curve-lookup-table-by-id summary: get-type-curve-lookup-table-by-id tags: - v1 projects description: Returns the type curve lookup table document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-type-curve-lookup-table-by-id summary: delete-type-curve-lookup-table-by-id tags: - v1 projects description: Delete the type curve lookup table document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/wells: head: operationId: head-project-wells summary: head-project-wells tags: - v1 projects description: Returns metadata about the existing well documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: api10 in: query required: false schema: type: string description: filter by api10 - name: api12 in: query required: false schema: type: string description: filter by api12 - name: county in: query required: false schema: type: string description: filter by county - name: state in: query required: false schema: type: string description: filter by state - name: wellName in: query required: false schema: type: string description: filter by wellName - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: inptID in: query required: false schema: type: string description: filter by inptID - name: api14 in: query required: false schema: type: string description: filter by api14 - name: createdAt in: query required: false schema: type: string description: filter by createdAt - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: currentOperator in: query required: false schema: type: string description: filter by dataSource responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-project-wells summary: get-project-wells tags: - v1 projects description: Returns a list of well documents scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: api10 in: query required: false schema: type: string description: filter by api10 - name: api12 in: query required: false schema: type: string description: filter by api12 - name: county in: query required: false schema: type: string description: filter by county - name: state in: query required: false schema: type: string description: filter by state - name: wellName in: query required: false schema: type: string description: filter by wellName - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: inptID in: query required: false schema: type: string description: filter by inptID - name: api14 in: query required: false schema: type: string description: filter by api14 - name: createdAt in: query required: false schema: type: string description: filter by createdAt - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: currentOperator in: query required: false schema: type: string description: filter by dataSource responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-project-wells summary: patch-project-wells tags: - v1 projects description: Updates a list of well documents in the specified project's scope. Project Custom Headers fields must be sent as string parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: abstract: type: string acreSpacing: type: number allocationType: type: string api10: type: string api12: type: string api14: type: string ariesId: type: string azimuth: type: number basin: type: string bg: type: number block: type: string bo: type: number bubblePointPress: type: number casingId: type: number chokeSize: type: number chosenID: type: string chosenKeyID: type: string completionDesign: type: string completionEndDate: type: string format: date completionStartDate: type: string format: date country: type: string county: type: string currentOperator: type: string currentOperatorAlias: type: string currentOperatorCode: type: string currentOperatorTicker: type: string customBool0: type: boolean customBool1: type: boolean customBool2: type: boolean customBool3: type: boolean customBool4: type: boolean customDate0: type: string format: date customDate1: type: string format: date customDate2: type: string format: date customDate3: type: string format: date customDate4: type: string format: date customDate5: type: string format: date customDate6: type: string format: date customDate7: type: string format: date customDate8: type: string format: date customDate9: type: string format: date customDate10: type: string format: date customDate11: type: string format: date customDate12: type: string format: date customDate13: type: string format: date customDate14: type: string format: date customDate15: type: string format: date customDate16: type: string format: date customDate17: type: string format: date customDate18: type: string format: date customDate19: type: string format: date customNumber0: type: number customNumber1: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customString0: type: string customString1: type: string customString10: type: string customString11: type: string customString12: type: string customString13: type: string customString14: type: string customString15: type: string customString16: type: string customString17: type: string customString18: type: string customString19: type: string customString2: type: string customString3: type: string customString4: type: string customString5: type: string customString6: type: string customString7: type: string customString8: type: string customString9: type: string customString20: type: string customString21: type: string customString22: type: string customString23: type: string customString24: type: string customString25: type: string customString26: type: string customString27: type: string customString28: type: string customString29: type: string customString30: type: string customString31: type: string customString32: type: string customString33: type: string customString34: type: string dataSource: type: string dataSourceCustomName: type: string dateRigRelease: type: string format: date dewPointPress: type: number distanceFromBaseOfZone: type: number distanceFromTopOfZone: type: number district: type: string drainageArea: type: number drillEndDate: type: string format: date drillStartDate: type: string format: date drillinginfoId: type: string elevation: type: number elevationType: type: string field: type: string firstAdditiveVolume: type: number firstClusterCount: type: number firstFluidVolume: type: number firstFracVendor: type: string firstMaxInjectionPressure: type: number firstMaxInjectionRate: type: number firstProdDate: type: string format: date firstPropWeight: type: number firstStageCount: type: number firstTestFlowTbgPress: type: number firstTestGasVol: type: number firstTestGor: type: number firstTestOilVol: type: number firstTestWaterVol: type: number firstTreatmentType: type: string flowPath: type: string fluidType: type: string footageInLandingZone: type: number formationThicknessMean: type: number fractureConductivity: type: number gasAnalysisDate: type: string format: date gasC1: type: number gasC2: type: number gasC3: type: number gasCo2: type: number gasGatherer: type: string gasH2: type: number gasH2o: type: number gasH2s: type: number gasHe: type: number gasIc4: type: number gasIc5: type: number gasN2: type: number gasNc10: type: number gasNc4: type: number gasNc5: type: number gasNc6: type: number gasNc7: type: number gasNc8: type: number gasNc9: type: number gasO2: type: number gasSpecificGravity: type: number grossPerforatedInterval: type: number groundElevation: type: number heelLatitude: type: number heelLongitude: type: number holeDirection: type: string horizontalSpacing: type: number hzWellSpacingAnyZone: type: number hzWellSpacingSameZone: type: number id: type: string ihsId: type: string initialRespress: type: number initialRestemp: type: number landingZone: type: string landingZoneBase: type: number landingZoneTop: type: number lateralLength: type: number leaseName: type: string leaseNumber: type: string lowerPerforation: type: number matrixPermeability: type: number measuredDepth: type: number nglGatherer: type: string numTreatmentRecords: type: number oilApiGravity: type: number oilGatherer: type: string oilSpecificGravity: type: number padName: type: string parentChildAnyZone: type: string parentChildSameZone: type: string percentInZone: type: number perfLateralLength: type: number permitDate: type: string format: date phdwinId: type: string play: type: string porosity: type: number previousOperator: type: string previousOperatorAlias: type: string previousOperatorCode: type: string previousOperatorTicker: type: string primaryProduct: type: string prmsReservesCategory: type: string prmsReservesSubCategory: type: string prmsResourcesClass: type: string productionMethod: type: string projectCustomHeader: type: string projectCustomHeader1: type: string projectCustomHeader2: type: string projectCustomHeader3: type: string projectCustomHeader4: type: string projectCustomHeader5: type: string projectCustomHeader6: type: string projectCustomHeader7: type: string projectCustomHeader8: type: string projectCustomHeader9: type: string projectCustomHeader10: type: string projectCustomHeader11: type: string projectCustomHeader12: type: string projectCustomHeader13: type: string projectCustomHeader14: type: string projectCustomHeader15: type: string projectCustomHeader16: type: string projectCustomHeader17: type: string projectCustomHeader18: type: string projectCustomHeader19: type: string projectCustomHeader20: type: string projectCustomHeader21: type: string projectCustomHeader22: type: string projectCustomHeader23: type: string projectCustomHeader24: type: string projectCustomHeader25: type: string projectCustomHeader26: type: string projectCustomHeader27: type: string projectCustomHeader28: type: string projectCustomHeader29: type: string projectCustomHeader30: type: string projectCustomHeader31: type: string projectCustomHeader32: type: string projectCustomHeader33: type: string projectCustomHeader34: type: string projectCustomHeader35: type: string projectCustomHeader36: type: string projectCustomHeader37: type: string projectCustomHeader38: type: string projectCustomHeader39: type: string projectCustomHeader40: type: string projectCustomHeader41: type: string projectCustomHeader42: type: string projectCustomHeader43: type: string projectCustomHeader44: type: string projectCustomHeader45: type: string projectCustomHeader46: type: string projectCustomHeader47: type: string projectCustomHeader48: type: string projectCustomHeader49: type: string proppantMeshSize: type: string proppantType: type: string range: type: string recoveryMethod: type: string refracAdditiveVolume: type: number refracClusterCount: type: number refracDate: type: string format: date refracFluidVolume: type: number refracFracVendor: type: string refracMaxInjectionPressure: type: number refracMaxInjectionRate: type: number refracPropWeight: type: number refracStageCount: type: number refracTreatmentType: type: string rig: type: string rs: type: number rsegId: type: string section: type: string sg: type: number so: type: number spudDate: type: string format: date stageSpacing: type: number state: type: string status: type: string subplay: type: string surfaceLatitude: type: number surfaceLongitude: type: number survey: type: string sw: type: number targetFormation: type: string tgsId: type: string spgciId: type: string thickness: type: number til: type: string format: date toeInLandingZone: type: string toeLatitude: type: number toeLongitude: type: number toeUp: type: string township: type: string trueVerticalDepth: type: number tubingDepth: type: number tubingId: type: number typeCurveArea: type: string upperPerforation: type: number verticalSpacing: type: number vtWellSpacingAnyZone: type: number vtWellSpacingSameZone: type: number wellName: type: string wellNumber: type: string wellType: type: string zi: type: number responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-projects-wells summary: post-projects-wells tags: - v1 projects description: Inserts a list of well documents into the specified project's scope. Project Custom Headers fields must be sent as string parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: dataSource: type: string abstract: type: string acreSpacing: type: number allocationType: type: string api10: type: string api12: type: string api14: type: string ariesId: type: string azimuth: type: number basin: type: string bg: type: number block: type: string bo: type: number bubblePointPress: type: number casingId: type: number chokeSize: type: number chosenID: type: string chosenKeyID: type: string completionDesign: type: string completionEndDate: type: string format: date completionStartDate: type: string format: date country: type: string county: type: string currentOperator: type: string currentOperatorAlias: type: string currentOperatorCode: type: string currentOperatorTicker: type: string customBool0: type: boolean customBool1: type: boolean customBool2: type: boolean customBool3: type: boolean customBool4: type: boolean customDate0: type: string format: date customDate1: type: string format: date customDate2: type: string format: date customDate3: type: string format: date customDate4: type: string format: date customDate5: type: string format: date customDate6: type: string format: date customDate7: type: string format: date customDate8: type: string format: date customDate9: type: string format: date customDate10: type: string format: date customDate11: type: string format: date customDate12: type: string format: date customDate13: type: string format: date customDate14: type: string format: date customDate15: type: string format: date customDate16: type: string format: date customDate17: type: string format: date customDate18: type: string format: date customDate19: type: string format: date customNumber0: type: number customNumber1: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customString0: type: string customString1: type: string customString10: type: string customString11: type: string customString12: type: string customString13: type: string customString14: type: string customString15: type: string customString16: type: string customString17: type: string customString18: type: string customString19: type: string customString20: type: string customString21: type: string customString22: type: string customString23: type: string customString24: type: string customString25: type: string customString26: type: string customString27: type: string customString28: type: string customString29: type: string customString30: type: string customString31: type: string customString32: type: string customString33: type: string customString34: type: string customString2: type: string customString3: type: string customString4: type: string customString5: type: string customString6: type: string customString7: type: string customString8: type: string customString9: type: string dataSourceCustomName: type: string dateRigRelease: type: string format: date dewPointPress: type: number distanceFromBaseOfZone: type: number distanceFromTopOfZone: type: number district: type: string drainageArea: type: number drillEndDate: type: string format: date drillStartDate: type: string format: date drillinginfoId: type: string elevation: type: number elevationType: type: string field: type: string firstAdditiveVolume: type: number firstClusterCount: type: number firstFluidVolume: type: number firstFracVendor: type: string firstMaxInjectionPressure: type: number firstMaxInjectionRate: type: number firstProdDate: type: string format: date firstPropWeight: type: number firstStageCount: type: number firstTestFlowTbgPress: type: number firstTestGasVol: type: number firstTestGor: type: number firstTestOilVol: type: number firstTestWaterVol: type: number firstTreatmentType: type: string flowPath: type: string fluidType: type: string footageInLandingZone: type: number formationThicknessMean: type: number fractureConductivity: type: number gasAnalysisDate: type: string format: date gasC1: type: number gasC2: type: number gasC3: type: number gasCo2: type: number gasGatherer: type: string gasH2: type: number gasH2o: type: number gasH2s: type: number gasHe: type: number gasIc4: type: number gasIc5: type: number gasN2: type: number gasNc10: type: number gasNc4: type: number gasNc5: type: number gasNc6: type: number gasNc7: type: number gasNc8: type: number gasNc9: type: number gasO2: type: number gasSpecificGravity: type: number grossPerforatedInterval: type: number groundElevation: type: number heelLatitude: type: number heelLongitude: type: number holeDirection: type: string horizontalSpacing: type: number hzWellSpacingAnyZone: type: number hzWellSpacingSameZone: type: number id: type: string ihsId: type: string initialRespress: type: number initialRestemp: type: number landingZone: type: string landingZoneBase: type: number landingZoneTop: type: number lateralLength: type: number leaseName: type: string leaseNumber: type: string lowerPerforation: type: number matrixPermeability: type: number measuredDepth: type: number nglGatherer: type: string numTreatmentRecords: type: number oilApiGravity: type: number oilGatherer: type: string oilSpecificGravity: type: number padName: type: string parentChildAnyZone: type: string parentChildSameZone: type: string percentInZone: type: number perfLateralLength: type: number permitDate: type: string format: date phdwinId: type: string play: type: string porosity: type: number previousOperator: type: string previousOperatorAlias: type: string previousOperatorCode: type: string previousOperatorTicker: type: string primaryProduct: type: string prmsReservesCategory: type: string prmsReservesSubCategory: type: string prmsResourcesClass: type: string productionMethod: type: string projectCustomHeader: type: string projectCustomHeader1: type: string projectCustomHeader2: type: string projectCustomHeader3: type: string projectCustomHeader4: type: string projectCustomHeader5: type: string projectCustomHeader6: type: string projectCustomHeader7: type: string projectCustomHeader8: type: string projectCustomHeader9: type: string projectCustomHeader10: type: string projectCustomHeader11: type: string projectCustomHeader12: type: string projectCustomHeader13: type: string projectCustomHeader14: type: string projectCustomHeader15: type: string projectCustomHeader16: type: string projectCustomHeader17: type: string projectCustomHeader18: type: string projectCustomHeader19: type: string projectCustomHeader20: type: string projectCustomHeader21: type: string projectCustomHeader22: type: string projectCustomHeader23: type: string projectCustomHeader24: type: string projectCustomHeader25: type: string projectCustomHeader26: type: string projectCustomHeader27: type: string projectCustomHeader28: type: string projectCustomHeader29: type: string projectCustomHeader30: type: string projectCustomHeader31: type: string projectCustomHeader32: type: string projectCustomHeader33: type: string projectCustomHeader34: type: string projectCustomHeader35: type: string projectCustomHeader36: type: string projectCustomHeader37: type: string projectCustomHeader38: type: string projectCustomHeader39: type: string projectCustomHeader40: type: string projectCustomHeader41: type: string projectCustomHeader42: type: string projectCustomHeader43: type: string projectCustomHeader44: type: string projectCustomHeader45: type: string projectCustomHeader46: type: string projectCustomHeader47: type: string projectCustomHeader48: type: string projectCustomHeader49: type: string proppantMeshSize: type: string proppantType: type: string range: type: string recoveryMethod: type: string refracAdditiveVolume: type: number refracClusterCount: type: number refracDate: type: string format: date refracFluidVolume: type: number refracFracVendor: type: string refracMaxInjectionPressure: type: number refracMaxInjectionRate: type: number refracPropWeight: type: number refracStageCount: type: number refracTreatmentType: type: string rig: type: string rs: type: number rsegId: type: string section: type: string sg: type: number so: type: number spudDate: type: string format: date stageSpacing: type: number state: type: string status: type: string subplay: type: string surfaceLatitude: type: number surfaceLongitude: type: number survey: type: string sw: type: number targetFormation: type: string tgsId: type: string spgciId: type: string thickness: type: number til: type: string format: date toeInLandingZone: type: string toeLatitude: type: number toeLongitude: type: number toeUp: type: string township: type: string trueVerticalDepth: type: number tubingDepth: type: number tubingId: type: number typeCurveArea: type: string upperPerforation: type: number verticalSpacing: type: number vtWellSpacingAnyZone: type: number vtWellSpacingSameZone: type: number wellName: type: string wellNumber: type: string wellType: type: string zi: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-projects-wells summary: put-projects-wells tags: - v1 projects description: Replaces a list of well documents in the specified project's scope. Project Custom Headers fields must be sent as string parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: dataSource: type: string abstract: type: string acreSpacing: type: number allocationType: type: string api10: type: string api12: type: string api14: type: string ariesId: type: string azimuth: type: number basin: type: string bg: type: number block: type: string bo: type: number bubblePointPress: type: number casingId: type: number chokeSize: type: number chosenID: type: string chosenKeyID: type: string completionDesign: type: string completionEndDate: type: string format: date completionStartDate: type: string format: date country: type: string county: type: string currentOperator: type: string currentOperatorAlias: type: string currentOperatorCode: type: string currentOperatorTicker: type: string customBool0: type: boolean customBool1: type: boolean customBool2: type: boolean customBool3: type: boolean customBool4: type: boolean customDate0: type: string format: date customDate1: type: string format: date customDate2: type: string format: date customDate3: type: string format: date customDate4: type: string format: date customDate5: type: string format: date customDate6: type: string format: date customDate7: type: string format: date customDate8: type: string format: date customDate9: type: string format: date customDate10: type: string format: date customDate11: type: string format: date customDate12: type: string format: date customDate13: type: string format: date customDate14: type: string format: date customDate15: type: string format: date customDate16: type: string format: date customDate17: type: string format: date customDate18: type: string format: date customDate19: type: string format: date customNumber0: type: number customNumber1: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customString0: type: string customString1: type: string customString10: type: string customString11: type: string customString12: type: string customString13: type: string customString14: type: string customString15: type: string customString16: type: string customString17: type: string customString18: type: string customString19: type: string customString20: type: string customString21: type: string customString22: type: string customString23: type: string customString24: type: string customString25: type: string customString26: type: string customString27: type: string customString28: type: string customString29: type: string customString30: type: string customString31: type: string customString32: type: string customString33: type: string customString34: type: string customString2: type: string customString3: type: string customString4: type: string customString5: type: string customString6: type: string customString7: type: string customString8: type: string customString9: type: string dataSourceCustomName: type: string dateRigRelease: type: string format: date dewPointPress: type: number distanceFromBaseOfZone: type: number distanceFromTopOfZone: type: number district: type: string drainageArea: type: number drillEndDate: type: string format: date drillStartDate: type: string format: date drillinginfoId: type: string elevation: type: number elevationType: type: string field: type: string firstAdditiveVolume: type: number firstClusterCount: type: number firstFluidVolume: type: number firstFracVendor: type: string firstMaxInjectionPressure: type: number firstMaxInjectionRate: type: number firstProdDate: type: string format: date firstPropWeight: type: number firstStageCount: type: number firstTestFlowTbgPress: type: number firstTestGasVol: type: number firstTestGor: type: number firstTestOilVol: type: number firstTestWaterVol: type: number firstTreatmentType: type: string flowPath: type: string fluidType: type: string footageInLandingZone: type: number formationThicknessMean: type: number fractureConductivity: type: number gasAnalysisDate: type: string format: date gasC1: type: number gasC2: type: number gasC3: type: number gasCo2: type: number gasGatherer: type: string gasH2: type: number gasH2o: type: number gasH2s: type: number gasHe: type: number gasIc4: type: number gasIc5: type: number gasN2: type: number gasNc10: type: number gasNc4: type: number gasNc5: type: number gasNc6: type: number gasNc7: type: number gasNc8: type: number gasNc9: type: number gasO2: type: number gasSpecificGravity: type: number grossPerforatedInterval: type: number groundElevation: type: number heelLatitude: type: number heelLongitude: type: number holeDirection: type: string horizontalSpacing: type: number hzWellSpacingAnyZone: type: number hzWellSpacingSameZone: type: number id: type: string ihsId: type: string initialRespress: type: number initialRestemp: type: number landingZone: type: string landingZoneBase: type: number landingZoneTop: type: number lateralLength: type: number leaseName: type: string leaseNumber: type: string lowerPerforation: type: number matrixPermeability: type: number measuredDepth: type: number nglGatherer: type: string numTreatmentRecords: type: number oilApiGravity: type: number oilGatherer: type: string oilSpecificGravity: type: number padName: type: string parentChildAnyZone: type: string parentChildSameZone: type: string percentInZone: type: number perfLateralLength: type: number permitDate: type: string format: date phdwinId: type: string play: type: string porosity: type: number previousOperator: type: string previousOperatorAlias: type: string previousOperatorCode: type: string previousOperatorTicker: type: string primaryProduct: type: string prmsReservesCategory: type: string prmsReservesSubCategory: type: string prmsResourcesClass: type: string productionMethod: type: string projectCustomHeader: type: string projectCustomHeader1: type: string projectCustomHeader2: type: string projectCustomHeader3: type: string projectCustomHeader4: type: string projectCustomHeader5: type: string projectCustomHeader6: type: string projectCustomHeader7: type: string projectCustomHeader8: type: string projectCustomHeader9: type: string projectCustomHeader10: type: string projectCustomHeader11: type: string projectCustomHeader12: type: string projectCustomHeader13: type: string projectCustomHeader14: type: string projectCustomHeader15: type: string projectCustomHeader16: type: string projectCustomHeader17: type: string projectCustomHeader18: type: string projectCustomHeader19: type: string projectCustomHeader20: type: string projectCustomHeader21: type: string projectCustomHeader22: type: string projectCustomHeader23: type: string projectCustomHeader24: type: string projectCustomHeader25: type: string projectCustomHeader26: type: string projectCustomHeader27: type: string projectCustomHeader28: type: string projectCustomHeader29: type: string projectCustomHeader30: type: string projectCustomHeader31: type: string projectCustomHeader32: type: string projectCustomHeader33: type: string projectCustomHeader34: type: string projectCustomHeader35: type: string projectCustomHeader36: type: string projectCustomHeader37: type: string projectCustomHeader38: type: string projectCustomHeader39: type: string projectCustomHeader40: type: string projectCustomHeader41: type: string projectCustomHeader42: type: string projectCustomHeader43: type: string projectCustomHeader44: type: string projectCustomHeader45: type: string projectCustomHeader46: type: string projectCustomHeader47: type: string projectCustomHeader48: type: string projectCustomHeader49: type: string proppantMeshSize: type: string proppantType: type: string range: type: string recoveryMethod: type: string refracAdditiveVolume: type: number refracClusterCount: type: number refracDate: type: string format: date refracFluidVolume: type: number refracFracVendor: type: string refracMaxInjectionPressure: type: number refracMaxInjectionRate: type: number refracPropWeight: type: number refracStageCount: type: number refracTreatmentType: type: string rig: type: string rs: type: number rsegId: type: string section: type: string sg: type: number so: type: number spudDate: type: string format: date stageSpacing: type: number state: type: string status: type: string subplay: type: string surfaceLatitude: type: number surfaceLongitude: type: number survey: type: string sw: type: number targetFormation: type: string tgsId: type: string spgciId: type: string thickness: type: number til: type: string format: date toeInLandingZone: type: string toeLatitude: type: number toeLongitude: type: number toeUp: type: string township: type: string trueVerticalDepth: type: number tubingDepth: type: number tubingId: type: number typeCurveArea: type: string upperPerforation: type: number verticalSpacing: type: number vtWellSpacingAnyZone: type: number vtWellSpacingSameZone: type: number wellName: type: string wellNumber: type: string wellType: type: string zi: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-project-wells summary: delete-project-wells tags: - v1 projects description: Delete the wells documents that match the given filters scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: chosenID in: query required: false schema: type: string description: filter by chosenID - name: dataSource in: query required: false schema: type: string description: filter by dataSource - name: id in: query required: false schema: type: string description: filter by id responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/wells/{id}: get: operationId: get-project-well-by-id summary: get-project-well-by-id tags: - v1 projects description: Returns the well document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded patch: operationId: patch-project-well-by-id summary: patch-project-well-by-id tags: - v1 projects description: Updates the well document that matches the given id in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: abstract: type: string acreSpacing: type: number allocationType: type: string api10: type: string api12: type: string api14: type: string ariesId: type: string azimuth: type: number basin: type: string bg: type: number block: type: string bo: type: number bubblePointPress: type: number casingId: type: number chokeSize: type: number chosenID: type: string chosenKeyID: type: string completionDesign: type: string completionEndDate: type: string format: date completionStartDate: type: string format: date country: type: string county: type: string currentOperator: type: string currentOperatorAlias: type: string currentOperatorCode: type: string currentOperatorTicker: type: string customBool0: type: boolean customBool1: type: boolean customBool2: type: boolean customBool3: type: boolean customBool4: type: boolean customDate0: type: string format: date customDate1: type: string format: date customDate2: type: string format: date customDate3: type: string format: date customDate4: type: string format: date customDate5: type: string format: date customDate6: type: string format: date customDate7: type: string format: date customDate8: type: string format: date customDate9: type: string format: date customDate10: type: string format: date customDate11: type: string format: date customDate12: type: string format: date customDate13: type: string format: date customDate14: type: string format: date customDate15: type: string format: date customDate16: type: string format: date customDate17: type: string format: date customDate18: type: string format: date customDate19: type: string format: date customNumber0: type: number customNumber1: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customString0: type: string customString1: type: string customString10: type: string customString11: type: string customString12: type: string customString13: type: string customString14: type: string customString15: type: string customString16: type: string customString17: type: string customString18: type: string customString19: type: string customString2: type: string customString3: type: string customString4: type: string customString5: type: string customString6: type: string customString7: type: string customString8: type: string customString9: type: string customString20: type: string customString21: type: string customString22: type: string customString23: type: string customString24: type: string customString25: type: string customString26: type: string customString27: type: string customString28: type: string customString29: type: string customString30: type: string customString31: type: string customString32: type: string customString33: type: string customString34: type: string dataSource: type: string dataSourceCustomName: type: string dateRigRelease: type: string format: date dewPointPress: type: number distanceFromBaseOfZone: type: number distanceFromTopOfZone: type: number district: type: string drainageArea: type: number drillEndDate: type: string format: date drillStartDate: type: string format: date drillinginfoId: type: string elevation: type: number elevationType: type: string field: type: string firstAdditiveVolume: type: number firstClusterCount: type: number firstFluidVolume: type: number firstFracVendor: type: string firstMaxInjectionPressure: type: number firstMaxInjectionRate: type: number firstProdDate: type: string format: date firstPropWeight: type: number firstStageCount: type: number firstTestFlowTbgPress: type: number firstTestGasVol: type: number firstTestGor: type: number firstTestOilVol: type: number firstTestWaterVol: type: number firstTreatmentType: type: string flowPath: type: string fluidType: type: string footageInLandingZone: type: number formationThicknessMean: type: number fractureConductivity: type: number gasAnalysisDate: type: string format: date gasC1: type: number gasC2: type: number gasC3: type: number gasCo2: type: number gasGatherer: type: string gasH2: type: number gasH2o: type: number gasH2s: type: number gasHe: type: number gasIc4: type: number gasIc5: type: number gasN2: type: number gasNc10: type: number gasNc4: type: number gasNc5: type: number gasNc6: type: number gasNc7: type: number gasNc8: type: number gasNc9: type: number gasO2: type: number gasSpecificGravity: type: number grossPerforatedInterval: type: number groundElevation: type: number heelLatitude: type: number heelLongitude: type: number holeDirection: type: string horizontalSpacing: type: number hzWellSpacingAnyZone: type: number hzWellSpacingSameZone: type: number id: type: string ihsId: type: string initialRespress: type: number initialRestemp: type: number landingZone: type: string landingZoneBase: type: number landingZoneTop: type: number lateralLength: type: number leaseName: type: string leaseNumber: type: string lowerPerforation: type: number matrixPermeability: type: number measuredDepth: type: number nglGatherer: type: string numTreatmentRecords: type: number oilApiGravity: type: number oilGatherer: type: string oilSpecificGravity: type: number padName: type: string parentChildAnyZone: type: string parentChildSameZone: type: string percentInZone: type: number perfLateralLength: type: number permitDate: type: string format: date phdwinId: type: string play: type: string porosity: type: number previousOperator: type: string previousOperatorAlias: type: string previousOperatorCode: type: string previousOperatorTicker: type: string primaryProduct: type: string prmsReservesCategory: type: string prmsReservesSubCategory: type: string prmsResourcesClass: type: string productionMethod: type: string proppantMeshSize: type: string proppantType: type: string range: type: string recoveryMethod: type: string refracAdditiveVolume: type: number refracClusterCount: type: number refracDate: type: string format: date refracFluidVolume: type: number refracFracVendor: type: string refracMaxInjectionPressure: type: number refracMaxInjectionRate: type: number refracPropWeight: type: number refracStageCount: type: number refracTreatmentType: type: string rig: type: string rs: type: number rsegId: type: string section: type: string sg: type: number so: type: number spudDate: type: string format: date stageSpacing: type: number state: type: string status: type: string subplay: type: string surfaceLatitude: type: number surfaceLongitude: type: number survey: type: string sw: type: number targetFormation: type: string tgsId: type: string spgciId: type: string thickness: type: number til: type: string format: date toeInLandingZone: type: string toeLatitude: type: number toeLongitude: type: number toeUp: type: string township: type: string trueVerticalDepth: type: number tubingDepth: type: number tubingId: type: number typeCurveArea: type: string upperPerforation: type: number verticalSpacing: type: number vtWellSpacingAnyZone: type: number vtWellSpacingSameZone: type: number wellName: type: string wellNumber: type: string wellType: type: string zi: type: number responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-projects-wells-by-id summary: put-projects-wells-by-id tags: - v1 projects description: Replaces the well document that matches the given id in the specified project's scope. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: dataSource: type: string abstract: type: string acreSpacing: type: number allocationType: type: string api10: type: string api12: type: string api14: type: string ariesId: type: string azimuth: type: number basin: type: string bg: type: number block: type: string bo: type: number bubblePointPress: type: number casingId: type: number chokeSize: type: number chosenID: type: string chosenKeyID: type: string completionDesign: type: string completionEndDate: type: string format: date completionStartDate: type: string format: date country: type: string county: type: string currentOperator: type: string currentOperatorAlias: type: string currentOperatorCode: type: string currentOperatorTicker: type: string customBool0: type: boolean customBool1: type: boolean customBool2: type: boolean customBool3: type: boolean customBool4: type: boolean customDate0: type: string format: date customDate1: type: string format: date customDate2: type: string format: date customDate3: type: string format: date customDate4: type: string format: date customDate5: type: string format: date customDate6: type: string format: date customDate7: type: string format: date customDate8: type: string format: date customDate9: type: string format: date customDate10: type: string format: date customDate11: type: string format: date customDate12: type: string format: date customDate13: type: string format: date customDate14: type: string format: date customDate15: type: string format: date customDate16: type: string format: date customDate17: type: string format: date customDate18: type: string format: date customDate19: type: string format: date customNumber0: type: number customNumber1: type: number customNumber10: type: number customNumber11: type: number customNumber12: type: number customNumber13: type: number customNumber14: type: number customNumber15: type: number customNumber16: type: number customNumber17: type: number customNumber18: type: number customNumber19: type: number customNumber2: type: number customNumber3: type: number customNumber4: type: number customNumber5: type: number customNumber6: type: number customNumber7: type: number customNumber8: type: number customNumber9: type: number customString0: type: string customString1: type: string customString10: type: string customString11: type: string customString12: type: string customString13: type: string customString14: type: string customString15: type: string customString16: type: string customString17: type: string customString18: type: string customString19: type: string customString20: type: string customString21: type: string customString22: type: string customString23: type: string customString24: type: string customString25: type: string customString26: type: string customString27: type: string customString28: type: string customString29: type: string customString30: type: string customString31: type: string customString32: type: string customString33: type: string customString34: type: string customString2: type: string customString3: type: string customString4: type: string customString5: type: string customString6: type: string customString7: type: string customString8: type: string customString9: type: string dataSourceCustomName: type: string dateRigRelease: type: string format: date dewPointPress: type: number distanceFromBaseOfZone: type: number distanceFromTopOfZone: type: number district: type: string drainageArea: type: number drillEndDate: type: string format: date drillStartDate: type: string format: date drillinginfoId: type: string elevation: type: number elevationType: type: string field: type: string firstAdditiveVolume: type: number firstClusterCount: type: number firstFluidVolume: type: number firstFracVendor: type: string firstMaxInjectionPressure: type: number firstMaxInjectionRate: type: number firstProdDate: type: string format: date firstPropWeight: type: number firstStageCount: type: number firstTestFlowTbgPress: type: number firstTestGasVol: type: number firstTestGor: type: number firstTestOilVol: type: number firstTestWaterVol: type: number firstTreatmentType: type: string flowPath: type: string fluidType: type: string footageInLandingZone: type: number formationThicknessMean: type: number fractureConductivity: type: number gasAnalysisDate: type: string format: date gasC1: type: number gasC2: type: number gasC3: type: number gasCo2: type: number gasGatherer: type: string gasH2: type: number gasH2o: type: number gasH2s: type: number gasHe: type: number gasIc4: type: number gasIc5: type: number gasN2: type: number gasNc10: type: number gasNc4: type: number gasNc5: type: number gasNc6: type: number gasNc7: type: number gasNc8: type: number gasNc9: type: number gasO2: type: number gasSpecificGravity: type: number grossPerforatedInterval: type: number groundElevation: type: number heelLatitude: type: number heelLongitude: type: number holeDirection: type: string horizontalSpacing: type: number hzWellSpacingAnyZone: type: number hzWellSpacingSameZone: type: number id: type: string ihsId: type: string initialRespress: type: number initialRestemp: type: number landingZone: type: string landingZoneBase: type: number landingZoneTop: type: number lateralLength: type: number leaseName: type: string leaseNumber: type: string lowerPerforation: type: number matrixPermeability: type: number measuredDepth: type: number nglGatherer: type: string numTreatmentRecords: type: number oilApiGravity: type: number oilGatherer: type: string oilSpecificGravity: type: number padName: type: string parentChildAnyZone: type: string parentChildSameZone: type: string percentInZone: type: number perfLateralLength: type: number permitDate: type: string format: date phdwinId: type: string play: type: string porosity: type: number previousOperator: type: string previousOperatorAlias: type: string previousOperatorCode: type: string previousOperatorTicker: type: string primaryProduct: type: string prmsReservesCategory: type: string prmsReservesSubCategory: type: string prmsResourcesClass: type: string productionMethod: type: string proppantMeshSize: type: string proppantType: type: string range: type: string recoveryMethod: type: string refracAdditiveVolume: type: number refracClusterCount: type: number refracDate: type: string format: date refracFluidVolume: type: number refracFracVendor: type: string refracMaxInjectionPressure: type: number refracMaxInjectionRate: type: number refracPropWeight: type: number refracStageCount: type: number refracTreatmentType: type: string rig: type: string rs: type: number rsegId: type: string section: type: string sg: type: number so: type: number spudDate: type: string format: date stageSpacing: type: number state: type: string status: type: string subplay: type: string surfaceLatitude: type: number surfaceLongitude: type: number survey: type: string sw: type: number targetFormation: type: string tgsId: type: string spgciId: type: string thickness: type: number til: type: string format: date toeInLandingZone: type: string toeLatitude: type: number toeLongitude: type: number toeUp: type: string township: type: string trueVerticalDepth: type: number tubingDepth: type: number tubingId: type: number typeCurveArea: type: string upperPerforation: type: number verticalSpacing: type: number vtWellSpacingAnyZone: type: number vtWellSpacingSameZone: type: number wellName: type: string wellNumber: type: string wellType: type: string zi: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-project-well-by-id summary: delete-project-well-by-id tags: - v1 projects description: Delete the well document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models: head: operationId: head-econ-models summary: head-econ-models tags: - v1 projects description: Returns metadata about the existing econ model documents. parameters: - name: projectId in: path required: true schema: type: string - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-econ-models summary: get-econ-models tags: - v1 projects description: Returns a list of econ model documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/{id}: get: operationId: get-econ-model-by-id summary: get-econ-model-by-id tags: - v1 projects description: Returns the econ model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments: head: operationId: head-econ-models-assignments-count summary: head-econ-models-assignments-count tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: econName in: path required: true schema: type: string - name: econModelId in: path required: true schema: type: string - name: wells in: query required: false schema: type: string - name: scenarios in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-econ-models-assignments-read summary: get-econ-models-assignments-read tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: econName in: path required: true schema: type: string - name: econModelId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: wells in: query required: false schema: type: string - name: scenarios in: query required: false schema: type: string - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-econ-model-assignment-upsert summary: post-econ-model-assignment-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: econName in: path required: true schema: type: string - name: econModelId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: scenario: type: string allWells: type: boolean qualifierName: type: string wells: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-econ-model-assignment-upsert summary: put-econ-model-assignment-upsert tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: econName in: path required: true schema: type: string - name: econModelId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: scenario: type: string allWells: type: boolean qualifierName: type: string wells: type: array items: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-econ-model-assignment-delete summary: delete-econ-model-assignment-delete tags: - v1 projects parameters: - name: projectId in: path required: true schema: type: string - name: econName in: path required: true schema: type: string - name: econModelId in: path required: true schema: type: string - name: scenarioId in: query required: false schema: type: string description: '(Required) ' - name: qualifierName in: query required: false schema: type: string - name: wells in: query required: false schema: type: string - name: allWells in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/actual-forecast: head: operationId: head-actual-forecast summary: head-actual-forecast tags: - v1 projects description: Returns metadata about the existing actual or forecast documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-actual-forecast summary: get-actual-forecast tags: - v1 projects description: Returns a list of actual of forecast documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-actual-forecast summary: post-actual-forecast tags: - v1 projects description: Inserts a list of actual or forecast documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean well: type: string scenario: type: string actualOrForecast: type: object properties: ignoreHistoryProd: type: boolean replaceActualWithForecast: type: object properties: oil: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date gas: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date water: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-actual-forecast summary: put-actual-forecast tags: - v1 projects description: Replace or create a list of actual or forecast documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean well: type: string scenario: type: string actualOrForecast: type: object properties: ignoreHistoryProd: type: boolean replaceActualWithForecast: type: object properties: oil: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date gas: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date water: type: object properties: asOfDate: type: boolean never: type: boolean date: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/actual-forecast/{id}: get: operationId: get-actual-forecast-by-id summary: get-actual-forecast-by-id tags: - v1 projects description: Returns the actual forecast document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-actual-forecast-by-id summary: delete-actual-forecast-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/general-options: head: operationId: head-general-options summary: head-general-options tags: - v1 projects description: Returns metadata about the existing general options documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-general-options summary: get-general-options tags: - v1 projects description: Returns a list of general options documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-general-options summary: post-general-options tags: - v1 projects description: Inserts a list of general options documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string mainOptions: type: object properties: aggregationDate: type: string format: date reportingPeriod: type: string fiscal: type: string incomeTax: type: boolean projectType: type: string currency: type: string incomeTax: type: object properties: federalIncomeTax: type: array items: type: object properties: multiplier: type: integer offsetToFpd: type: number offsetToAsOf: type: number dates: type: string format: date entireWellLife: type: string stateIncomeTax: type: array items: type: object properties: multiplier: type: integer offsetToFpd: type: number offsetToAsOf: type: number dates: type: string format: date entireWellLife: type: string fifteenDepletion: type: boolean carryForward: type: boolean discountTable: type: object properties: discountMethod: type: string cashAccrualTime: type: string firstDiscount: type: integer secondDiscount: type: integer discounts: type: array items: type: object properties: discountTable: type: integer boeConversion: type: object properties: oil: type: number dryGas: type: number wetGas: type: number ngl: type: number dripCondensate: type: number reportingUnits: type: object properties: oil: type: string gas: type: string ngl: type: string dripCondensate: type: string water: type: string pressure: type: string cash: type: string gor: type: string condensateGasRatio: type: string dripCondensateYield: type: string nglYield: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-general-options summary: put-general-options tags: - v1 projects description: Replace or create a list of general options documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string mainOptions: type: object properties: aggregationDate: type: string format: date reportingPeriod: type: string fiscal: type: string incomeTax: type: boolean projectType: type: string currency: type: string incomeTax: type: object properties: federalIncomeTax: type: array items: type: object properties: multiplier: type: integer offsetToFpd: type: number offsetToAsOf: type: number dates: type: string format: date entireWellLife: type: string stateIncomeTax: type: array items: type: object properties: multiplier: type: integer offsetToFpd: type: number offsetToAsOf: type: number dates: type: string format: date entireWellLife: type: string fifteenDepletion: type: boolean carryForward: type: boolean discountTable: type: object properties: discountMethod: type: string cashAccrualTime: type: string firstDiscount: type: integer secondDiscount: type: integer discounts: type: array items: type: object properties: discountTable: type: integer boeConversion: type: object properties: oil: type: number dryGas: type: number wetGas: type: number ngl: type: number dripCondensate: type: number reportingUnits: type: object properties: oil: type: string gas: type: string ngl: type: string dripCondensate: type: string water: type: string pressure: type: string cash: type: string gor: type: string condensateGasRatio: type: string dripCondensateYield: type: string nglYield: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/general-options/{id}: get: operationId: get-general-options-by-id summary: get-general-options-by-id tags: - v1 projects description: Returns the general options document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-general-options-by-id summary: delete-general-options-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/reserves-categories: head: operationId: head-reserves-categories summary: head-reserves-categories tags: - v1 projects description: Returns metadata about the existing reserves categories documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-reserves-categories summary: get-reserves-categories tags: - v1 projects description: Returns a list of reserves categories documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-reserves-categories summary: post-reserves-categories tags: - v1 projects description: Inserts a list of reserves categories documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string reservesCategory: type: object properties: prmsClass: type: string prmsCategory: type: string prmsSubCategory: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-reserves-categories summary: put-reserves-categories tags: - v1 projects description: Replace or create a list of reserves categories documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string reservesCategory: type: object properties: prmsClass: type: string prmsCategory: type: string prmsSubCategory: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/reserves-categories/{id}: get: operationId: get-reserves-category-by-id summary: get-reserves-category-by-id tags: - v1 projects description: Returns the reserves category document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-reserves-category-by-id summary: delete-reserves-category-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/escalations: head: operationId: head-escalations summary: head-escalations tags: - v1 projects description: Returns metadata about the existing escalation models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-escalations summary: get-escalations tags: - v1 projects description: Returns a list of escalation models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-escalations summary: post-escalations tags: - v1 projects description: Inserts a list of escalation models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string escalation: type: object properties: rows: type: array items: type: object properties: pctPerYear: type: number dollarPerYear: type: number entireWellLife: type: string monthPeriod: type: number dates: type: string format: date escalationFrequency: type: string calculationMethod: type: string adjustFromDate: type: string adjustStartDate: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-escalations summary: put-escalations tags: - v1 projects description: Replace or create a list of escalation models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string escalation: type: object properties: rows: type: array items: type: object properties: pctPerYear: type: number dollarPerYear: type: number entireWellLife: type: string monthPeriod: type: number dates: type: string format: date escalationFrequency: type: string calculationMethod: type: string adjustFromDate: type: string adjustStartDate: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/escalations/{id}: get: operationId: get-escalation-by-id summary: get-escalation-by-id tags: - v1 projects description: Returns the escalation model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-escalation-by-id summary: delete-escalation-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/differentials: head: operationId: head-differentials summary: head-differentials tags: - v1 projects description: Returns metadata about the existing differentials documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-differentials summary: get-differentials tags: - v1 projects description: Returns a list of differentials documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-differentials summary: post-differentials tags: - v1 projects description: Inserts a list of differentials documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string differentials: type: object properties: firstDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date secondDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date thirdDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-differentials summary: put-differentials tags: - v1 projects description: Replace or create a list of differentials documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string differentials: type: object properties: firstDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date secondDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date thirdDifferential: type: object properties: oil: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date gas: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date ngl: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date dripCondensate: type: object properties: escalationModel: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number dollarPerMmbtu: type: number dollarPerGal: type: number dollarPerMcf: type: number pctOfBasePrice: type: number entireWellLife: type: string offsetToAsOf: type: number dates: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/differentials/{id}: get: operationId: get-differential-by-id summary: get-differential-by-id tags: - v1 projects description: Returns the differential document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-differential-by-id summary: delete-differential-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/pricing: head: operationId: head-pricing summary: head-pricing tags: - v1 projects description: Returns metadata about the existing pricing documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-pricing summary: get-pricing tags: - v1 projects description: Returns a list of pricing documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-pricing summary: post-pricing tags: - v1 projects description: Inserts a list of pricing documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string priceModel: type: object properties: oil: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: price: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string gas: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string ngl: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: price: type: number pctOfOilPrice: type: number dollarPerGal: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string dripCondensate: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: pctOfOilPrice: type: number dollarPerBbl: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-pricing summary: put-pricing tags: - v1 projects description: Replace or create a list of pricing documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string priceModel: type: object properties: oil: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: price: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string gas: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string ngl: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: price: type: number pctOfOilPrice: type: number dollarPerGal: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string dripCondensate: type: object properties: cap: type: number escalationModel: type: string rows: type: array items: type: object properties: pctOfOilPrice: type: number dollarPerBbl: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/pricing/{id}: get: operationId: get-pricing-by-id summary: get-pricing-by-id tags: - v1 projects description: Returns the pricing document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-pricing-by-id summary: delete-pricing-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/ownership-reversions: head: operationId: head-ownership-reversions summary: head-ownership-reversions tags: - v1 projects description: Returns metadata about the existing ownership reversions documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-ownership-reversions summary: get-ownership-reversions tags: - v1 projects description: Returns a list of ownership reversions documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-ownership-reversions summary: post-ownership-reversions tags: - v1 projects description: Inserts a list of ownership reversions documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string ownership: type: object properties: initialOwnership: type: object properties: workingInterest: type: number netProfitInterestType: type: string netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number firstReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date secondReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date thirdReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date fourthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date fifthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date sixthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date seventhReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date eighthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date ninthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date tenthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-ownership-reversions summary: put-ownership-reversions tags: - v1 projects description: Replace or create a list of ownership reversions documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string ownership: type: object properties: initialOwnership: type: object properties: workingInterest: type: number netProfitInterestType: type: string netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number firstReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date secondReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date thirdReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date fourthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date fifthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date sixthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date seventhReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date eighthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date ninthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date tenthReversion: type: object properties: reversionType: type: string balance: type: string includeNetProfitInterest: type: string workingInterest: type: number revBasisWorkingInterest: type: number revBasisNetRevenueInterest: type: number netProfitInterest: type: number netRevenueInterest: type: number leaseNetRevenueInterest: type: number oilNetRevenueInterest: type: number gasNetRevenueInterest: type: number nglNetRevenueInterest: type: number dripCondensateNetRevenueInterest: type: number reversionTiedTo: type: object properties: type: type: string value: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/ownership-reversions/{id}: get: operationId: get-ownership-reversion-by-id summary: get-ownership-reversion-by-id tags: - v1 projects description: Returns the Ownership Reversions document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-ownership-reversion-by-id summary: delete-ownership-reversion-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/production-taxes: head: operationId: head-production-taxes summary: head-production-taxes tags: - v1 projects description: Returns metadata about the existing production-taxes documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-production-taxes summary: get-production-taxes tags: - v1 projects description: Returns a list of production-taxes documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-production-taxes summary: post-production-taxes tags: - v1 projects description: Inserts a list of production-taxes documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string data: type: object properties: state: type: string rows: type: array items: type: object properties: key: type: string category: type: string criteria: type: string period: type: array items: type: string value: type: array items: type: number unit: type: string description: type: string shrinkageCondition: type: string escalation: type: string calculation: type: string deductSeveranceTax: type: boolean rateType: type: string rateRowsCalculationMethod: type: string unique: type: boolean scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-production-taxes summary: put-production-taxes tags: - v1 projects description: Replace or create a list of production-taxes documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string data: type: object properties: state: type: string rows: type: array items: type: object properties: key: type: string category: type: string criteria: type: string period: type: array items: type: string value: type: array items: type: number unit: type: string description: type: string shrinkageCondition: type: string escalation: type: string calculation: type: string deductSeveranceTax: type: boolean rateType: type: string rateRowsCalculationMethod: type: string unique: type: boolean scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/production-taxes/{id}: get: operationId: get-production-taxes-by-id summary: get-production-taxes-by-id tags: - v1 projects description: Returns the production taxes document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-production-taxes-by-id summary: delete-production-taxes-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/riskings: head: operationId: head-riskings summary: head-riskings tags: - v1 projects description: Returns metadata about the existing riskings models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-riskings summary: get-riskings tags: - v1 projects description: Returns a list of riskings models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-riskings summary: post-riskings tags: - v1 projects description: Inserts a list of riskings models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string risking: type: object properties: riskProd: type: boolean riskNglDripCondViaGasRisk: type: boolean oil: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string gas: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string ngl: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string dripCondensate: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string water: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-riskings summary: put-riskings tags: - v1 projects description: Replace or create a list of riskings models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string risking: type: object properties: riskProd: type: boolean riskNglDripCondViaGasRisk: type: boolean oil: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string gas: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string ngl: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string dripCondensate: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string water: type: object properties: rows: type: array items: type: object properties: multiplier: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date seasonal: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/riskings/{id}: get: operationId: get-risking-by-id summary: get-risking-by-id tags: - v1 projects description: Returns the riskings model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-riskings-by-id summary: delete-riskings-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/stream-properties: head: operationId: head-stream-properties summary: head-stream-properties tags: - v1 projects description: Returns metadata about the existing stream properties models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-stream-properties summary: get-stream-properties tags: - v1 projects description: Returns a list of stream-properties models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-stream-properties summary: post-stream-properties tags: - v1 projects description: Inserts a list of stream-properties models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string yields: type: object properties: rowsCalculationMethod: type: string ngl: type: object properties: rows: type: array items: type: object properties: yield: type: number shrunkGas: type: string unshrunkGas: type: string entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number dripCondensate: type: object properties: rows: type: array items: type: object properties: yield: type: number shrunkGas: type: string unshrunkGas: type: string entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number shrinkage: type: object properties: rowsCalculationMethod: type: string oil: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gas: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number lossFlare: type: object properties: rowsCalculationMethod: type: string oilLoss: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gasLoss: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gasFlare: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number btuContent: type: object properties: unshrunkGas: type: number shrunkGas: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-stream-properties summary: put-stream-properties tags: - v1 projects description: Replace or create a list of stream-properties models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string yields: type: object properties: rowsCalculationMethod: type: string ngl: type: object properties: rows: type: array items: type: object properties: yield: type: number shrunkGas: type: string unshrunkGas: type: string entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number dripCondensate: type: object properties: rows: type: array items: type: object properties: yield: type: number shrunkGas: type: string unshrunkGas: type: string entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number shrinkage: type: object properties: rowsCalculationMethod: type: string oil: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gas: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number lossFlare: type: object properties: rowsCalculationMethod: type: string oilLoss: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gasLoss: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number gasFlare: type: object properties: rows: type: array items: type: object properties: pctRemaining: type: number entireWellLife: type: string offsetToFpd: type: number offsetToAsOf: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number dates: type: string format: date oilRate: type: number gasRate: type: number waterRate: type: number btuContent: type: object properties: unshrunkGas: type: number shrunkGas: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/stream-properties/{id}: get: operationId: get-stream-properties-by-id summary: get-stream-properties-by-id tags: - v1 projects description: Returns the stream-properties model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-stream-properties-by-id summary: delete-stream-properties-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/expenses: head: operationId: head-expenses summary: head-expenses tags: - v1 projects description: Returns metadata about the existing expenses documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-expenses summary: get-expenses tags: - v1 projects description: Returns a list of expenses documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-expenses summary: post-expenses tags: - v1 projects description: Inserts a list of expenses documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string variableExpenses: type: object properties: oil: type: object properties: gathering: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string marketing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string transportation: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string processing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string other: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string gas: type: object properties: gathering: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string marketing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string transportation: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string processing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string other: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string ngl: type: object properties: gathering: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string marketing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string transportation: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string other: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string dripCondensate: type: object properties: gathering: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string marketing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string transportation: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string other: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string boe: type: object properties: processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string totalFluid: type: object properties: processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string fixedExpenses: type: object properties: monthlyWellCost: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost1: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost2: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost3: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost4: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost5: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost6: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost7: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost8: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number waterDisposal: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string carbonExpenses: type: object properties: category: type: string ch4: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number co2: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number co2E: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number n2O: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-expenses summary: put-expenses tags: - v1 projects description: Replace or create a list of expenses documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string variableExpenses: type: object properties: oil: type: object properties: gathering: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string marketing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string transportation: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string processing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string other: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string gas: type: object properties: gathering: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string marketing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string transportation: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string processing: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string other: type: object properties: shrinkageCondition: type: string escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: dollarPerMmbtu: type: number dollarPerMcf: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number cap: type: number startDate: type: string ngl: type: object properties: gathering: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string marketing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string transportation: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string other: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string dripCondensate: type: object properties: gathering: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string marketing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string transportation: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string other: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string boe: type: object properties: processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string totalFluid: type: object properties: processing: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string fixedExpenses: type: object properties: monthlyWellCost: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost1: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost2: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost3: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost4: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost5: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost6: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost7: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number otherMonthlyCost8: type: object properties: stopAtEconLimit: type: boolean expenseBeforeFpd: type: boolean escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: fixedExpense: type: number fixedExpensePerWell: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number waterDisposal: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string cap: type: number rows: type: array items: type: object properties: dollarPerBbl: type: number pctOfOilRev: type: number pctOfGasRev: type: number pctOfNglRev: type: number pctOfDripCondensateRev: type: number pctOfTotalRev: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number startDate: type: number startDate: type: string carbonExpenses: type: object properties: category: type: string ch4: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number co2: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number co2E: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number n2O: type: object properties: escalationModel: type: string affectEconLimit: type: boolean deductBeforeSeveranceTax: type: boolean deductBeforeAdValTax: type: boolean dealTerms: type: number calculation: type: string rateType: type: string rowsCalculationMethod: type: string description: type: string rows: type: array items: type: object properties: carbonExpense: type: number dates: type: string format: date offsetToAsOf: type: number entireWellLife: type: string offsetToFpd: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number offsetToEndHistory: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number cap: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/expenses/{id}: get: operationId: get-expenses-by-id summary: get-expenses-by-id tags: - v1 projects description: Returns the expenses document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-expenses-by-id summary: delete-expenses-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/emissions: head: operationId: head-emissions summary: head-emissions tags: - v1 projects description: Returns metadata about the existing emission models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-emissions summary: get-emissions tags: - v1 projects description: Returns a list of emission models documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-emissions summary: post-emissions tags: - v1 projects description: Inserts a list of emission models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean emissions: type: object properties: rows: type: array items: type: object properties: category: type: string co2e: type: number co2: type: number ch4: type: number n2o: type: number unit: type: string selected: type: boolean escalationModel: type: string scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-emissions summary: put-emissions tags: - v1 projects description: Replace or create a list of emission models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean emissions: type: object properties: rows: type: array items: type: object properties: category: type: string co2e: type: number co2: type: number ch4: type: number n2o: type: number unit: type: string selected: type: boolean escalationModel: type: string scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/emissions/{id}: get: operationId: get-emission-by-id summary: get-emission-by-id tags: - v1 projects description: Returns the emission model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-emission-by-id summary: delete-emission-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/fluid-models: head: operationId: head-fluid-models summary: head-fluid-models tags: - v1 projects description: Returns metadata about the existing fluid model documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-fluid-models summary: get-fluid-models tags: - v1 projects description: Returns a list of fluid model documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-fluid-models summary: post-fluid-models tags: - v1 projects description: Inserts a list of fluid model documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean fluidModel: type: object properties: dripCondensate: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string gas: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string ngl: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string oil: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string water: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-fluid-models summary: put-fluid-models tags: - v1 projects description: Replace or create a list of fluid models documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean fluidModel: type: object properties: dripCondensate: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string gas: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string ngl: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string oil: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string water: type: object properties: composition: type: object properties: N2: type: object properties: percentage: type: number CO2: type: object properties: percentage: type: number C1: type: object properties: percentage: type: number C2: type: object properties: percentage: type: number C3: type: object properties: percentage: type: number iC4: type: object properties: percentage: type: number nC4: type: object properties: percentage: type: number iC5: type: object properties: percentage: type: number nC5: type: object properties: percentage: type: number iC6: type: object properties: percentage: type: number nC6: type: object properties: percentage: type: number C7: type: object properties: percentage: type: number C8: type: object properties: percentage: type: number C9: type: object properties: percentage: type: number C10Plus: type: object properties: percentage: type: number H2S: type: object properties: percentage: type: number H2: type: object properties: percentage: type: number H2O: type: object properties: percentage: type: number He: type: object properties: percentage: type: number O2: type: object properties: percentage: type: number criteria: type: string scenario: type: string well: type: string responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/fluid-models/{id}: get: operationId: get-fluid-model-by-id summary: get-fluid-model-by-id tags: - v1 projects description: Returns the fluid model document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-fluid-model-by-id summary: delete-fluid-model-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/operations: head: operationId: head-operations summary: head-operations tags: - v1 projects description: Returns metadata about the existing operations documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-operations summary: get-operations tags: - v1 projects description: Returns a list of operations documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-operations summary: post-operations tags: - v1 projects description: Inserts a list of operations documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean curtailment: type: array items: type: object properties: key: type: string category: type: string criteria: type: string value: type: array items: type: number unit: type: string description: type: string period: type: string ratioStreamBehavior: type: string scenario: type: string well: type: string shutIn: type: object properties: rows: type: array items: type: object properties: phase: type: string offsetToAsOf: type: object properties: start: type: number end: type: number dates: type: object properties: startDate: type: string format: date endDate: type: string format: date repeatRangeOfDates: type: string totalOccurrences: type: integer unit: type: string multiplier: type: number scalePostShutInEndCriteria: type: string scalePostShutInEnd: type: string fixedExpense: type: boolean capex: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-operations summary: put-operations tags: - v1 projects description: Replace or create a list of operations documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean curtailment: type: array items: type: object properties: key: type: string category: type: string criteria: type: string value: type: array items: type: number unit: type: string description: type: string period: type: string ratioStreamBehavior: type: string scenario: type: string well: type: string shutIn: type: object properties: rows: type: array items: type: object properties: phase: type: string offsetToAsOf: type: object properties: start: type: number end: type: number dates: type: object properties: startDate: type: string format: date endDate: type: string format: date repeatRangeOfDates: type: string totalOccurrences: type: integer unit: type: string multiplier: type: number scalePostShutInEndCriteria: type: string scalePostShutInEnd: type: string fixedExpense: type: boolean capex: type: boolean responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/operations/{id}: get: operationId: get-operations-by-id summary: get-operations-by-id tags: - v1 projects description: Returns the operations document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-operations-by-id summary: delete-operations-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/capex: head: operationId: head-capex summary: head-capex tags: - v1 projects description: Returns metadata about the existing capex documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-capex summary: get-capex tags: - v1 projects description: Returns a list of capex documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-capex summary: post-capex tags: - v1 projects description: Inserts a list of capex documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean otherCapex: type: object properties: rows: type: array items: type: object properties: category: type: string tangible: type: number intangible: type: number afterEconLimit: type: boolean escalationStart: type: object properties: date: type: string format: date applyToCriteria: type: number fpd: type: number asOfDate: type: number econLimit: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string dealTerms: type: number description: type: string capexExpense: type: string fromHeaders: type: string refracDate: type: number completionEndDate: type: number completionStartDate: type: number dateRigRelease: type: number drillEndDate: type: number drillStartDate: type: number firstProdDate: type: number permitDate: type: number spudDate: type: number til: type: number customDateHeader0: type: number customDateHeader1: type: number customDateHeader2: type: number customDateHeader3: type: number customDateHeader4: type: number customDateHeader5: type: number customDateHeader6: type: number customDateHeader7: type: number customDateHeader8: type: number customDateHeader9: type: number customDateHeader10: type: number customDateHeader11: type: number customDateHeader12: type: number customDateHeader13: type: number customDateHeader14: type: number customDateHeader15: type: number customDateHeader16: type: number customDateHeader17: type: number customDateHeader18: type: number customDateHeader19: type: number firstProdDateDaily: type: number firstProdDateMonthly: type: number lastProdDateDaily: type: number lastProdDateMonthly: type: number fromSchedule: type: string padPreparationMobStart: type: number padPreparationMobEnd: type: number padPreparationStart: type: number padPreparationEnd: type: number padPreparationDemobStart: type: number padPreparationDemobEnd: type: number spudMobStart: type: number spudMobEnd: type: number spudStart: type: number spudEnd: type: number spudDemobStart: type: number spudDemobEnd: type: number drillMobStart: type: number drillMobEnd: type: number drillStart: type: number drillEnd: type: number drillDemobStart: type: number drillDemobEnd: type: number completionMobStart: type: number completionMobEnd: type: number completionStart: type: number completionEnd: type: number completionDemobStart: type: number completionDemobEnd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFpd: type: number offsetToMajorSegment: type: number offsetToEconLimit: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number date: type: string format: date scenario: type: string well: type: string drillingCost: type: object properties: tangiblePct: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string fixedCost: type: number dealTerms: type: number dollarPerFtOfVertical: type: number dollarPerFtOfHorizontal: type: number rows: type: array items: type: object properties: pctOfTotalCost: type: number offsetToFpd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number scheduleStart: type: number scheduleEnd: type: number date: type: string format: date completionCost: type: object properties: tangiblePct: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string fixedCost: type: number dealTerms: type: number dollarPerFtOfVertical: type: number dollarPerFtOfHorizontal: type: array items: type: object properties: propLl: type: number unitCost: type: number rows: type: array items: type: object properties: pctOfTotalCost: type: number offsetToFpd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number scheduleStart: type: number scheduleEnd: type: number date: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-capex summary: put-capex tags: - v1 projects description: Replace or create a list of capex documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean otherCapex: type: object properties: rows: type: array items: type: object properties: category: type: string tangible: type: number intangible: type: number afterEconLimit: type: boolean escalationStart: type: object properties: date: type: string format: date applyToCriteria: type: number fpd: type: number asOfDate: type: number econLimit: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string dealTerms: type: number description: type: string capexExpense: type: string fromHeaders: type: string refracDate: type: number completionEndDate: type: number completionStartDate: type: number dateRigRelease: type: number drillEndDate: type: number drillStartDate: type: number firstProdDate: type: number permitDate: type: number spudDate: type: number til: type: number customDateHeader0: type: number customDateHeader1: type: number customDateHeader2: type: number customDateHeader3: type: number customDateHeader4: type: number customDateHeader5: type: number customDateHeader6: type: number customDateHeader7: type: number customDateHeader8: type: number customDateHeader9: type: number customDateHeader10: type: number customDateHeader11: type: number customDateHeader12: type: number customDateHeader13: type: number customDateHeader14: type: number customDateHeader15: type: number customDateHeader16: type: number customDateHeader17: type: number customDateHeader18: type: number customDateHeader19: type: number firstProdDateDaily: type: number firstProdDateMonthly: type: number lastProdDateDaily: type: number lastProdDateMonthly: type: number fromSchedule: type: string padPreparationMobStart: type: number padPreparationMobEnd: type: number padPreparationStart: type: number padPreparationEnd: type: number padPreparationDemobStart: type: number padPreparationDemobEnd: type: number spudMobStart: type: number spudMobEnd: type: number spudStart: type: number spudEnd: type: number spudDemobStart: type: number spudDemobEnd: type: number drillMobStart: type: number drillMobEnd: type: number drillStart: type: number drillEnd: type: number drillDemobStart: type: number drillDemobEnd: type: number completionMobStart: type: number completionMobEnd: type: number completionStart: type: number completionEnd: type: number completionDemobStart: type: number completionDemobEnd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFpd: type: number offsetToMajorSegment: type: number offsetToEconLimit: type: number oilRate: type: number gasRate: type: number waterRate: type: number totalFluidRate: type: number date: type: string format: date scenario: type: string well: type: string drillingCost: type: object properties: tangiblePct: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string fixedCost: type: number dealTerms: type: number dollarPerFtOfVertical: type: number dollarPerFtOfHorizontal: type: number rows: type: array items: type: object properties: pctOfTotalCost: type: number offsetToFpd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number scheduleStart: type: number scheduleEnd: type: number date: type: string format: date completionCost: type: object properties: tangiblePct: type: number calculation: type: string escalationModel: type: string depreciationModel: type: string fixedCost: type: number dealTerms: type: number dollarPerFtOfVertical: type: number dollarPerFtOfHorizontal: type: array items: type: object properties: propLl: type: number unitCost: type: number rows: type: array items: type: object properties: pctOfTotalCost: type: number offsetToFpd: type: number offsetToAsOf: type: number offsetToDiscountDate: type: number offsetToFirstSegment: type: number scheduleStart: type: number scheduleEnd: type: number date: type: string format: date responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/capex/{id}: get: operationId: get-capex-by-id summary: get-capex-by-id tags: - v1 projects description: Returns the capex document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-capex-by-id summary: delete-capex-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/date-settings: head: operationId: head-date-settings summary: head-date-settings tags: - v1 projects description: Returns metadata about the existing date-settings documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-date-settings summary: get-date-settings tags: - v1 projects description: Returns a list of date-settings documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-date-settings summary: post-date-settings tags: - v1 projects description: Inserts a list of date-settings documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string dateSetting: type: object properties: maxWellLife: type: number asOfDate: type: object properties: date: type: string format: date dynamic: type: string fpd: type: boolean majorSegment: type: boolean aggregationDate: type: boolean discountDate: type: object properties: date: type: string format: date dynamic: type: string fpd: type: boolean majorSegment: type: boolean aggregationDate: type: boolean cashFlowPriorAsOfDate: type: boolean productionDataResolution: type: string fpdSourceHierarchy: type: object properties: firstFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string secondFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string thirdFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string fourthFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string useForecastSchedule: type: boolean cutOff: type: object properties: maxCumCashFlow: type: boolean firstNegativeCashFlow: type: boolean lastPositiveCashFlow: type: boolean noCutOff: type: boolean oilRate: type: number gasRate: type: number waterRate: type: number date: type: string format: date yearsFromAsOf: type: number linkToWells: type: string minLife: type: object properties: date: type: string format: date asOf: type: number endHist: type: boolean none: type: boolean triggerEclCapex: type: boolean includeCapex: type: boolean discount: type: number econLimitDelay: type: number alignDependentPhases: type: boolean tolerateNegativeCF: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-date-settings summary: put-date-settings tags: - v1 projects description: Replace or create a list of date-settings documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string dateSetting: type: object properties: maxWellLife: type: number asOfDate: type: object properties: date: type: string format: date dynamic: type: string fpd: type: boolean majorSegment: type: boolean aggregationDate: type: boolean discountDate: type: object properties: date: type: string format: date dynamic: type: string fpd: type: boolean majorSegment: type: boolean aggregationDate: type: boolean cashFlowPriorAsOfDate: type: boolean productionDataResolution: type: string fpdSourceHierarchy: type: object properties: firstFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string secondFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string thirdFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string fourthFpdSource: type: object properties: date: type: string format: date wellHeader: type: boolean forecast: type: boolean notUsed: type: boolean productionData: type: boolean linkToWells: type: string useForecastSchedule: type: boolean cutOff: type: object properties: maxCumCashFlow: type: boolean firstNegativeCashFlow: type: boolean lastPositiveCashFlow: type: boolean noCutOff: type: boolean oilRate: type: number gasRate: type: number waterRate: type: number date: type: string format: date yearsFromAsOf: type: number linkToWells: type: string minLife: type: object properties: date: type: string format: date asOf: type: number endHist: type: boolean none: type: boolean triggerEclCapex: type: boolean includeCapex: type: boolean discount: type: number econLimitDelay: type: number alignDependentPhases: type: boolean tolerateNegativeCF: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/date-settings/{id}: get: operationId: get-date-settings-by-id summary: get-date-settings-by-id tags: - v1 projects description: Returns the date-settings document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-date-settings-by-id summary: delete-date-settings-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/depreciation: head: operationId: head-depreciation summary: head-depreciation tags: - v1 projects description: Returns metadata about the existing depreciation documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded get: operationId: get-depreciation summary: get-depreciation tags: - v1 projects description: Returns a list of depreciation documents. parameters: - name: projectId in: path required: true schema: type: string - name: skip in: query required: false schema: type: integer description: number of items to skip - name: take in: query required: false schema: type: integer description: max records to return - name: sort in: query required: false schema: type: string description: field to sort by, including + or - at the beginning for ascending or descending order, respectively - name: cursor in: query required: false schema: type: string description: used in pagination to get the next page - name: createdAt in: query required: false schema: type: string description: filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z - name: name in: query required: false schema: type: string description: filter by name - name: well in: query required: false schema: type: string description: filter by well - name: unique in: query required: false schema: type: string description: filter by unique - name: updatedAt in: query required: false schema: type: string description: filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded post: operationId: post-depreciation summary: post-depreciation tags: - v1 projects description: Inserts a list of depreciation documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string depreciation: type: object properties: modelType: type: string taxCredit: type: number tangibleImmediateDepletion: type: number intangibleImmediateDepletion: type: number tangibleDepletionModel: type: string intangibleDepletionModel: type: string tcjaBonus: type: boolean bonusDepreciation: type: array items: type: object properties: tangibleBonusDepreciation: type: number intangibleBonusDepreciation: type: number depreciation: type: array items: type: object properties: intanFactor: type: number tanFactor: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded put: operationId: put-depreciation summary: put-depreciation tags: - v1 projects description: Replace or create a list of depreciation documents. parameters: - name: projectId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: type: string unique: type: boolean scenario: type: string well: type: string depreciation: type: object properties: modelType: type: string taxCredit: type: number tangibleImmediateDepletion: type: number intangibleImmediateDepletion: type: number tangibleDepletionModel: type: string intangibleDepletionModel: type: string tcjaBonus: type: boolean bonusDepreciation: type: array items: type: object properties: tangibleBonusDepreciation: type: number intangibleBonusDepreciation: type: number depreciation: type: array items: type: object properties: intanFactor: type: number tanFactor: type: number responses: '201': description: Created '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/econ-models/depreciation/{id}: get: operationId: get-depreciation-by-id summary: get-depreciation-by-id tags: - v1 projects description: Returns the depreciation document that matches the given id. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded delete: operationId: delete-depreciation-by-id summary: delete-depreciation-by-id tags: - v1 projects description: Delete the assumptions document that matches the given id scoped to projectId project. parameters: - name: projectId in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded /v1/projects/{projectId}/custom-columns/{customColumn}: get: operationId: get-project-custom-columns summary: get-project-custom-columns tags: - v1 projects description: Returns projects custom columns parameters: - name: projectId in: path required: true schema: type: string - name: customColumn in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found '429': description: Too many requests - rate limit exceeded components: securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: Company API key from the ComboCurve API & Sync page. bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Signed bearer token generated from the Service Account Key.