The "wellboreperforationsets" web service provides meta data about all perforation sets of an individual well bore.
A typical URL is http://myserver.mycompany.com:8080/INTGeoServer/api/ds/{datasourcetype}/v1/sources/{datasource}/wellbores/{wellboreuniqueid}/perforationsets with the GET method.
where
datasourcetype: type of a datasource, i.e. mongo, geofiles, s3, etc.
datasource: unique id of a datasource
wellboreuniqueid: a unique id of a well bore
Here is an example response. This response has been formatted to improve readability
{
"from": {
"actor": "akka://DefaultActorSystemControllerActorSystem:FindWellBorePerforationSetMetasByWellBoreJsonActor:WellBorePerforationSetMetasListResponse for FindWellBorePerforationSetMetasByWellBoreRequest:FindWellBorePerforationSetMetasByWellBoreRequest{klass=AbstractWellBorePerforationSetMetaFinder, sourceName=c9db3458-6698-49d9-ae8f-f407ce26ae2e, uniqueId=a03e86c7-72c1-414e-aecc-8ea3c5, sourceType=mongo}"
},
"collection": {
"schema": "v1/schema/int/entitycollection",
"items": [
{
"id": "65476ad8-b769-4ac7-9461-20e4ef4b4ca9",
"content": {
"uid": "65476ad8-b769-4ac7-9461-20e4ef4b4ca9",
"name": "TestPerforationSet"
},
"links": [
{
"rel": "self",
"relEntity": "v1/schema/int/perforationset",
"href": "/ivaap/api/ds/mongo/v1/sources/c9db3458-6698-49d9-ae8f-f407ce26ae2e/perforationsets/65476ad8-b769-4ac7-9461-20e4ef4b4ca9",
"children": false,
"hasProjectEntityChildren": false,
"isProjectEntity": false
}
]
}
],
"total": 1
},
"supportedActions": [
{
"schema": "v1/schema/int/perforationset",
"methods": [
{
"method": "PUT",
"actions": [
{
"type": "Rename",
"name": "Rename"
}
]
},
{
"method": "DELETE",
"actions": [
{
"type": "Delete",
"name": "Delete"
}
]
}
]
}
]
}
The items section specifies a collection of perforation set meta data.
Each meta data is identified by id attribute.
The name entry specifies a name of a perforation set.
The links sections provides a HATEOAS links leading to the wellboreperforationset service.
The supportedActions section specifies actions that can be performed on each perforation set.
If the specified wellboreuniqueid doesn't match a valid well bore, no JSON response will be provided. The HTTP response will only show a "InvalidUniqueId" (error 404) in its headers.