WFM API

ScopeOfMonitoringRecord

Controller: scope of monitoring data

API	Description
GET api/well-groups/{idOfWroup}/wells/all/monitoring-records/{unixTime}	Get list of monitoring data for the well group

SvgElemOfLogOfWell

Controller: svg elements of log of well

API	Description
GET api/well-logs/{idOfLogOfWell}/svg-elements/{idOfSvgElem}	Get image svg element (figure)
POST api/well-logs/{idOfLogOfWell}/svg-elements	Post new svg elem to log
DELETE api/well-logs/{idOfLogOfWell}/svg-elements/{idOfSvgElem}	Delete image figure

ForecastEvolution

Forecast evolution parameters

API	Description
GET api/forecastevolution?well_id={well_id}	Get forecast evolution dictionary
POST api/forecastevolution	Post new or change an evolution parameter dictionary

WellMarkerOfMapOfWield

Controller: well in maps of field

API	Description
GET api/well-fields/maps/{idOfMapOfWield}/well-markers/{idOfWell}	Get well of map of well field
POST api/well-fields/maps/{idOfMapOfWield}/well-markers	Post well in well field map
PUT api/well-fields/maps/{idOfMapOfWield}/well-markers/{idOfWell}	Put well in well field map: change only coordinates and status
DELETE api/well-fields/maps/{idOfMapOfWield}/well-markers/{idOfWell}	Delete well in well field map

WfmParamSquad

Well file manager parameter group controller

API	Description
GET api/wfm-param-squads	Get well file manager parameter groups
GET api/wfm-param-squads/inclusive	Get groups with parameters

ScopeOfProcentBorder

Procent borders for all wells in this well group

API	Description
GET api/well-groups/{idOfWroup}/wells/all/procent-borders	Get procent borders for all wells in the well group

WfmParameter

Well file manager parameter controller

API	Description
GET api/wfm-parameters	Get well file manager parameters filtered by is in library
GET api/wfmparameter	Get well file manager parameters filtered by is in library
GET api/wfmparameter?id={id}	Get wfm parameter by id
GET api/wfm-parameters?id={id}	Get wfm parameter by id
POST api/wfm-parameters	Create new parameter
PUT api/wfm-parameters/{id}	Save changes
DELETE api/wfm-parameters/{id}	Delete well file manager parameter

WfmImageOfHistoryOfWell

Well file manager image controller

API	Description
GET api/well-histories/{idOfHistoryOfWell}/history-images/{id}	Get history image by id
POST api/well-histories/{idOfHistoryOfWell}/history-images	Post wfm image
DELETE api/well-histories/{idOfHistoryOfWell}/history-images/{id}	Delete wfm image

IntegrityOfWell

Controller for integrity

API	Description
GET api/wells/{idOfWell}/integrities/{idOfFileSpec}	Get one
GET api/wells/{idOfWell}/integrities	Get list
POST api/wells/{idOfWell}/integrities	Post model
PUT api/wells/{idOfWell}/integrities/{idOfFileSpec}	Put DTO model
DELETE api/wells/{idOfWell}/integrities/{idOfFileSpec}	Delete model

SketchOfWell

Controller for sketch of well

API	Description
GET api/wells/{idOfWell}/sketches	Get sketches of well
PUT api/wells/{idOfWell}/sketches	Save sketch (create if not exists)
DELETE api/wells/{idOfWell}/sketches	Delete sketch from well

Widgout

Widget layout (widgout) controller

API	Description
GET api/{stagePlural}/{stageId}/widget-layouts	Get all widget layouts for stage
GET api/{stagePlural}/{stageId}/widget-layouts/{id}	Get well widgout by id GET: api/well/{wellId:int}/widgout/{id:guid}
POST api/{stagePlural}/{stageId}/widget-layouts	Create new widget layout
PUT api/{stagePlural}/{stageId}/widget-layouts/{id}	Save changed widget layout: only layout name
DELETE api/{stagePlural}/{stageId}/widget-layouts/{id}	Delete widget layout

MapOfWield

Well field map controller

API	Description
GET api/well-fields/{wieldId}/maps/{id}	Get map of field by id
GET api/well-fields/{wieldId}/maps	Get all field maps from well field GET api/well-fields/{wieldId:int}/maps
PUT api/well-fields/{wieldId}/maps/{id}	Put well field map PUT: api/well-fields/{wieldId:int}/maps/{id:int}
DELETE api/well-fields/{wieldId}/maps/{id}	Delete well field map DELETE: api/well-fields/{wieldId:int}/maps/{id:int}
POST api/well-fields/{wieldId}/maps	Upload well field map file POST api/well-fields/{wieldId:int}/maps
GET api/well-fields/{wieldId}/maps/{id}?x1={x1}&y1={y1}&x2={x2}&y2={y2}	Get map image

