# Petro.ai API Reference

# /api/ActivityLogs

# GET

# Summary

Find ActivityLog document(s)

# Description

Finds an exisiting ActivityLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[ActivityLog]

# PUT

# Summary

Upsert ActivityLog document(s)

# Description

Replaces or inserts a ActivityLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ActivityLogsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ActivityLog]

# POST

# Summary

Insert ActivityLog document(s)

# Description

Inserts a ActivityLog document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ActivityLogsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ActivityLog]

# DELETE

# Summary

Delete ActivityLog document(s)

# Description

Deletes an exisiting ActivityLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ActivityLogsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ActivityLog]

# PATCH

# Summary

Update ActivityLog document(s)

# Description

Updates an exisiting ActivityLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ActivityLogsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ActivityLog]

# /api/AppSettings

# GET

# Summary

Find AppSetting document(s)

# Description

Finds an exisiting AppSetting document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[AppSetting]

# PUT

# Summary

Upsert AppSetting document(s)

# Description

Replaces or inserts a AppSetting document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AppSettingsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[AppSetting]

# POST

# Summary

Insert AppSetting document(s)

# Description

Inserts a AppSetting document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AppSettingsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[AppSetting]

# DELETE

# Summary

Delete AppSetting document(s)

# Description

Deletes an exisiting AppSetting document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AppSettingsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[AppSetting]

# PATCH

# Summary

Update AppSetting document(s)

# Description

Updates an exisiting AppSetting document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AppSettingsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[AppSetting]

# /api/AppSettings/reportingUnits

# GET

# Summary

Get Reporting Units

# Description

Gets the reporting units definition.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult[UnitsDefinition]

# /api/BaseGeoData

# GET

# Summary

Find BaseGeoData document(s)

# Description

Finds an exisiting BaseGeoData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[BaseGeoData]

# PUT

# Summary

Upsert BaseGeoData document(s)

# Description

Replaces or inserts a BaseGeoData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	BaseGeoDataUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[BaseGeoData]

# POST

# Summary

Insert BaseGeoData document(s)

# Description

Inserts a BaseGeoData document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	BaseGeoDataInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[BaseGeoData]

# DELETE

# Summary

Delete BaseGeoData document(s)

# Description

Deletes an exisiting BaseGeoData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	BaseGeoDataDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[BaseGeoData]

# PATCH

# Summary

Update BaseGeoData document(s)

# Description

Updates an exisiting BaseGeoData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	BaseGeoDataUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[BaseGeoData]

# /api/CashFlows

# GET

# Summary

Find CashFlow document(s)

# Description

Finds an exisiting CashFlow document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
PWIs	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CashFlow]

# PUT

# Summary

Upsert CashFlow document(s)

# Description

Replaces or inserts a CashFlow document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CashFlowsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CashFlow]

# POST

# Summary

Insert CashFlow document(s)

# Description

Inserts a CashFlow document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CashFlowsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CashFlow]

# DELETE

# Summary

Delete CashFlow document(s)

# Description

Deletes an exisiting CashFlow document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CashFlowsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CashFlow]

# PATCH

# Summary

Update CashFlow document(s)

# Description

Updates an exisiting CashFlow document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CashFlowsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CashFlow]

# /api/CompletionDataPoints

# GET

# Summary

Find CompletionDataPoint document(s)

# Description

Finds an exisiting CompletionDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
JobIds	query	No	[ string ]
ZoneIds	query	No	[ string ]
StartTime	query	No	dateTime
EndTime	query	No	dateTime
IntervalSeconds	query	No	double
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionDataPoint]

# PUT

# Summary

Upsert CompletionDataPoint document(s)

# Description

Replaces or inserts a CompletionDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionDataPointsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionDataPoint]

# POST

# Summary

Insert CompletionDataPoint document(s)

# Description

Inserts a CompletionDataPoint document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionDataPointsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionDataPoint]

# DELETE

# Summary

Delete CompletionDataPoint document(s)

# Description

Deletes an exisiting CompletionDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionDataPointsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionDataPoint]

# PATCH

# Summary

Update CompletionDataPoint document(s)

# Description

Updates an exisiting CompletionDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionDataPointsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionDataPoint]

# /api/CompletionEvents

# GET

# Summary

Find CompletionEvent document(s)

# Description

Finds an exisiting CompletionEvent document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
JobIds	query	No	[ string ]
ZoneIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionEvent]

# PUT

# Summary

Upsert CompletionEvent document(s)

# Description

Replaces or inserts a CompletionEvent document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionEventsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionEvent]

# POST

# Summary

Insert CompletionEvent document(s)

# Description

Inserts a CompletionEvent document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionEventsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionEvent]

# DELETE

# Summary

Delete CompletionEvent document(s)

# Description

Deletes an exisiting CompletionEvent document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionEventsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionEvent]

# PATCH

# Summary

Update CompletionEvent document(s)

# Description

Updates an exisiting CompletionEvent document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionEventsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionEvent]

# /api/CompletionJobs

# GET

# Summary

Find CompletionJob document(s)

# Description

Finds an exisiting CompletionJob document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
FluidSystems	query	No	[ string ]
Operators	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionJob]

# PUT

# Summary

Upsert CompletionJob document(s)

# Description

Replaces or inserts a CompletionJob document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionJobsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionJob]

# POST

# Summary

Insert CompletionJob document(s)

# Description

Inserts a CompletionJob document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionJobsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionJob]

# DELETE

# Summary

Delete CompletionJob document(s)

# Description

Deletes an exisiting CompletionJob document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionJobsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionJob]

# PATCH

# Summary

Update CompletionJob document(s)

# Description

Updates an exisiting CompletionJob document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionJobsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionJob]

# /api/CompletionZones

# GET

# Summary

Find CompletionZone document(s)

# Description

Finds an exisiting CompletionZone document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
JobIds	query	No	[ string ]
Stages	query	No	[ integer ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionZone]

# PUT

# Summary

Upsert CompletionZone document(s)

# Description

Replaces or inserts a CompletionZone document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionZonesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionZone]

# POST

# Summary

Insert CompletionZone document(s)

# Description

Inserts a CompletionZone document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionZonesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionZone]

# DELETE

# Summary

Delete CompletionZone document(s)

# Description

Deletes an exisiting CompletionZone document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionZonesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionZone]

# PATCH

# Summary

Update CompletionZone document(s)

# Description

Updates an exisiting CompletionZone document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CompletionZonesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CompletionZone]

# /api/CustomVariables

# GET

# Summary

Find CustomVariable document(s)

# Description

Finds an exisiting CustomVariable document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[CustomVariable]

# PUT

# Summary

Upsert CustomVariable document(s)

# Description

Replaces or inserts a CustomVariable document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CustomVariablesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CustomVariable]

# POST

# Summary

Insert CustomVariable document(s)

# Description

Inserts a CustomVariable document(s) into the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CustomVariablesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CustomVariable]

# DELETE

# Summary

Delete CustomVariable document(s)

# Description

Deletes an exisiting CustomVariable document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CustomVariablesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CustomVariable]

# PATCH

# Summary

Update CustomVariable document(s)

# Description

Updates an exisiting CustomVariable document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CustomVariablesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[CustomVariable]

# /api/DailyProduction

# GET

# Summary

Find daily production

# Description

Finds exisiting daily production within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Day	query	No	dateTime
PWIs	query	No	[ string ]
WellIds	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DailyProduction]

# PUT

# Summary

Upsert daily production

# Description

Replaces or inserts daily production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DailyProductionUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DailyProduction]

# POST

# Summary

Insert daily production

# Description

Inserts exisiting daily production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DailyProductionInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DailyProduction]

# DELETE

# Summary

Delete daily production

# Description

Deletes exisiting daily production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DailyProductionDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DailyProduction]

# /api/Data

