Embedded Files
The "welltopsetsmeta" web service provides meta data about all top sets for the specified data source.
A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/topsets 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:
includelinks: an array of links to include in response, i.e. self, Log, etc. This is an optional parameter. The default is all links.
Here is an example response. This response has been formatted to improve readability.
{
"from": {
"actor": "akka://DefaultActorSystemControllerActorSystem:FindAllTopSetsJsonActor:StartAllTopSetsResponseEvent for FindAllTopSetsRequest:FindAllTopSetsRequest{sourceType=mongo, sourceName=ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16, klass=AbstractWellTopSetFinder, linksToInclude=null}"
},
"collection": {
"schema": "v1/schema/int/entitycollection",
"items": [
{
"id": "192886f8-aa09-4a5f-a164-3bbc09fd17aa",
"content": {
"name": "KansasTops_6",
"indexUnit": "m"
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/topset",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/192886f8-aa09-4a5f-a164-3bbc09fd17aa",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Top",
"name": "Top",
"relEntity": "v1/schema/int/top",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/192886f8-aa09-4a5f-a164-3bbc09fd17aa/tops",
"children": true,
"hasProjectEntityChildren": false,
"isProjectEntity": false
}
]
},
{
"id": "e7354e7a-fa68-4b64-a2a9-c7439e3bbbde",
"content": {
"name": "KansasTops",
"indexUnit": "m"
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/topset",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/e7354e7a-fa68-4b64-a2a9-c7439e3bbbde",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Top",
"name": "Top",
"relEntity": "v1/schema/int/top",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/e7354e7a-fa68-4b64-a2a9-c7439e3bbbde/tops",
"children": true,
"hasProjectEntityChildren": false,
"isProjectEntity": false
}
]
},
{
"id": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",
"content": {
"name": "newTopSet",
"indexUnit": "m"
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/topset",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/ccd31862-e74f-4e47-b3b1-0cd18bd06f62",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
},
{
"rel": "Top",
"name": "Top",
"relEntity": "v1/schema/int/top",
"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/topsets/ccd31862-e74f-4e47-b3b1-0cd18bd06f62/tops",
"children": true,
"hasProjectEntityChildren": false,
"isProjectEntity": false
}
]
}
],
"total": 3
},
"supportedActions": [
{
"schema": "v1/schema/int/topset",
"methods": [
{
"method": "DELETE",
"actions": [
{
"type": "Delete",
"name": "Delete"
}
]
}
]
}
]
}
The items section is a collection of all top sets meta data.
Each meta data is identified by id entry.
In content section for each top set meta data
name is the name of a top set
indexUnit specifies unit symbol associated with this well top set, i.e. s, ft, m, ms or undefined
links section provides HATEOAS links to the services supported by each top set
Report abuse