This section describes how this API works. You may want to try it out with a Free Trial Account.
- URL Composition
- Base URL: https://api.cloud.precisely.com
- Get Table Metadata: /v1/spatial/tables/{tableName}/metadata
- Supported Methods: GET only
- Rate Limit (Transactions per second): 100
-
Authentication and Input Fields: Data Integrity Suite's APIs provide multiple authentication methods. Whether you want to pass the API Key and Secret directly as part of the Basic Authentication header or use bearer tokens, you can do either using the same header. The two ways of authentication are:
- Basic Authentication (Using API Key and secret)
- Bearer Token Authentication
For more information about authentication, see How to Authenticate and follow the instructions.
Description
Returns metadata for a table present in database. Information in the response includes table name, schema, columns and their description and type, bounding box in case of spatial table and row count.
GET URL Format
The following format is used for HTTP GET requests.
HTTP GET
https://api.cloud.precisely.com/v1/spatial/tables/{tableName}/metadataQuery Parameters
This operation takes these query parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| tableName | String | Yes | Name of the table for which the metadata needs to be described. |
Examples
Request
https://api.cloud.precisely.com/v1/spatial/tables/risks/flood_risk/metadataResponse
{
"tableName": "risks/flood_risk",
"geometryType": "polygon",
"numberOfRows": 7651291,
"columns": [
{
"columnName": "incremental_s_no",
"description": "",
"dataType": "LONG_INTEGER",
"queryable": true
},
{
"columnName": "id",
"description": "Unique identifier for flood polygon",
"dataType": "INTEGER",
"queryable": true
},
{
"columnName": "mapname",
"description": "FEMA map panel identifier",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "type",
"description": "Flood zone map type",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "statecode",
"description": "State FIPS code.",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "floodzone",
"description": "Flood zone with base flood elevation (BFE_ELEV) or additional information",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "prim_zone",
"description": "Flood zone",
"dataType": "STRING",
"queryable": true
},
{
"columnName": "addl_info",
"description": "Additional information",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "bfe_elev",
"description": "Base flood elevation (BFE), in feet.",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "commnum",
"description": "Community number",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "commstatus",
"description": "Community status in the National Flood Insurance Program (NFIP)",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "map_eff_date",
"description": "Map effective date",
"dataType": "DATE_TIME",
"queryable": false
},
{
"columnName": "rms_err",
"description": "Method used to adjust paper maps to digital street layer for digitization. This method is not used with new DFIRM maps.",
"dataType": "INTEGER",
"queryable": false
},
{
"columnName": "lomr_date",
"description": "Letter of Map Revision date",
"dataType": "DATE_TIME",
"queryable": false
},
{
"columnName": "casenumber",
"description": "Letter of Map Revision case number",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "wkt",
"description": "",
"dataType": "STRING",
"queryable": false
},
{
"columnName": "geom",
"description": "Geometry",
"dataType": "FEATURE_GEOMETRY",
"queryable": true
}
],
"xMin": -179.14445,
"xMax": 179.78165,
"yMin": 13.23399,
"yMax": 71.44105
}