INTGeoServer for Developers - Table Columns Web Service (v3)

Table Columns Web Service (v3)

The "tablecolumns" web service provides information about the values of an individual table.

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

where

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

datasource: a unique id of a datasource

tableuniqueid: a unique if of a table

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

{

"from": {

"actor": "akka://DefaultActorSystemControllerActorSystem:FindTableColumnsJsonActor:StartTableColumnsResponseEvent for FindTableColumnsRequest:FindTableColumnsRequest{klass=AbstractTableFrameFinder, sourceName=e5d3f935-112a-427a-8e6b-0e24ba84021b, sourceType=mongo, tableUniqueId=10c71ae9-be6b-46de-8fcf-9b1d7204982c, columnIndices=[]}"

"data": {

"id": "10c71ae9-be6b-46de-8fcf-9b1d7204982c",

"content": {

"name": "PDEN_VOL_SUMARRY-with nan",

"columnNames": [

"VOLUME_DATE",

"WATER_VOLUME",

"GAS_VOLUME",

"OIL_VOLUME",

"PDEN_SUBTYPE",

"PDEN_ID",

"PERIOD_ID",

"PDEN_SOURCE",

"VOLUME_METHOD",

"ACTIVITY_TYPE",

"PERIOD_TYPE",

"AMENDMENT_SEQ_NO",

"ACTIVE_IND",

"REMARK",

"ROW_CREATED_DATE"

"columnTypes": [

"String",

"String"

"columnUnits": [

null,

null

"columnNullValues": [

null,

null

"values": [

(skipped for the sake of brievity)

"rowCount": 10001

"links": [

{

"rel": "self",

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

"href": "/ivaap/api/ds/mongo/v1/sources/e5d3f935-112a-427a-8e6b-0e24ba84021b/tables/10c71ae9-be6b-46de-8fcf-9b1d7204982c",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": false

{

"rel": "Table",

"name": "Table",

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

"href": "/ivaap/api/ds/mongo/v1/sources/e5d3f935-112a-427a-8e6b-0e24ba84021b/tables/10c71ae9-be6b-46de-8fcf-9b1d7204982c",

"children": false,

"hasProjectEntityChildren": false,

"isProjectEntity": true

}

]

}

The id entry is a unique id of a table.

In content section

name is the name of a table
columnNames is a collection of all column names of a table
columnTypes is a collection of data types of each column
columnUnits is a collection of all column units of measurement
columnNullValues is a collection of values specifying null values for each column
values is a collection of data for each column
rowCount entry is the total number of records

The links section provides a HATEOAS links to the "Table Data Web Service (v3)" service.

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

Report abuse