The "importwellpumping" web service imports a well pumping into the specified datasource.
A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/pumpings/import with the POST method.
where
datasourcetype: type of a datasource, i.e. mongo, s3, etc.
datasource: unique id of a datasource
The following parameters are available:
importoptions: a JSON object that specifies parameters of the being imported well dataset. The following parameters are available:
wellName specifies a name of the well to add pumping data to. If the well does not exist, a new well will be created.
frackingStageName specifies a name of the fracking stage to import pumping data into. If the fracking stage does not exist a new fracking stage will be created. This is an optional parameter. The default is the file name.
frackingStageNumber specifies a positive integer that will uniquely represent a fracking stage in a well. This is an optional parameter. If the fracking stage number is not specified, a fracking stage number will be generated based on the last fracking stage number (if fracking stages 1, 3, 7 already exist, then the next generated fracking stage number will be 8).
overwrite indicates whether to override an existing pumping data. If overwrite is false and a pumping data already existings for the specified fracking stage number, then an error will be thrown. This is an optional parameter. The default is false.
dataValuesRow specifies the row that data values start to appear on
delimeter specifies a character delimiter used to parse the microseismic file. This is an optional value. The default is ",".
startMD specifies the start depath value for fracking stage
endMD specifies the end depth value for fracking stage
timeZone specifies the time zone that data is specified in
valuecurveoptions : a JSON array representing pumping data curves. The following parameters are available:
curveName is the name of the curve
columnIndex is an index column for curve values
curveUnit is the unit symbol of the curve. This is an optional parameter.
indexcurveoptions : a JSON array representing an index curve of a pumping data
indexName is the name of the index curve. This is an optional parameter. The default is "Time".
dateColumnIndex is an index of date values
timeColumnIndex is an index of time values. This is an optional parameter.
dateFormat is the format of date values
timeFormat is the format of time values. This is an optional parameter. Required if timeColumnIndex is specified.
dateTimeSeparator is the separator if date and time values are specified in the same column
timeFirst: indicates whether time values are specified before date values when the time and date values are specified int he same column. This is an optional parameter. The default is false.
file: a file containing a being imported well pumping. This is required parameter.
An example import is shown below (pass multipart/form-data as Content-Type):
importoptions:
{
"wellName": "pumpingWell",
"overwrite": true,
"dataValuesRow": 3,
"delimiter": ",",
"startMD": 0,
"endMD": 6000,
"frackingStageNumber": 7
}
valuecurveoptions:
[
{
"columnIndex": 2,
"curveUnit": "psi",
"curveName": "TR_PRESS"
},
{
"columnIndex": 3,
"curveUnit": "psi",
"curveName": "TR_PRESS2"
},
{
"columnIndex": 4,
"curveUnit": "B/M",
"curveName": "SLUR_RATE"
}
]
indexcurveoptions:
{
"indexName": "time",
"timeColumnIndex": 1,
"dateColumnIndex": 1,
"dateFormat": "MM:DD:YY",
"timeFormat": "HH24:MM:SS",
"dateTimeSeparator": ":",
"timeFirst": false
}
Here is an example response. This response has been formatted to improve readability.
{
"from": {
"actor": "akka://DefaultActorSystemControllerActorSystem:ImportPumpingsJsonActor:ImportPumpingsResponse for ImportPumpingsRequest:ImportPumpingsRequest{klass=AbstractPumpingDataImporter, sourceType=mongo, sourceName=c9db3458-6698-49d9-ae8f-f407ce26ae2e, pathInfo=/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/pumpings/import, numberOfUploadedFiles=1, file #0=UploadedFile{file=2015HOU0098-NNE-MIP-3H_Stg7.csv, directory=UPLOADDIR3960ba51-7c41-4d05-af3f-1ecb3e9a2af74280651563959613607, fileSize=1659925, checksum=b5e43ccc9856ded3eb68a728838dbc52, mimeType=text/csv, originalFileName=2015HOU0098-NNE-MIP-3H_Stg7.csv, parameterName=file}, parameters=PumpingDataImportParameters{wellName=pumpingWell, frackingStageNumber=7, frackingStageName=null, valueCurveParameters=[PumpingDataValueCurveParameters{columnIndex=2, curveName=TR_PRESS, curveUnitSymbolpsi}, PumpingDataValueCurveParameters{columnIndex=3, curveName=TR_PRESS2, curveUnitSymbolpsi}, PumpingDataValueCurveParameters{columnIndex=4, curveName=SLUR_RATE, curveUnitSymbolB/M}], overwrite=true, startMD=0.0, endMD=6000.0, delimiter=,, timeZone=null, indexCurveParameters=PumpingDataIndexCurveParameters{timestampColumnIndex=null, timeColumnIndex=1, dateColumnIndex=, indexCurveName=time1, dateFormat=MM:DD:YY, timeFormat=HH24:MM:SS, dateTimeSeparator=1, isTimeFirst=false}}}"
},
"data": {
"files": [
{
"fileName": "2015HOU0098-NNE-MIP-3H_Stg7.csv",
"id": "dec10e78-26b9-4686-9fb0-eeeec9231b80",
"links": [
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/dec10e78-26b9-4686-9fb0-eeeec9231b80",
"children": true,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
}
]
}
}
The fileName entry is the name of a being imported pumping data file.
The id entry is a unique id of a well a pumping data has been imported to.
The links sections provides aHATEOAS link to the "Well Data Web Service (v3)" service.