# DELETE

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetroFileDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[IActionResult]

# /api/DataTypeSchemas

# GET

# Summary

Find data type schema(s)

# Description

Finds a schema or schema(s) for a data type(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
DataTypes	query	Collection of data types names to limit by.	No	[ string ]

# Responses

Code	Description	Schema
200	Success	DataTypeSchemasResults
400	Bad Request	ProblemDetails

# /api/DataTypeSchemas/GetPetroDataTypes

# GET

# Summary

Find petro data types

# Description

Finds all data type within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult[String]

# /api/DataTypeSchemas/GetSchema

# GET

# Summary

Gets the JSON Schema for the provided types

# Description

Finds a schema or schema(s) for a data type(s) within class structure.

# Parameters

Name	Located in	Description	Required	Schema
DataTypes	query	Collection of data types names to limit by.	No	[ string ]

# Responses

Code	Description	Schema
200	Success	JSchema

# /api/DeclineCurveAnalysisModels

# GET

# Summary

Find Decline Curve Analysis Models document(s)

# Description

Finds an exisiting Decline Curve Analysis Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
PWIs	query	No	[ string ]
PIDs	query	No	[ string ]
IsLatest	query	No	boolean
WorkflowState	query	No	[ string ]
Version	query	No	integer
IsTypeCurve	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# PUT

# Summary

Upsert Decline Curve Analysis Models

# Description

Replaces or inserts Decline Curve Analysis Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurveAnalysisModelsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# POST

# Summary

Insert WellDeclineCurveAnalysisModel

# Description

Inserts exisiting WellDeclineCurveAnalysisModel within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurveAnalysisModelsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# DELETE

# Summary

Delete Decline Curve Analysis Models

# Description

Deletes exisiting Decline Curve Analysis Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurveAnalysisModelsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# PATCH

# Summary

Update Decline Curve Analysis Models

# Description

Updates exisiting Decline Curve Analysis Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurveAnalysisModelsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# /api/DeclineCurveAnalysisModels/large

# POST

# Summary

Find Decline Curve Analysis Models document(s)

# Description

Finds an exisiting Decline Curve Analysis Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurveAnalysisModelsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# /api/DeclineCurveAnalysisModels/forecast

# POST

# Summary

Forecast a model

# Description

Forecasts a full well decline curve model

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	ForecastRequest

# Responses

Code	Description	Schema
200	Success	PetroResult[ForecastResult]

# /api/DeclineCurveAnalysisModels/updateCurveHandles

# POST

# Summary

Update a model using curve handles

# Description

Returns an updated model based on the curve handles

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	DeclineSegmentCurveHandles

# Responses

Code	Description	Schema
200	Success	PetroResult[ForecastResult]

# /api/DeclineCurveAnalysisModels/quickForecast

# POST

# Summary

Quick forecast wells in a case

# Description

Creates a well decline for each well in the case, but does not save them

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	QuickWellForecast

# Responses

Code	Description	Schema
200	Success	PetroResult[FullFluidDeclineCurveAnalysis]

# /api/DeclineCurveAnalysisModels/saveForecast

# POST

# Summary

Save a forecast to a model

# Description

Stores the forecast for a model

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	ForecastRequest

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# /api/DeclineCurveAnalysisModels/changeState

# POST

# Summary

Change model state

# Description

Creates a new model from the provided id with the provided state

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ChangeStateRequest

# Responses

Code	Description	Schema
200	Success	PetroResult[DeclineCurveAnalysisModel]

# /api/DeclineCurveAnalysisModels/forecastFeed

# POST

# Summary

Get Forecast Feed for User

# Description

Returns the list of cases the user is responsible for as well as the states of the decline models

# Parameters

Name	Located in	Description	Required	Schema
option	body		No	ForecaseFeedRequest

# Responses

Code	Description	Schema
200	Success	PetroResult[ForecastFeedResult]

# /api/DeclineCurveAnalysisModels/UploadModelsFromFile

# POST

# Summary

Create decline curve analysis models from ARIES files

# Description

Upload ARIES files to create decline curve analysis models

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult

# /api/DeclineCurveAnalysisModels/DeclineCurveFromAriesExpressions

# POST

# Summary

Create a decline using ARIES syntax

# Description

Creates a decline

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineFromAriesOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[FullFluidDeclineCurveAnalysis]

# /api/DownholeEquipment

# GET

# Summary

Find DownholeEquipment document(s)

# Description

Finds an exisiting DownholeEquipment document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DownholeEquipment]

# PUT

# Summary

Upsert DownholeEquipment document(s)

# Description

Replaces or inserts a DownholeEquipment document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DownholeEquipmentUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DownholeEquipment]

# POST

# Summary

Insert DownholeEquipment document(s)

# Description

Inserts a DownholeEquipment document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DownholeEquipmentInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DownholeEquipment]

# DELETE

# Summary

Delete DownholeEquipment document(s)

# Description

Deletes an exisiting DownholeEquipment document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DownholeEquipmentDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DownholeEquipment]

# PATCH

# Summary

Update DownholeEquipment document(s)

# Description

Updates an exisiting DownholeEquipment document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DownholeEquipmentUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DownholeEquipment]

# /api/DrillingAFECosts

# GET

# Summary

Find drilling AFE cost document(s)

# Description

Finds an exisiting drilling AFE cost document or documents within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
PWIs	query	No	[ string ]
AfeNumbers	query	No	[ string ]
AccountCodes	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
WellIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingAFECost]

# PUT

# Summary

Upsert drilling AFE cost document(s)

# Description

Replaces or inserts a drilling AFE cost document or documents within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingAFECostsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingAFECost]

# POST

# Summary

Insert drilling AFE cost document(s)

# Description

Inserts a drilling AFE cost document or documents into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingAFECostsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingAFECost]

# DELETE

# Summary

Delete drilling AFE cost document(s)

# Description

Deletes an exisiting drilling AFE cost document or documents within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingAFECostsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingAFECost]

# PATCH

# Summary

Update drilling AFE cost document(s)

# Description

Updates an existing drilling AFE cost document or documents within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingAFECostsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingAFECost]

# /api/DrillingBitRunLogs

# GET

# Summary

Find drilling bit run log(s)

# Description

Finds an exisiting drilling bit run log or logs within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
JobCategories	query	No	[ string ]
RigNames	query	No	[ string ]
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingBitRunLog]

# PUT

# Summary

Upsert drilling bit run log(s)

# Description

Replaces or inserts an drilling bit run log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingBitRunLogsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingBitRunLog]

# POST

# Summary

Insert drilling bit run log(s)

# Description

Inserts a drilling bit run log or logs into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingBitRunLogsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingBitRunLog]

# DELETE

# Summary

Delete drilling bit run log(s)

# Description

Deletes an exisiting drilling bit run log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingBitRunLogsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingBitRunLog]

# PATCH

# Summary

Update a drilling bit run log(s)

# Description

Updates an existing drilling bit run log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingBitRunLogsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingBitRunLog]

# /api/DrillingRigData

# GET

# Summary

Find Rig Data

# Description

Finds exisiting Rig Data within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
IntervalSeconds	query	No	double
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[RigData]

# PUT

# Summary

Upsert Rig Data

# Description

Replaces or inserts Rig Data within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingRigDataUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigData]

# POST

# Summary

Insert Rig Data

# Description

Inserts exisiting Rig Data within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingRigDataInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigData]

# DELETE

# Summary

Delete Rig Data

# Description

Deletes exisiting Rig Data within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingRigDataDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigData]

# PATCH

# Summary

Update Rig Data

# Description

Updates exisiting Rig Data within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingRigDataUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigData]

# /api/DrillingTimeLogs

# GET

# Summary

Find drilling time log(s)

# Description

Finds an exisiting drilling log or logs within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
JobCategories	query	No	[ string ]
OpsCodes	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingTimeLog]

