The "welltooltip" web service provides an information about a tooltip of an individual well dataset.

A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/wells/{welluniqueid}/tooltip with the GET method.

where

datasourcetype: type of a datasource, i.e. mongo, s3, etc.

datasource: unique id of a datasource

welluniqueid: a unique id of a well dataset

Here is an example response. This response has been formatted to improve readability

{

"from": {

"actor": "akka://DefaultActorSystemControllerActorSystem:FindWellTooltipByUniqueIdJsonActor:FindWellTooltipByUniqueIdEntitlementCheckResponse for FindWellTooltipByUniqueIdEntitlementCheckRequest of FindWellTooltipByUniqueIdRequest:FindWellTooltipByUniqueIdRequest{klass1=AbstractWellTooltipFinder, sourceName=c9db3458-6698-49d9-ae8f-f407ce26ae2e, uniqueId=1d8af245-8da9-4ece-86cd-e115e9c88a3e, sourceType=mongo}"

},

"data": {

"id": "1d8af245-8da9-4ece-86cd-e115e9c88a3e",

"content": [

{

"name": "Name",

"value": "DemoWell01"

}

],

"links": [

{

"rel": "self",

"relEntity": "v1/schema/int/properties",

"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/wells/1d8af245-8da9-4ece-86cd-e115e9c88a3e/tooltip",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

}

}

The id entry is the unique id of a well dataset.

The content entry provides an information about a tooltip of a well dataset.

The tooltip is identified by name attribute.

The value attribute specifies a description of the tooltip.

The links section provides a HATEOAS link to this service.

If the specified welluniqueid doesn't match a valid well, no JSON response will be provided. The HTTP response will only show a "InvalidUniqueId" (error 404) in its headers.

The content of this web service is pluggable so that information specific to your data format can be included. To add your own content, extend the com.interactive.ivaapapi.json.AbstractJsonBuilder class.