CompanyJobType

Job type api controller

API	Description
GET api/companies/{companyId}/job-types	Get global job types and job types for this company
GET api/companies/{companyId}/job-types/{jobTypeId}	Get company job type by id
POST api/companies/{companyId}/job-types	Post company job type POST: api/companies/{companyId:guid}/job-types

MonitoringRecord

Controller for manage monitoring records of well

API	Description
GET api/wells/{idOfWell}/monitoring-records/time-start/{startUnixTime}/time-end/{endUnixTime}	Get monitoring data by time range
POST api/wells/{idOfWell}/monitoring-records/{unixTime}	Create or update a monitoring data record
DELETE api/wells/{idOfWell}/monitoring-records/{unixTime}	Remove entity
DELETE api/wells/{idOfWell}/monitoring-records	Remove all entities from well

SectionPattern

Job type api controller

API	Description
GET api/section-patterns	Get list of section patterns

Widgock

API	Description
GET api/widgouts/{widgoutId}/widgocks/id:guid?id={id}	Get widget block by id
POST api/widgouts/{widgoutId}/widgocks	Create new widget block

ProcentBorder

Controller: procent border

API	Description
GET api/wells/{idOfWell}/procent-borders	Get procent borders for well
POST api/wells/{idOfWell}/procent-borders	Create (or modify only the procent value) procent border
DELETE api/wells/{idOfWell}/procent-borders/{idOfWfmParameter}	Delete this procent border

ProductionData

Production data controller

API	Description
GET api/productiondata?well_id={well_id}	Get well production data list
DELETE api/productiondata?well_id={well_id}	Delete well production data

CompanyUser

Company user controller: HTTP methods for company users

API	Description
GET api/companyuser	Get all companies for current user ang user access level for every company
GET api/companyuser?company_id={company_id}	Get company users

VolumeOfWell

Controller for volume of well

API	Description
GET api/wells/{idOfWell}/volumes/{idOfFileSpec}	Get volume of well
GET api/wells/{idOfWell}/volumes	Get volumes of well
POST api/wells/{idOfWell}/volumes	Post volume of well
PUT api/wells/{idOfWell}/volumes/{idOfFileSpec}	Put volume of well
DELETE api/wells/{idOfWell}/volumes/{idOfFileSpec}	Delete volume

NodalAnalysisOfWell

Controller for nodal analyzes

API	Description
GET api/wells/{idOfWell}/nodal-analyzes/{idOfFileSpec}	Get nodal analysis
GET api/wells/{idOfWell}/nodal-analyzes	Get nodal analyzes
POST api/wells/{idOfWell}/nodal-analyzes	Post nodal analysis
PUT api/wells/{idOfWell}/nodal-analyzes/{idOfFileSpec}	Put nodal analysis
DELETE api/wells/{idOfWell}/nodal-analyzes/{idOfFileSpec}	Delete nodal analysis

FileSpecOfHistoryOfWell

Well history file controller

API	Description
GET api/well-histories/{idOfHistoryOfWell}/history-files/{idOfFileSpec}	Get file of well history
POST api/well-histories/{idOfHistoryOfWell}/history-files	Post well history file
DELETE api/well-histories/{idOfHistoryOfWell}/history-files/{idOfFileSpec}	Delete well history file

Manage widgets

API	Description
GET api/{stagePlural}/widget-blocks/{idOfWidgock}/widgets/{id}	Get widget by id
POST api/{stagePlural}/widget-blocks/{idOfWidgock}/widgets	Create new widget
PUT api/{stagePlural}/widget-blocks/{idOfWidgock}/widgets/{id}	Save changed widget
DELETE api/{stagePlural}/widget-blocks/{idOfWidgock}/widgets/{id}	Delete widget

WfmParameterOfWroup

Well group wfm parameter

API	Description
GET api/well-groups/{idOfWroup}/wfm-parameters	Get well group wfm parameters
GET api/well-groups/{idOfWroup}/wfm-parameters/{idOfWfmParam}	Get a wfm parameter of well group
POST api/well-groups/{idOfWroup}/wfm-parameters	Post a wfm parameter of well group
PUT api/well-groups/{idOfWroup}/wfm-parameters/{idOfWfmParam}	Put a wfm parameter of a well group
DELETE api/well-groups/{idOfWroup}/wfm-parameters/{idOfWfmParam}	Delete well group wfm parameter