# PUT

# Summary

Upsert drilling time log(s)

# Description

Replaces or inserts an drilling log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingTimeLogsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingTimeLog]

# POST

# Summary

Insert drilling time log(s)

# Description

Inserts a drilling log or logs into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingTimeLogsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingTimeLog]

# DELETE

# Summary

Delete drilling time log(s)

# Description

Deletes an exisiting drilling log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingTimeLogsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingTimeLog]

# PATCH

# Summary

Update a drilling time log(s)

# Description

Updates an existing drilling log or logs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingTimeLogsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[DrillingTimeLog]

# /api/DrillingWellStates

# GET

# Summary

Find DrillingWellState document(s)

# Description

Finds an exisiting DrillingWellState document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
ClassifierName	query	No	[ string ]
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellState]

# PUT

# Summary

Upsert DrillingWellState document(s)

# Description

Replaces or inserts a DrillingWellState document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingWellStatesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellState]

# POST

# Summary

Insert DrillingWellState document(s)

# Description

Inserts a DrillingWellState document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingWellStatesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellState]

# DELETE

# Summary

Delete DrillingWellState document(s)

# Description

Deletes an exisiting DrillingWellState document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingWellStatesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellState]

# PATCH

# Summary

Update DrillingWellState document(s)

# Description

Updates an exisiting DrillingWellState document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DrillingWellStatesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellState]

# /api/EconomicScenarios

# GET

# Summary

Find EconomicScenario document(s)

# Description

Finds an exisiting EconomicScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
EconomicScenarios	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[EconomicScenario]

# PUT

# Summary

Upsert EconomicScenario document(s)

# Description

Replaces or inserts a EconomicScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EconomicScenariosUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EconomicScenario]

# POST

# Summary

Insert EconomicScenario document(s)

# Description

Inserts a EconomicScenario document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EconomicScenariosInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EconomicScenario]

# DELETE

# Summary

Delete EconomicScenario document(s)

# Description

Deletes an exisiting EconomicScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EconomicScenariosDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EconomicScenario]

# PATCH

# Summary

Update EconomicScenario document(s)

# Description

Updates an exisiting EconomicScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EconomicScenariosUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EconomicScenario]

# /api/email

# POST

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SendTestEmailPostOptions

# Responses

Code	Description
200	Success

# /api/EvaluationSummaries

# GET

# Summary

Find EvaluationSummarie document(s)

# Description

Finds an exisiting EvaluationSummarie document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[EvaluationSummary]

# PUT

# Summary

Upsert EvaluationSummarie document(s)

# Description

Replaces or inserts a EvaluationSummarie document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EvaluationSummariesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EvaluationSummary]

# POST

# Summary

Insert EvaluationSummarie document(s)

# Description

Inserts a EvaluationSummarie document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EvaluationSummariesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EvaluationSummary]

# DELETE

# Summary

Delete EvaluationSummarie document(s)

# Description

Deletes an exisiting EvaluationSummarie document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EvaluationSummariesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EvaluationSummary]

# PATCH

# Summary

Update EvaluationSummarie document(s)

# Description

Updates an exisiting EvaluationSummarie document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	EvaluationSummariesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[EvaluationSummary]

# /api/ExportData/aries

# GET

# Summary

Endpoint for retrieving an ARIES Economics table flat .txt file

# Description

Get Aries Economic Flat File Text

# Parameters

Name	Located in	Required	Schema
PetronIds	query	No	[ string ]
WorkFlowStates	query	No	[ string ]
QualifierName	query	No	string
TruncateCurve	query	No	boolean

# Responses

Code	Description	Schema
200	Success	AriesTextOutput

# /api/ExportData/ariesDownload

# GET

# Parameters

Name	Located in	Required	Schema
PetronIds	query	No	[ string ]
WorkFlowStates	query	No	[ string ]
QualifierName	query	No	string
TruncateCurve	query	No	boolean

# Responses

Code	Description
200	Success

# /api/FractureNetworks

# GET

# Summary

Find FractureNetwork document(s)

# Description

Finds an exisiting FractureNetwork document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Required	Schema
PWIs	query	No	[ string ]
StageNumbers	query	No	[ integer ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[FractureNetwork]

# PUT

# Summary

Upsert FractureNetwork document(s)

# Description

Replaces or inserts a FractureNetwork document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	FractureNetworksUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[FractureNetwork]

# POST

# Summary

Insert FractureNetwork document(s)

# Description

Inserts a FractureNetwork document(s) into the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	FractureNetworksInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[FractureNetwork]

# DELETE

# Summary

Delete FractureNetwork document(s)

# Description

Deletes an exisiting FractureNetwork document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	FractureNetworksDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[FractureNetwork]

# PATCH

# Summary

Update FractureNetwork document(s)

# Description

Updates an exisiting FractureNetwork document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	FractureNetworksUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[FractureNetwork]

# /api/GeoDataPoints

# GET

# Summary

Find GeoDataPoint document(s)

# Description

Finds an exisiting GeoDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
GeoDataIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoDataPoint]

# PUT

# Summary

Upsert GeoDataPoint document(s)

# Description

Replaces or inserts a GeoDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoDataPointsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoDataPoint]

# POST

# Summary

Insert GeoDataPoint document(s)

# Description

Inserts a GeoDataPoint document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoDataPointsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoDataPoint]

# DELETE

# Summary

Delete GeoDataPoint document(s)

# Description

Deletes an exisiting GeoDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoDataPointsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoDataPoint]

# PATCH

# Summary

Update GeoDataPoint document(s)

# Description

Updates an exisiting GeoDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoDataPointsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoDataPoint]

# /api/GeoGridCells

# GET

# Summary

Find GeoGridCell document(s)

# Description

Finds an exisiting GeoGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGridCell]

# PUT

# Summary

Upsert GeoGridCell document(s)

# Description

Replaces or inserts a GeoGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridCellsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGridCell]

# POST

# Summary

Insert GeoGridCell document(s)

# Description

Inserts a GeoGridCell document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridCellsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGridCell]

# DELETE

# Summary

Delete GeoGridCell document(s)

# Description

Deletes an exisiting GeoGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridCellsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGridCell]

# PATCH

# Summary

Update GeoGridCell document(s)

# Description

Updates an exisiting GeoGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridCellsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGridCell]

# /api/GeoGrids

# GET

# Summary

Find GeoGrid document(s)

# Description

Finds an exisiting GeoGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGrid]

# PUT

# Summary

Upsert GeoGrid document(s)

# Description

Replaces or inserts a GeoGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGrid]

# POST

# Summary

Insert GeoGrid document(s)

# Description

Inserts a GeoGrid document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGrid]

# DELETE

# Summary

Delete GeoGrid document(s)

# Description

Deletes an exisiting GeoGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGrid]

# PATCH

# Summary

Update GeoGrid document(s)

# Description

Updates an exisiting GeoGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoGridsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoGrid]

# /api/GeoIntervalData

# GET

# Summary

Find GeoIntervalData document(s)

# Description

Finds an exisiting GeoIntervalData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
SourceHashes	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoIntervalData]

# PUT

# Summary

Upsert GeoIntervalData document(s)

# Description

Replaces or inserts a GeoIntervalData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoIntervalDataUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoIntervalData]

# POST

# Summary

Insert GeoIntervalData document(s)

# Description

Inserts a GeoIntervalData document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoIntervalDataInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoIntervalData]

# DELETE

# Summary

Delete GeoIntervalData document(s)

# Description

Deletes an exisiting GeoIntervalData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoIntervalDataDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoIntervalData]

# PATCH

# Summary

Update GeoIntervalData document(s)

# Description

Updates an exisiting GeoIntervalData document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoIntervalDataUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoIntervalData]

# /api/GeoVolumes

# GET

# Summary

