Embedded Files
The "wellsmeta" web service provides meta data about all well datasets available in a datasource.
A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/wells with the GET method.
where
datasourcetype: type of a datasource, i.e. mongo, s3, etc.
datasource: unique id of a datasource
The following parameters are available:
pageindex: specifies an index of the page to show. This is an optional parameter.
pagesize: specifies a number of items in each page. This is an optional parameter.
includelinks: an array of links to include in response, i.e. self, Log, etc. This is an optional parameter. The default is all links.
keyword: specifies a keyword that well name should contain. This is an optional parameter.
sort: specifies a sort order to use i.e. ascending, descending, or unsorted. This is an optional parameter. The default is unsorted.
Here is an example response. This response has been formatted to improve readability.
{
"from": {
"actor": "akka://DefaultActorSystemControllerActorSystem:FindAllWellsJsonActor:StartAllWellsResponseEvent for FindAllWellsRequest:FindAllWellsRequest{klass=AbstractWellDataFinder, sourceName=c9db3458-6698-49d9-ae8f-f407ce26ae2e, sourceType=mongo, query=null, linksToInclude=null}"
},
"collection": {
"schema": "v1/schema/int/entitycollection",
"items": [
{
"id": "1d8af245-8da9-4ece-86cd-e115e9c88a3e",
"content": {
"name": "DemoWell01",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/1d8af245-8da9-4ece-86cd-e115e9c88a3e",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/1d8af245-8da9-4ece-86cd-e115e9c88a3e",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "822b2101-ff1e-4f55-95f4-7f2a4a31ba48",
"content": {
"name": "DemoWell09",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/822b2101-ff1e-4f55-95f4-7f2a4a31ba48",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/822b2101-ff1e-4f55-95f4-7f2a4a31ba48",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "a3eb",
"content": {
"name": "DemoWell01b",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/a3eb",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/a3eb",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "test_well_uid",
"content": {
"name": "Trinity Test Well",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/test_well_uid",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/test_well_uid",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "lithoWell",
"content": {
"name": "lithoWell",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/lithoWell",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/lithoWell",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "d3I1MDhFMDExRWJwMQ==",
"content": {
"name": "d3I1MDhFMDExRWJwMQ==",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/d3I1MDhFMDExRWJwMQ%3D%3D",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/d3I1MDhFMDExRWJwMQ%3D%3D",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "a03e86c7-72c1-414e-aecc-8ea3c5",
"content": {
"name": "EnergisticsWell2016-A",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/a03e86c7-72c1-414e-aecc-8ea3c5",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/a03e86c7-72c1-414e-aecc-8ea3c5",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "cb6dd33c-4c19-4f32-8978-0356020f799c",
"content": {
"name": "MIP 3H",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/cb6dd33c-4c19-4f32-8978-0356020f799c",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/cb6dd33c-4c19-4f32-8978-0356020f799c",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
},
{
"id": "d33e4930-f532-476b-bfee-e1a2dc713ec7",
"content": {
"name": "34/10-5",
"isLive": false
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/d33e4930-f532-476b-bfee-e1a2dc713ec7",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Well",
"name": "Well",
"relEntity": "v1/schema/int/well",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/d33e4930-f532-476b-bfee-e1a2dc713ec7",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": true
}
]
}
],
"total": 9
},
"supportedActions": [
{
"schema": "v1/schema/int/well",
"methods": [
{
"method": "PUT",
"actions": [
{
"type": "Rename",
"name": "Rename"
}
]
},
{
"method": "DELETE",
"actions": [
{
"type": "Delete",
"name": "Delete"
}
]
}
],
"children": true
}
]
}
The items section specifies a collection of well meta data.
Each meta data is identified by id attribute.
The content entry describes the meta data by name attribute.
The isLive attribute indicates whether a well is alive.
The links sections lists all HATEOAS links leading to the services supported by each dataset.
The supportedActions section specifies actions that can be performed on each well dataset.
Report abuse