The "welltopsbytopset" service provides information about all well tops of an individual well top set.

A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/topsets/{topsetuniqueid}/tops 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 id of a well top set

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:FindTopsByTopSetJsonActor:StartTopsByTopSetResponseEvent for FindTopsByTopSetRequest:FindTopsByTopSetRequest{klass=AbstractWellTopFinder, sourceName=ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16, topSetUniqueId=ccd31862-e74f-4e47-b3b1-0cd18bd06f62, linksToInclude=null, sourceType=mongo}"

},

"collection": {

"schema": "v1/schema/int/entitycollection",

"items": [

{

"id": "79264056-db93-492e-91a9-5b7e176b16e4",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "90afe2a1-abc9-4fd3-bc33-ec7ad0b80ba8",

"name": "mynewtop",

"index": 1996.15,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/79264056-db93-492e-91a9-5b7e176b16e4",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/wells/90afe2a1-abc9-4fd3-bc33-ec7ad0b80ba8",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "d3061d59-ae9d-4d06-9ce0-515bcec88eaf",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "503",

"name": "anothertop",

"index": 996.15,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/d3061d59-ae9d-4d06-9ce0-515bcec88eaf",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/wells/503",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "ac0ef8fc-a440-4c88-96f1-6162b93b93a6",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "90afe2a1-abc9-4fd3-bc33-ec7ad0b80ba8",

"name": "top3",

"index": 1998.04,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://a55500ff-fe15-4f69-9993-4322839aa56e"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/ac0ef8fc-a440-4c88-96f1-6162b93b93a6",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/wells/90afe2a1-abc9-4fd3-bc33-ec7ad0b80ba8",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "8ed451aa-a81d-41f1-9c73-acfd1374668a",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "503",

"name": "topForDifferentWell",

"index": 2200.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/8ed451aa-a81d-41f1-9c73-acfd1374668a",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/503",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "6b8876b4-897e-490e-b1f9-2c4be044fb9d",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "503",

"name": "topFromReleaseBranchCode",

"index": 2000.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/6b8876b4-897e-490e-b1f9-2c4be044fb9d",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/503",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "3a283f0f-763b-4595-a563-8463f5b0cada",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "{\"tuple\":[{\"name\":\"rasterLogUID\",\"value\":\"390006d0-2417-457c-a699-80ef4205d3af\"},{\"name\":\"segmentId\",\"value\":\"1\"},{\"name\":\"imageType\",\"value\":\"Header\"}]}",

"name": "topForDifferentWell",

"index": 350.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/3a283f0f-763b-4595-a563-8463f5b0cada",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/%7B%22tuple%22%3A%5B%7B%22name%22%3A%22rasterLogUID%22%2C%22value%22%3A%22390006d0-2417-457c-a699-80ef4205d3af%22%7D%2C%7B%22name%22%3A%22segmentId%22%2C%22value%22%3A%221%22%7D%2C%7B%22name%22%3A%22imageType%22%2C%22value%22%3A%22Header%22%7D%5D%7D",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "394af23f-726d-4ce7-9672-83a52f2e6cb1",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "{\"tuple\":[{\"name\":\"rasterLogUID\",\"value\":\"390006d0-2417-457c-a699-80ef4205d3af\"},{\"name\":\"segmentId\",\"value\":\"1\"},{\"name\":\"imageType\",\"value\":\"Header\"}]}",

"name": "topForDifferentWell",

"index": 400.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/394af23f-726d-4ce7-9672-83a52f2e6cb1",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/%7B%22tuple%22%3A%5B%7B%22name%22%3A%22rasterLogUID%22%2C%22value%22%3A%22390006d0-2417-457c-a699-80ef4205d3af%22%7D%2C%7B%22name%22%3A%22segmentId%22%2C%22value%22%3A%221%22%7D%2C%7B%22name%22%3A%22imageType%22%2C%22value%22%3A%22Header%22%7D%5D%7D",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "3082fd99-0e0c-4225-bf5b-cb2334a1e80d",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "{\"tuple\":[{\"name\":\"rasterLogUID\",\"value\":\"390006d0-2417-457c-a699-80ef4205d3af\"},{\"name\":\"segmentId\",\"value\":\"1\"},{\"name\":\"imageType\",\"value\":\"Header\"}]}",

"name": "topForDifferentWell",

"index": 500.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/3082fd99-0e0c-4225-bf5b-cb2334a1e80d",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/%7B%22tuple%22%3A%5B%7B%22name%22%3A%22rasterLogUID%22%2C%22value%22%3A%22390006d0-2417-457c-a699-80ef4205d3af%22%7D%2C%7B%22name%22%3A%22segmentId%22%2C%22value%22%3A%221%22%7D%2C%7B%22name%22%3A%22imageType%22%2C%22value%22%3A%22Header%22%7D%5D%7D",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "7d78ede7-6156-4b35-b91c-37936feafef7",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "{\"tuple\":[{\"name\":\"rasterLogUID\",\"value\":\"390006d0-2417-457c-a699-80ef4205d3af\"},{\"name\":\"segmentId\",\"value\":\"1\"},{\"name\":\"imageType\",\"value\":\"Header\"}]}",

"name": "topForDifferentWell",

"index": 500.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/7d78ede7-6156-4b35-b91c-37936feafef7",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/%7B%22tuple%22%3A%5B%7B%22name%22%3A%22rasterLogUID%22%2C%22value%22%3A%22390006d0-2417-457c-a699-80ef4205d3af%22%7D%2C%7B%22name%22%3A%22segmentId%22%2C%22value%22%3A%221%22%7D%2C%7B%22name%22%3A%22imageType%22%2C%22value%22%3A%22Header%22%7D%5D%7D",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

},

{

"id": "98d471ce-b05c-4714-bb60-e39ae3bdba39",

"content": {

"topSetUUID": "ccd31862-e74f-4e47-b3b1-0cd18bd06f62",

"wellboreUID": "{\"tuple\":[{\"name\":\"rasterLogUID\",\"value\":\"390006d0-2417-457c-a699-80ef4205d3af\"},{\"name\":\"segmentId\",\"value\":\"1\"},{\"name\":\"imageType\",\"value\":\"Header\"}]}",

"name": "topForDifferentWell",

"index": 750.0,

"interpreter": "MichaelM",

"label": "IVAAPMiddleTier://cec5dc52-a6a9-4ef4-be6d-f62f560f2c00"

},

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/ecd55dc9-e37c-49c8-a2f7-4313a8fe6a16/tops/98d471ce-b05c-4714-bb60-e39ae3bdba39",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

},

{

"rel": "Well",

"name": "Well",

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

"href": "/ivaap/api/ds/ppdm/v1/sources/5914011f-23da-4be1-b648-07713893b575/wells/%7B%22tuple%22%3A%5B%7B%22name%22%3A%22rasterLogUID%22%2C%22value%22%3A%22390006d0-2417-457c-a699-80ef4205d3af%22%7D%2C%7B%22name%22%3A%22segmentId%22%2C%22value%22%3A%221%22%7D%2C%7B%22name%22%3A%22imageType%22%2C%22value%22%3A%22Header%22%7D%5D%7D",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

}

]

}

],

"total": 10

}

}

The items section is a collection of all tops meta data.

Each meta data is identified by id entry.

In content section for each top set meta data

• topSetUUID is the unique id of a parent top set

• wellboreUID is the unique id of a parent well bore (or well if well bores are not supported)

• name is the name of a well top

• index is the depth of a well top

• interpreter is an interpreter of a well top

• label is the lable of a well top

• links section provides HATEOAS links to the services supported by each well top

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.