Find GeoVolume document(s)

# Description

Finds an exisiting GeoVolume document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolume]

# PUT

# Summary

Upsert GeoVolume document(s)

# Description

Replaces or inserts a GeoVolume document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolume]

# POST

# Summary

Insert GeoVolume document(s)

# Description

Inserts a GeoVolume document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolume]

# DELETE

# Summary

Delete GeoVolume document(s)

# Description

Deletes an exisiting GeoVolume document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolume]

# PATCH

# Summary

Update GeoVolume document(s)

# Description

Updates an exisiting GeoVolume document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolume]

# /api/GeoVolumeTraces

# GET

# Summary

Find GeoVolumeTrace document(s)

# Description

Finds an exisiting GeoVolumeTrace document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolumeTrace]

# PUT

# Summary

Upsert GeoVolumeTrace document(s)

# Description

Replaces or inserts a GeoVolumeTrace document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumeTracesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolumeTrace]

# POST

# Summary

Insert GeoVolumeTrace document(s)

# Description

Inserts a GeoVolumeTrace document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumeTracesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolumeTrace]

# DELETE

# Summary

Delete GeoVolumeTrace document(s)

# Description

Deletes an exisiting GeoVolumeTrace document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumeTracesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolumeTrace]

# PATCH

# Summary

Update GeoVolumeTrace document(s)

# Description

Updates an exisiting GeoVolumeTrace document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	GeoVolumeTracesUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[GeoVolumeTrace]

# /api/info

# GET

# Summary

Find instance information

# Description

Gets information about the PetroManager instance

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroManagerInfo
400	Bad Request	ProblemDetails

# /api/JobDefinitions

# GET

# Summary

Find job definition(s)

# Description

Finds an job definition or definitions within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	object

# /api/JobDefinitions/{jobName}

# GET

# Summary

Get job parameters

# Description

Gets job parameters based on a job name.

# Parameters

Name	Located in	Description	Required	Schema
jobName	path		Yes	string

# Responses

Code	Description	Schema
200	Success	string

# POST

# Summary

Validate job definition(s)

# Description

Validate a new job definition or definitions within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
jobName	path		Yes	string
parameters	body		No	object

# Responses

Code	Description	Schema
200	Success	JobValidationResponse

# /api/JobResults

# GET

# Summary

Find job result(s)

# Description

Finds an exisiting job result or results within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
JobIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[JobResult]

# PUT

# Summary

Upsert job result(s)

# Description

Replaces or inserts a job result or results within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobResultsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[JobResult]

# POST

# Summary

Insert job result(s)

# Description

Inserts a job result or results into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobResultsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[JobResult]

# DELETE

# Summary

Delete job result(s)

# Description

Deletes an exisiting job result or results within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobResultsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[JobResult]

# /api/Jobs

# GET

# Summary

Find jobs(s)

# Description

Finds an exisiting job or jobs within the PetroWorker queue.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
ParentIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# PUT

# Summary

Enqueue/Update a job(s)

# Description

Enqueues/Udpates (upserts) a job or jobs to be executed by PetroWorker.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# POST

# Summary

Enqueue new job(s)

# Description

Enqueues a new job to be executed by PetroWorker.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# DELETE

# Summary

Delete job(s)

# Description

Deletes an exisiting job or jobs within the PetroWorker queue.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# PATCH

# Summary

Update jobs(s)

# Description

Updates an exisiting job or jobs within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	JobsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# /api/Jobs/{jobId}

# POST

# Summary

Execute exisiting job

# Description

Executes an exisiting Petro job.

# Parameters

Name	Located in	Description	Required	Schema
jobId	path		Yes	string

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# /api/MicroseismicEvents

# GET

# Summary

Find MicroseismicEvent document(s)

# Description

Finds an exisiting MicroseismicEvent document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Required	Schema
PWIs	query	No	[ string ]
StageNumbers	query	No	[ integer ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[MicroseismicEvent]

# PUT

# Summary

Upsert MicroseismicEvent document(s)

# Description

Replaces or inserts a MicroseismicEvent document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MicroseismicEventsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MicroseismicEvent]

# POST

# Summary

Insert MicroseismicEvent document(s)

# Description

Inserts a MicroseismicEvent document(s) into the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MicroseismicEventsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MicroseismicEvent]

# DELETE

# Summary

Delete MicroseismicEvent document(s)

# Description

Deletes an exisiting MicroseismicEvent document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MicroseismicEventsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MicroseismicEvent]

# PATCH

# Summary

Update MicroseismicEvent document(s)

# Description

Updates an exisiting MicroseismicEvent document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MicroseismicEventsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MicroseismicEvent]

# /api/MLModels

# GET

# Summary

Find ML Models document(s)

# Description

Finds an exisiting ML Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
PIDs	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# PUT

# Summary

Upsert ML Models

# Description

Replaces or inserts ML Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# POST

# Summary

Insert ML Models

# Description

Inserts exisiting ML Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# DELETE

# Summary

Delete ML Models

# Description

Deletes exisiting ML Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# PATCH

# Summary

Update ML Models

# Description

Updates exisiting ML Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# /api/MLModels/large

# POST

# Summary

Find ML Models document(s)

# Description

Finds an exisiting ML Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# /api/MLModels/{modelId}/predict

# PATCH

# Summary

Predict using a Model

# Description

Predicts an output described in the model

# Parameters

Name	Located in	Description	Required	Schema
modelId	path		Yes	string
parameters	body		No	[ MLModelInput ]

# Responses

Code	Description	Schema
200	Success	ScoreResult

# /api/MLModels/Create

# POST

# Summary

Create ML Model

# Description

Creates an empty ML Model with Default params

# Parameters

Name	Located in	Description	Required	Schema
option	body		No	MLModelsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# /api/MLModels/get_model_learners

# POST

# Summary

Get available learners

# Description

Get the list of learner available for training

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	[ ModelDefinition ]

# /api/MLModels/save_ml_model

# POST

# Summary

Save ML Model

# Description

Save the ML Model

# Parameters

Name	Located in	Description	Required	Schema
model	body		No	MLModel

# Responses

Code	Description	Schema
200	Success	boolean

# /api/MLModels/train_ml_model

# POST

# Summary

Train ML Model

# Description

Train the ML Model

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsTrainOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MLModel]

# /api/MLModels/get_irrelevant_features

# POST

# Summary

List of irrelevant features

# Description

Get the list of irrelevant features

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsFeatureSelectionOptions

# Responses

Code	Description	Schema
200	Success	[ string ]

# /api/MLModels/auto_select_features

# POST

# Summary

Auto select features

# Description

Get the list of auto select features

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MLModelsFeatureSelectionOptions

# Responses

Code	Description	Schema
200	Success	FeatureSelectionResult

# /api/Models

# GET

# Summary

Find Models document(s)

# Description

Finds an exisiting Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
Types	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# PUT

# Summary

Upsert Models

# Description

Replaces or inserts Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ModelsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# POST

# Summary

Insert Models

# Description

Inserts exisiting Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ModelsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# DELETE

# Summary

Delete Models

# Description

Deletes exisiting Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ModelsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# PATCH

# Summary

Update Models

# Description

Updates exisiting Models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ModelsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# /api/Models/large

# POST

# Summary

Find Models document(s)

# Description

Finds an exisiting Models document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ModelsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Model]

# /api/MonthlyProduction

# GET

# Summary

Find monthly production

# Description

Finds exisiting monthly production within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Month	query	No	dateTime
PWIs	query	No	[ string ]
WellIds	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[MonthlyProduction]

# PUT

# Summary

Upsert monthly production

# Description

Replaces or inserts monthly production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MonthlyProductionUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MonthlyProduction]

# POST

# Summary

Insert monthly production

# Description

Inserts exisiting monthly production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MonthlyProductionInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MonthlyProduction]

# DELETE

# Summary

Delete monthly production

# Description