JobType

Job type api controller

API	Description
GET api/job-types	Get job types: only global types (without company id)
GET api/job-types/{jobTypeId}	Get job type: only global types (without company id)
POST api/job-types	Post global job type
PUT api/job-types/{id}	Put job type PUT: api/job-types/{id} Access: admin
DELETE api/job-types/{id}	Delete job type DELETE: api/job-types/{id} Access: admin

TestScope

Test scope controller

API	Description
GET api/testscope?well_id={well_id}	Get test scope list
POST api/testscope	Insert test scope with it's test data list
PUT api/testscope?id={id}	Replace test scope

LogOfWell

Log of well controller

API	Description
GET api/wells/{idOfWell}/logs	Get all logs of well
GET api/wells/{idOfWell}/logs/{id}	Get log of well (as image, later - as DTO)
PUT api/wells/{idOfWell}/logs/{id}	Put log: change name, description. FileSpec and Well can't be changed
POST api/wells/{idOfWell}/logs	Post log of well data transfer object

FileSpecOfSection

All methods with file spec

API	Description
GET api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}	Download from section
GET api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}?x1={x1}&y1={y1}&x2={x2}&y2={y2}	Get part of image, cropped by axis
GET api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}/column-attributes	Get column attributes for log files (.las)
GET api/{stagePlural}/sections/{idOfSection}/file-specs	Get file spec list from section of well field
GET api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}/perfomance-fragment/{indexOfStartRow}/{countOfRows}	Get columns fragment from previously uploaded file with production data
POST api/{stagePlural}/sections/{idOfSection}/file-specs	Upload file spec (multipart/form-data)
POST api/{stagePlural}/sections/{idOfSection}/file-specs/{base64}	Upload file spec (base64 string)
POST api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}/perfomance-data/{indexOfStartRow}	Post well file to production data
PUT api/{stagePlural}/sections/{idOfSection}/file-specs/{idOfFileSpec}	Put file spec to section: can be changed only name of the file
DELETE api/{stagePlural}/sections/{idOfSection}/file-specs	Delete files from section

Well

Well controller

API	Description
POST api/Well	Post well
PUT api/Well?id={id}	Put well
DELETE api/Well?id={id}	Delete well

WellHistory

Well history controller (only for authorized users with corresponding company access level)

API	Description
GET api/WellHistory?well_id={well_id}	Get well history list
POST api/WellHistory	Post well history
PUT api/WellHistory?id={id}	Put well history
DELETE api/WellHistory?id={id}	Delete well history

WellField

Well field controller

API	Description
POST api/WellField	Post well field
PUT api/WellField?id={id}	Put well field
DELETE api/WellField?id={id}	Delete well field

Company

Company controller

API	Description
GET api/Company	Get all companies
GET api/Company?id={id}	Get a company
POST api/Company	Post company
PUT api/Company?id={id}	Change company info
DELETE api/Company?id={id}	Delete company: only managers can delete

TestData

Test data controller

API	Description
POST api/TestData	Insert test data
PUT api/TestData?testscope_id={testscope_id}&hournumber={hournumber}	Put test data
DELETE api/TestData?testscope_id={testscope_id}&hournumber={hournumber}	Delete test scope line (hour)

WellFieldMapArea

Well field map area controller

API	Description
GET api/WellFieldMapArea?wellfieldmap_id={wellfieldmap_id}	Get all field map areas from well field map
POST api/WellFieldMapArea	Post well field map area
PUT api/WellFieldMapArea?id={id}	Put well field map area
DELETE api/WellFieldMapArea?id={id}	Delete well field map area

AccessLevel

Access level controller

API	Description
GET api/AccessLevel	Get access level JSON object: {'Access level name (string)': { AccessCode: 'Access level code (byte)', Description: 'Access level description (string)'}, ... }

WellRegion

Well region controller

API	Description
GET api/WellRegion?company_id={company_id}&is_inclusive={is_inclusive}	Get well region list. Only for company users
GET api/WellRegion?id={id}	Get well region
POST api/WellRegion	Post well region
PUT api/WellRegion?id={id}	Put well region
DELETE api/WellRegion?id={id}	Delete well region

WellGroup

Well group controller

API	Description
POST api/WellGroup	Post well group
PUT api/WellGroup?id={id}	Put well group
DELETE api/WellGroup?id={id}	Delete well group