Embedded Files
The "welltopsetdata" web service provides information about an individual top set.
A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/topsets/{topsetuniqueid} with the GET method.
where
datasourcetype: type of a datasource, i.e. mongo, s3, etc.
datasource: a unique id of a datasource
topsetuniqueid: a unique if of a top set
Here is an example response. This response has been formatted to improve readability.
{
"from": {
"actor": "akka://DefaultActorSystemControllerActorSystem:FindTopSetByUniqueIdJsonActor:FindFirstAndLastEntryLogsByEntityListResponse for FindFirstAndLastEntryLogsByEntityRequest:FindFirstAndLastEntryLogsByEntityRequest{klass=AbstractEntryLogFinder, sourceType=mongo, sourceName=ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16, entityUniqueId=192886f8-aa09-4a5f-a164-3bbc09fd17aa, entity=topset}"
},
"data": {
"id": "192886f8-aa09-4a5f-a164-3bbc09fd17aa",
"content": {
"name": "KansasTops_6",
"indexUnit": "m",
"createdBy": "TestUser@Fakeemail.com",
"createdOn": 1544568047535
},
"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 Set",
"name": "Top Set",
"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": true
},
{
"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
}
]
}
}
The id entry is a unique id of a top set.
In content section
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
The links section provides HATEOAS links to the services supported by a top set.
If the specified topsetuniqueid doesn't match a valid well top set, no JSON response will be provided. The HTTP response will only show a "InvalidUniqueId" (error 404) in its headers.
Report abuse