Deletes exisiting monthly production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	MonthlyProductionDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[MonthlyProduction]

# /api/PetronKernels

# GET

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult[PetronKernelsInfo]

# POST

# Summary

Runs a Petron Task

# Description

Runs a Petron Task

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetronTaskRequest

# Responses

Code	Description	Schema
200	Success	PetroResult

# /api/PetronKernels/{taskId}/results

# GET

# Parameters

Name	Located in	Description	Required	Schema
taskId	path		Yes	string

# Responses

Code	Description	Schema
200	Success	PetroResult

# /api/PetronKernels/Collect

# POST

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult[PetronKernelsInfo]

# /api/PetronKernels/Kill

# POST

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	KernelList

# Responses

Code	Description	Schema
200	Success	PetroResult[PetronKernelsInfo]

# /api/Petrons/Create

# GET

# Summary

Create a new Petron

# Description

Create a new Petron by name and returns it

# Parameters

Name	Located in	Description	Required	Schema
name	query		No	string
type	query		No	string

# Responses

Code	Description	Schema
200	Success	Petron

# /api/Petrons/wellData

# GET

# Summary

Get Petron Well Data

# Description

Get the well data for the Petron

# Parameters

Name	Located in	Description	Required	Schema
petronId	query		No	string

# Responses

Code	Description	Schema
200	Success	DataTableBuffer

# /api/Petrons/{petronId}/wells

# GET

# Summary

Get Petron Well Data

# Description

Get the well data for the Petron

# Parameters

Name	Located in	Required	Schema
petronId	path	Yes	string
WellIds	query	No	[ string ]
Statuses	query	No	[ string ]
SurfaceLocationBounds	query	No	[ double ]
BottomHoleLocationBounds	query	No	[ double ]
MidPointLocationBounds	query	No	[ double ]
ReserveCategories	query	No	[ string ]
IsVirtual	query	No	boolean
PIDs	query	No	[ string ]
NumGridCells	query	No	integer
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# /api/Petrons/WellStatData

# GET

# Summary

Get Petron Well Stat Data

# Description

Get the well stat data for the Petron

# Parameters

Name	Located in	Description	Required	Schema
petronId	query		No	string

# Responses

Code	Description	Schema
200	Success	DataTableBuffer

# /api/Petrons/{petronId}/forecastTable

# GET

# Summary

Get Forecast Table Data for a Petron

# Description

Get the relevant forecast data for a Petron

# Parameters

Name	Located in	Description	Required	Schema
petronId	path		Yes	string

# Responses

Code	Description	Schema
200	Success	DataTableBuffer

# /api/Petrons/{petronId}/children

# GET

# Summary

Get Child Petrons

# Description

Get the child petrons for the route petron

# Parameters

Name	Located in	Description	Required	Schema
petronId	path		Yes	string

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# /api/Petrons

# GET

# Summary

Find Petron document(s)

# Description

Finds an exisiting Petron document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Types	query	No	[ string ]
OwnerIds	query	No	[ string ]
AssigneeIds	query	No	[ string ]
ApproverIds	query	No	[ string ]
IsPublic	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# PUT

# Summary

Upsert Petrons

# Description

Replaces or inserts Petrons within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetronsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# POST

# Summary

Insert Petrons

# Description

Inserts exisiting Petrons within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetronsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# DELETE

# Summary

Delete Petrons

# Description

Deletes exisiting Petrons within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetronsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# PATCH

# Summary

Update Petrons

# Description

Updates exisiting Petrons within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PetronsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# /api/Petrons/Action

# POST

# Summary

Runs a Petron Action

# Description

Runs a Petron Action

# Parameters

Name	Located in	Description	Required	Schema
action	body		No	PetronAction

# Responses

Code	Description	Schema
200	Success	PetronActionResult

# /api/Petrons/CreateWellStats

# POST

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	CreateWellStatsJobParameters

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# /api/Petrons/AutoForecast

# POST

# Summary

Batch forecast wells in a petron

# Description

Creates a well decline for each well in the petron

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	AutoForecastJobParameters

# Responses

Code	Description	Schema
200	Success	PetroResult[AutoForecastResult]

# /api/Petrons/{petronToCopy}/copy

# POST

# Summary

Copy a petron

# Description

Copies the petron and all of its relations into a new petron

# Parameters

Name	Located in	Description	Required	Schema
petronToCopy	path		Yes	string
options	body		No	PetronCopyOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Petron]

# /api/PriceScenarios

# GET

# Summary

Find PriceScenario document(s)

# Description

Finds an exisiting PriceScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
PriceScenarios	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[PriceScenario]

# PUT

# Summary

Upsert PriceScenario document(s)

# Description

Replaces or inserts a PriceScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PriceScenariosUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[PriceScenario]

# POST

# Summary

Insert PriceScenario document(s)

# Description

Inserts a PriceScenario document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PriceScenariosInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[PriceScenario]

# DELETE

# Summary

Delete PriceScenario document(s)

# Description

Deletes an exisiting PriceScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PriceScenariosDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[PriceScenario]

# PATCH

# Summary

Update PriceScenario document(s)

# Description

Updates an exisiting PriceScenario document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PriceScenariosUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[PriceScenario]

# /api/Progress

# GET

# Summary

Find Progress document(s)

# Description

Finds an exisiting Progress document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
ParentIds	query	No	[ string ]
ParentTypes	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# PUT

# Summary

Upsert Progress

# Description

Replaces or inserts Progress within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ProgressUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# POST

# Summary

Insert Progress

# Description

Inserts exisiting Progress within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ProgressInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# DELETE

# Summary

Delete Progress

# Description

Deletes exisiting Progress within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ProgressDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# PATCH

# Summary

Update Progress

# Description

Updates exisiting Progress within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ProgressUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# /api/Progress/large

# POST

# Summary

Find Progress document(s)

# Description

Finds an exisiting Progress document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ProgressFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Progress]

# /api/RealTimeProduction

# GET

# Summary

Find real-time production

# Description

Finds exisiting real-time production within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
DailyProductionIds	query	No	[ string ]
PreviousHours	query	No	integer
PWIs	query	No	[ string ]
WellIds	query	No	[ string ]
StartDate	query	No	dateTime
EndDate	query	No	dateTime
Day	query	No	dateTime
PreviousHoursDate	query	No	dateTime
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[RealTimeProduction]

# PUT

# Summary

Upsert real-time production

# Description

Replaces or inserts real-time production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RealTimeProductionUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RealTimeProduction]

# POST

# Summary

Insert real-time production

# Description

Inserts exisiting real-time production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RealTimeProductionInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RealTimeProduction]

# DELETE

# Summary

Delete real-time production

# Description

Deletes exisiting real-time production within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RealTimeProductionDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RealTimeProduction]

# /api/Relations/pin

# POST

# Summary

Pin a Document as a Relation

# Description

Pins an item to another item as a relation

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PinOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# DELETE

# Summary

UnPin a Document from an item

# Description

UnPins an item from another item

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	PinOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# /api/Relations

# GET

# Summary

Find Relations document(s)

# Description

Finds an exisiting Relations document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Types	query	No	[ string ]
ParentIds	query	No	[ string ]
ChildIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# PUT

# Summary

Upsert Relations

# Description

Replaces or inserts Relations within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RelationsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# POST

# Summary

Insert Relations

# Description

Inserts exisiting Relations within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RelationsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# DELETE

# Summary

Delete Relations

# Description

Deletes exisiting Relations within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RelationsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# PATCH

# Summary

Update Relations

# Description

Updates exisiting Relations within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RelationsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# /api/Relations/large

# POST

# Summary

Find Relations document(s)

# Description

Finds an exisiting Relations document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RelationsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Relation]

# /api/Reports/{reportId}

# PUT

# Summary

Execute a Report

# Description

Executes a job to generate a report

# Parameters

Name	Located in	Description	Required	Schema
reportId	path		Yes	string

# Responses

Code	Description	Schema
200	Success	PetroResult[Job]

# /api/Reports

# GET

# Summary

Find Reports document(s)

# Description

Finds an exisiting Reports document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Types	query	No	[ string ]
PIDs	query	No	[ string ]
Names	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# PUT

# Summary

Upsert Reports

# Description

Replaces or inserts Reports within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReportsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# POST

# Summary

Insert Reports

# Description

Inserts exisiting Reports within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReportsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# DELETE

# Summary

Delete Reports

# Description

Deletes exisiting Reports within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReportsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# PATCH

# Summary

Update Reports

# Description

Updates exisiting Reports within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReportsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# /api/Reports/large

# POST

# Summary

Find Reports document(s)

# Description

Finds an exisiting Reports document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReportsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReportBase]

# /api/ReservoirGridCells

# GET

# Summary

Find ReservoirGridCell document(s)

# Description

Finds an exisiting ReservoirGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGridCell]

# PUT

# Summary

Upsert ReservoirGridCell document(s)

# Description

Replaces or inserts a ReservoirGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridCellsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGridCell]

# POST

# Summary

Insert ReservoirGridCell document(s)

# Description

Inserts a ReservoirGridCell document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridCellsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGridCell]

# DELETE

# Summary

Delete ReservoirGridCell document(s)

# Description

Deletes an exisiting ReservoirGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridCellsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGridCell]

# PATCH

# Summary

Update ReservoirGridCell document(s)

# Description

Updates an exisiting ReservoirGridCell document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridCellsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGridCell]

# /api/ReservoirGrids

# GET

# Summary

Find ReservoirGrid document(s)

# Description

Finds an exisiting ReservoirGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGrid]

# PUT

# Summary

Upsert ReservoirGrid document(s)

# Description

Replaces or inserts a ReservoirGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGrid]

# POST

# Summary

Insert ReservoirGrid document(s)

# Description

Inserts a ReservoirGrid document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGrid]

# DELETE

# Summary

Delete ReservoirGrid document(s)

# Description

Deletes an exisiting ReservoirGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGrid]

# PATCH

# Summary

Update ReservoirGrid document(s)

# Description

Updates an exisiting ReservoirGrid document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	ReservoirGridsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[ReservoirGrid]

# /api/RigHeaders

# GET

# Summary

Find RigHeader document(s)

# Description

Finds an exisiting RigHeader document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
StartPressureRating	query	No	double
StartPressureRatingWithUOM.Unit	query	No	string
StartPressureRatingWithUOM.Atmospheres	query	No	double
StartPressureRatingWithUOM.Bars	query	No	double
StartPressureRatingWithUOM.Centibars	query	No	double
StartPressureRatingWithUOM.Decapascals	query	No	double
StartPressureRatingWithUOM.Decibars	query	No	double
StartPressureRatingWithUOM.FeetOfHead	query	No	double
StartPressureRatingWithUOM.Gigapascals	query	No	double
StartPressureRatingWithUOM.Hectopascals	query	No	double
StartPressureRatingWithUOM.InchesOfMercury	query	No	double
StartPressureRatingWithUOM.Kilobars	query	No	double
StartPressureRatingWithUOM.KilogramsForcePerSquareCentimeter	query	No	double
StartPressureRatingWithUOM.KilogramsForcePerSquareMeter	query	No	double
StartPressureRatingWithUOM.KilogramsForcePerSquareMillimeter	query	No	double
StartPressureRatingWithUOM.KilonewtonsPerSquareCentimeter	query	No	double
StartPressureRatingWithUOM.KilonewtonsPerSquareMeter	query	No	double
StartPressureRatingWithUOM.KilonewtonsPerSquareMillimeter	query	No	double
StartPressureRatingWithUOM.Kilopascals	query	No	double
StartPressureRatingWithUOM.KilopoundsForcePerSquareFoot	query	No	double
StartPressureRatingWithUOM.KilopoundsForcePerSquareInch	query	No	double
StartPressureRatingWithUOM.Megabars	query	No	double
StartPressureRatingWithUOM.MeganewtonsPerSquareMeter	query	No	double
StartPressureRatingWithUOM.Megapascals	query	No	double
StartPressureRatingWithUOM.MetersOfHead	query	No	double
StartPressureRatingWithUOM.Micropascals	query	No	double
StartPressureRatingWithUOM.Millibars	query	No	double
StartPressureRatingWithUOM.MillimetersOfMercury	query	No	double
StartPressureRatingWithUOM.NewtonsPerSquareCentimeter	query	No	double
StartPressureRatingWithUOM.NewtonsPerSquareMeter	query	No	double
StartPressureRatingWithUOM.NewtonsPerSquareMillimeter	query	No	double
StartPressureRatingWithUOM.Pascals	query	No	double
StartPressureRatingWithUOM.PoundsForcePerSquareFoot	query	No	double
StartPressureRatingWithUOM.PoundsForcePerSquareInch	query	No	double
StartPressureRatingWithUOM.TechnicalAtmospheres	query	No	double
StartPressureRatingWithUOM.TonnesForcePerSquareCentimeter	query	No	double
StartPressureRatingWithUOM.TonnesForcePerSquareMeter	query	No	double
StartPressureRatingWithUOM.TonnesForcePerSquareMillimeter	query	No	double
StartPressureRatingWithUOM.Torrs	query	No	double
StartPressureRatingWithUOM.Type	query	No	string
StartPressureRatingWithUOM.Dimensions.Length	query	No	integer
StartPressureRatingWithUOM.Dimensions.Mass	query	No	integer
StartPressureRatingWithUOM.Dimensions.Time	query	No	integer
StartPressureRatingWithUOM.Dimensions.Current	query	No	integer
StartPressureRatingWithUOM.Dimensions.Temperature	query	No	integer
StartPressureRatingWithUOM.Dimensions.Amount	query	No	integer
StartPressureRatingWithUOM.Dimensions.LuminousIntensity	query	No	integer
EndPressureRating	query	No	double
EndPressureRatingWithUOM.Unit	query	No	string
EndPressureRatingWithUOM.Atmospheres	query	No	double
EndPressureRatingWithUOM.Bars	query	No	double
EndPressureRatingWithUOM.Centibars	query	No	double
EndPressureRatingWithUOM.Decapascals	query	No	double
EndPressureRatingWithUOM.Decibars	query	No	double
EndPressureRatingWithUOM.FeetOfHead	query	No	double
EndPressureRatingWithUOM.Gigapascals	query	No	double
EndPressureRatingWithUOM.Hectopascals	query	No	double
EndPressureRatingWithUOM.InchesOfMercury	query	No	double
EndPressureRatingWithUOM.Kilobars	query	No	double
EndPressureRatingWithUOM.KilogramsForcePerSquareCentimeter	query	No	double
EndPressureRatingWithUOM.KilogramsForcePerSquareMeter	query	No	double
EndPressureRatingWithUOM.KilogramsForcePerSquareMillimeter	query	No	double
EndPressureRatingWithUOM.KilonewtonsPerSquareCentimeter	query	No	double
EndPressureRatingWithUOM.KilonewtonsPerSquareMeter	query	No	double
EndPressureRatingWithUOM.KilonewtonsPerSquareMillimeter	query	No	double
EndPressureRatingWithUOM.Kilopascals	query	No	double
EndPressureRatingWithUOM.KilopoundsForcePerSquareFoot	query	No	double
EndPressureRatingWithUOM.KilopoundsForcePerSquareInch	query	No	double
EndPressureRatingWithUOM.Megabars	query	No	double
EndPressureRatingWithUOM.MeganewtonsPerSquareMeter	query	No	double
EndPressureRatingWithUOM.Megapascals	query	No	double
EndPressureRatingWithUOM.MetersOfHead	query	No	double
EndPressureRatingWithUOM.Micropascals	query	No	double
EndPressureRatingWithUOM.Millibars	query	No	double
EndPressureRatingWithUOM.MillimetersOfMercury	query	No	double
EndPressureRatingWithUOM.NewtonsPerSquareCentimeter	query	No	double
EndPressureRatingWithUOM.NewtonsPerSquareMeter	query	No	double
EndPressureRatingWithUOM.NewtonsPerSquareMillimeter	query	No	double
EndPressureRatingWithUOM.Pascals	query	No	double
EndPressureRatingWithUOM.PoundsForcePerSquareFoot	query	No	double
EndPressureRatingWithUOM.PoundsForcePerSquareInch	query	No	double
EndPressureRatingWithUOM.TechnicalAtmospheres	query	No	double
EndPressureRatingWithUOM.TonnesForcePerSquareCentimeter	query	No	double
EndPressureRatingWithUOM.TonnesForcePerSquareMeter	query	No	double
EndPressureRatingWithUOM.TonnesForcePerSquareMillimeter	query	No	double
EndPressureRatingWithUOM.Torrs	query	No	double
EndPressureRatingWithUOM.Type	query	No	string
EndPressureRatingWithUOM.Dimensions	query	No	object
WellIds	query	No	[ string ]
Names	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
Sizes	query	No	[ string ]
Types	query	No	[ string ]
EDRTypes	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[RigHeader]

# PUT

# Summary

Upsert RigHeader document(s)

# Description

Replaces or inserts a RigHeader document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RigHeadersUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigHeader]

# POST

# Summary

Insert RigHeader document(s)

# Description

Inserts a RigHeader document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RigHeadersInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigHeader]

# DELETE

# Summary

Delete RigHeader document(s)

# Description

Deletes an exisiting RigHeader document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RigHeadersDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigHeader]

# PATCH

# Summary

Update RigHeader document(s)

# Description

Updates an exisiting RigHeader document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	RigHeadersUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[RigHeader]

# /api/RowProducer

# GET

# Summary

Find row producer(s) information

# Description

Finds the information of all row prodcuers

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	PetroResult[List[RowProducerInfo]]

# /api/Settings

# GET

# Summary

Find Settings document(s)

# Description

Finds an exisiting Settings document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
ParentIds	query	No	[ string ]
ReferenceIds	query	No	[ string ]
Scopes	query	No	[ string ]
Versions	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# PUT

# Summary

Upsert Settings

# Description

Replaces or inserts Settings within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SettingsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# POST

# Summary

Insert Settings

# Description

Inserts exisiting Settings within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SettingsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# DELETE

# Summary

Delete Settings

# Description

Deletes exisiting Settings within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SettingsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# PATCH

# Summary

Update Settings

# Description

Updates exisiting Settings within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SettingsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# /api/Settings/large

# POST

# Summary

Find Settings document(s)

# Description

Finds an exisiting Settings document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	SettingsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Setting]

# /api/TypeCurveModels

# GET

# Summary

Find type curve model(s)

# Description

Finds an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
ModelNames	query	No	[ string ]
Groups	query	No	[ string ]
IncludeForecast	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[TypeCurveModel]

# PUT

# Summary

Upsert type curve model(s)

# Description

Replaces or inserts a type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	TypeCurvesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[TypeCurveModel]

# POST

# Summary

Insert type curve model(s)

# Description

Inserts a type curve model or models into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	TypeCurvesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[TypeCurveModel]

# DELETE

# Summary

Delete type curve model(s)

# Description

Deletes an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	TypeCurvesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[TypeCurveModel]

# /api/UnitsDefinitions

# GET

# Summary

Find units definition(s)

# Description

Finds an exisiting units definition or definitions within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Names	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[UnitsDefinition]

# PUT

# Summary

Upsert units definition(s)

# Description

Replaces or inserts a units definition or definitions within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	UnitsDefinitionsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[UnitsDefinition]

# POST

# Summary

Insert units definition(s)

# Description

Inserts a units definition or definitions into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	UnitsDefinitionsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[UnitsDefinition]

# DELETE

# Summary

Delete units definition(s)

# Description

Deletes an exisiting units definition or definitions within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	UnitsDefinitionsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[UnitsDefinition]

# /api/UnitsInformation

# GET

# Summary

Find units information

# Description

Gets units information for Petro.ai units defintions.

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	object

# /api/UnitsInformation/Convert

# GET

# Summary

Converts units to reporting scheme

# Description

Returns the unit scheme conversion for the uom. This uses the reporting unit scheme definition.

# Parameters

Name	Located in	Required	Schema
uom	query	No	string
unitType	query	No	string
value	query	No	double
toUom	query	No	string

# Responses

Code	Description	Schema
200	Success	UnitValue

# /api/Users

# GET

# Summary

Find Users document(s)

# Description

Finds an exisiting Users document(s) within the Petro.ai Database.

# Parameters

Name	Located in	Description	Required	Schema
UserIds	query		No	[ string ]

# Responses

Code	Description	Schema
200	Success	Users

# /api/Validate

# GET

# Parameters

Name	Located in	Description	Required	Schema

# Responses

Code	Description	Schema
200	Success	string

# /api/WellDeclineCurveModels

# GET

# Summary

Find well decline curve model(s)

# Description

Finds an exisiting well decline curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
ModelNames	query	No	[ string ]
WellNames	query	No	[ string ]
IsOfficial	query	No	boolean
LoadForecast	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDeclineCurveModel]

# PUT

# Summary

Upsert well decline curve model(s)

# Description

Replaces or inserts a well decline curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurvesUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDeclineCurveModel]

# POST

# Summary

Insert well decline curve model(s)

# Description

Inserts a well decline curve model or models into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurvesInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDeclineCurveModel]

# DELETE

# Summary

Delete well decline curve model(s)

# Description

Deletes an exisiting well decline curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	DeclineCurvesDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDeclineCurveModel]

# /api/WellDirectionalSurveyPoints

# GET

# Summary

Find type curve model(s)

# Description

Finds an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
SurveyIds	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurveyPoint]

# POST

# Summary

Insert type curve model(s)

# Description

Inserts a type curve model or models into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDirectionalSurveyPointsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurveyPoint]

# DELETE

# Summary

Delete type curve model(s)

# Description

Deletes an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDirectionalSurveyPointsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurveyPoint]

# /api/WellDirectionalSurveys

# GET

# Summary

Find type curve model(s)

# Description

Finds an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurvey]

# POST

# Summary

Insert type curve model(s)

# Description

Inserts a type curve model or models into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDirectionalSurveysInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurvey]

# DELETE

# Summary

Delete type curve model(s)

# Description

Deletes an exisiting type curve model or models within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDirectionalSurveysDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDirectionalSurvey]

# /api/WellDrillingEvents

# GET

# Summary

Find type curve model(s)

# Description

Finds an exisiting well drilling event(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
PWIs	query	No	[ string ]
WellNames	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDrillingEvent]

# POST

# Summary

Insert type curve model(s)

# Description

Inserts a well drilling event or events into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDrillingEventsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDrillingEvent]

# DELETE

# Summary

Delete type curve model(s)

# Description

Deletes an exisiting well drilling event(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellDrillingEventsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellDrillingEvent]

# /api/WellFormationIntervals

# GET

# Summary

Find WellFormationInterval document(s)

# Description

Finds an exisiting WellFormationInterval document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellFormationInterval]

# PUT

# Summary

Upsert WellFormationInterval document(s)

# Description

Replaces or inserts a WellFormationInterval document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellFormationIntervalsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellFormationInterval]

# POST

# Summary

Insert WellFormationInterval document(s)

# Description

Inserts a WellFormationInterval document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellFormationIntervalsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellFormationInterval]

# DELETE

# Summary

Delete WellFormationInterval document(s)

# Description

Deletes an exisiting WellFormationInterval document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellFormationIntervalsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellFormationInterval]

# PATCH

# Summary

Update WellFormationInterval document(s)

# Description

Updates an exisiting WellFormationInterval document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellFormationIntervalsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellFormationInterval]

# /api/WellIdentifiers

# GET

# Summary

Find well(s)

# Description

Finds an exisiting Well Identifier or Well Identifiers within the PetroDatabase. Sample request No Paramters GET /WellIdentifiers With Parameters GET /WellIdentifiers?limit=10&skip=10&sortBy=createdAt&wellds=12030191&wellIds=29101929299

# Parameters

Name	Located in	Required	Schema
Identifiers	query	No	[ string ]
PWIs	query	No	[ string ]
IsWellId	query	No	boolean
IdentifierType	query	No	string
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellIdentifier]

# PUT

# Summary

Upsert well(s)

# Description

Replaces or inserts a Well Identifier or Well Identifiers within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellIdentifiersUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellIdentifier]

# POST

# Summary

Insert well(s)

# Description

Inserts a well identifier or identifiers into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellIdentifiersInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellIdentifier]

# DELETE

# Summary

Delete well(s)

# Description

Deletes an exisiting well identifier or Well Identifiers within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellIdentifiersDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellIdentifier]

# PATCH

# Summary

Update well(s)

# Description

Updates an exisiting Well Identifier or Well Identifiers within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellIdentifiersUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellIdentifier]

# /api/WellLogDataPoints

# GET

# Summary

Find WellLogDataPoint document(s)

# Description

Finds an exisiting WellLogDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
WellLogIds	query	No	[ string ]
MinDepthFt	query	No	double
MaxDepthFt	query	No	double
IntervalSeconds	query	No	double
SampleFeet	query	No	double
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLogDataPoint]

# PUT

# Summary

Upsert WellLogDataPoint document(s)

# Description

Replaces or inserts a WellLogDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogDataPointsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLogDataPoint]

# POST

# Summary

Insert WellLogDataPoint document(s)

# Description

Inserts a WellLogDataPoint document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogDataPointsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLogDataPoint]

# DELETE

# Summary

Delete WellLogDataPoint document(s)

# Description

Deletes an exisiting WellLogDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogDataPointsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLogDataPoint]

# PATCH

# Summary

Update WellLogDataPoint document(s)

# Description

Updates an exisiting WellLogDataPoint document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogDataPointsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLogDataPoint]

# /api/WellLogs

# GET

# Summary

Find WellLog document(s)

# Description

Finds an exisiting WellLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
SourceHash	query	No	[ string ]
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLog]

# PUT

# Summary

Upsert WellLog document(s)

# Description

Replaces or inserts a WellLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLog]

# POST

# Summary

Insert WellLog document(s)

# Description

Inserts a WellLog document(s) into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLog]

# DELETE

# Summary

Delete WellLog document(s)

# Description

Deletes an exisiting WellLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLog]

# PATCH

# Summary

Update WellLog document(s)

# Description

Updates an exisiting WellLog document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellLogsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellLog]

# /api/Wells

# GET

# Summary

Find well(s)

# Description

Finds an exisiting well or wells within the PetroDatabase. Sample request No Paramters GET /wells With Parameters GET /wells?limit=10&skip=10&sortBy=createdAt&wellds=12030191&wellIds=29101929299

# Parameters

Name	Located in	Required	Schema
WellIds	query	No	[ string ]
Statuses	query	No	[ string ]
SurfaceLocationBounds	query	No	[ double ]
BottomHoleLocationBounds	query	No	[ double ]
MidPointLocationBounds	query	No	[ double ]
ReserveCategories	query	No	[ string ]
IsVirtual	query	No	boolean
PIDs	query	No	[ string ]
NumGridCells	query	No	integer
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# PUT

# Summary

Upsert well(s)

# Description

Replaces or inserts a well or wells within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# POST

# Summary

Insert well(s)

# Description

Inserts a well or wells into the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# DELETE

# Summary

Delete well(s)

# Description

Deletes an exisiting well or wells within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# PATCH

# Summary

Update well(s)

# Description

Updates an exisiting well or wells within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[Well]

# /api/Wells/mapFind

# POST

# Summary

Find well(s)

# Description

Finds an existing well within a given bounds and performs a grid aggregation

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[IttyWell]

# /api/WellStats

# GET

# Summary

Find Well Stats document(s)

# Description

Finds an exisiting Well Stats document(s) within the PetroDatabase.

# Parameters

Name	Located in	Required	Schema
ModelNames	query	No	[ string ]
PIDs	query	No	[ string ]
PWIs	query	No	[ string ]
IsTypeCurve	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# PUT

# Summary

Upsert Well Stats

# Description

Replaces or inserts Well Stats within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellStatsUpsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# POST

# Summary

Insert Well Stats

# Description

Inserts exisiting Well Stats within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellStatsInsertOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# DELETE

# Summary

Delete Well Stats

# Description

Deletes exisiting Well Stats within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellStatsDeleteOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# PATCH

# Summary

Update Well Stats

# Description

Updates exisiting Well Stats within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellStatsUpdateOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# /api/WellStats/large

# POST

# Summary

Find Well Stats document(s)

# Description

Finds an exisiting Well Stats document(s) within the PetroDatabase.

# Parameters

Name	Located in	Description	Required	Schema
options	body		No	WellStatsFindOptions

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStat]

# /api/WellStats/withPetronInfo

# GET

# Summary

Find Well Stats document(s) with Petron info

# Description

Finds an exisiting Well Stats document(s) within the PetroDatabase and appends information about the associated Petron(s)

# Parameters

Name	Located in	Required	Schema
ModelNames	query	No	[ string ]
PIDs	query	No	[ string ]
PWIs	query	No	[ string ]
IsTypeCurve	query	No	boolean
Ids	query	No	[ string ]
CreatedActivityIds	query	No	[ string ]
LastUpdatedActivityIds	query	No	[ string ]
UseCursor	query	No	boolean
Limit	query	No	integer
Skip	query	No	integer
SortBy	query	No	string
SortOrder	query	No	string
TextSearch	query	No	string
IsDeleted	query	No	boolean
Bounds	query	No	[ double ]
LocateBy	query	No	string
UpdatedBefore	query	No	dateTime
UpdatedAfter	query	No	dateTime
Polygon	query	No	[ [ [ double ] ] ]
FindAllIfEmpty	query	No	boolean

# Responses

Code	Description	Schema
200	Success	PetroResult[WellStatWithPetronInfoModel]

# /api/WellStats/getModels

# GET

# Summary

Get saved models in the database

# Description

Gets all models for WellStats

# Parameters

Name	Located in	Description	Required	Schema
obj	query		No	object

# Responses

Code	Description	Schema
200	Success	[ WellStatModel ]

# /api/WellStats/calculate

# POST

# Summary

Calculate well stats for a group of wells

# Description

Calculates well stats for a group of wells

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	CalculateWellStats

# Responses

Code	Description	Schema
200	Success	[ WellStat ]

# /api/WellStats/landingInterval

# POST

# Summary

Calculate the landing interval for a group of wells

# Description

Calculates landing interval for a group of wells

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	CalculateLandingInterval

# Responses

Code	Description
200	Success

# /api/WellStats/wellSpacing

# POST

# Summary

Calculate well spacing for a group of wells

# Description

Calculates well spacing for a group of wells

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	CalculateWellSpacing

# Responses

Code	Description
200	Success

# /api/WellStats/calculateEur

# PATCH

# Summary

Calculate EUR for a group of wells

# Description

Calculates EUR for a group of wells

# Parameters

Name	Located in	Description	Required	Schema
request	body		No	CalculateEURRequest

# Responses

Code	Description	Schema
200	Success	CalculateEURResults

← Best Practices Petro.ai 5 API →