Describe a Table's Metadata

Description

Returns metadata for a named table in the repository. Information in the response includes the table coordinate reference system, bounding box, columns and their types, and geohash index details (scale and precision).
Note: In case of named table referring to a Raster, Describe Named Table operation returns raster width and height. In case of MRR, field and band details also appear. See Raster section in this page.

ACL Authorization Flow

To return metadata for a single named table in the repository, the user (or any roles they belong to) will need Execute permission on the named table in the following manner:

  • “EXECUTE” for entity type “Location Intelligence.Named Resources”

HTTP GET URL Format

The following format is used for HTTP GET requests:


HTTP GET /tables/tablename/metadata.rep
			

Parameters

For information on the parameter types listed below, see Request URL Data Types.

Parameter Type Required Description
tablename String yes The name of the table to return metadata. The table is specified by a Regex for the named table to render based on the location of the named table in the repository. The name of the named table is defined between the /tables portion of the URL and the /metadata.rep portion of the URL. For example, to return the metadata for a named table located at /Samples/NamedTables/WorldTable in the repository, the following URL would be used:
.../FeatureService/tables/Samples/NamedTables
/WorldTable/metadata.json;...
rep String yes The representation to be returned. Supported representation is json.

Returns

Returns metadata for a named table in the repository.

Example

Returns the metadata for the table WorldTable located in the /Samples/NamedTables directory in the repository.

http://hostname/rest/Spatial/FeatureService/tables/Samples/NamedTables/WorldTable/
metadata.json

Raster

In case of Named Table referring to raster, the Describe Named Table operation will return raster-specific information.

Request

http://hostname/rest/Spatial/FeatureService/tables/Samples/NamedTables/MRRWorldTable/
metadata.json

Response

{
   "Metadata":[
      {
         "name":"MI_RASTER",
         "type":"Raster",
         "crs":{
            "type":"name",
            "properties":{
               "name":"epsg:3395"
            }
         },
         "bbox":[
            -70.0,
            -173.46657488287798,
            186.0,
            82.53342511712202
         ]
      },
      {
         "name":"MI_Style",
         "type":"Style"
      }
   ],
   "TableMetadata":{
      "supportsInsert":false,
      "supportsDelete":false,
      "supportsUpdate":false,
      "KeyDefinition":{
         "type":"Implicit",
         "attributes":[
            "MapInfo_ID"
         ]
      },
      "rasterMetadata":{
         "width":128,
         "height":128,
         "supportsGridCellValue":true,
         "fields":[
            {
               "name":"Field0",
               "type":"Imagery",
               "bands":[
                  {
                     "name":"Band00",
                     "type":"Concrete",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"RED",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"GREEN",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"BLUE",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  }
               ]
            },
            {
               "name":"Field1",
               "type":"Imagery",
               "bands":[
                  {
                     "name":"Band00",
                     "type":"Concrete",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"RED",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"GREEN",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"BLUE",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  }
               ]
            },
            {
               "name":"Field2",
               "type":"Imagery",
               "bands":[
                  {
                     "name":"Band00",
                     "type":"Concrete",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"RED",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"GREEN",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  },
                  {
                     "name":"BLUE",
                     "type":"Component",
                     "dataType":"Integer",
                     "mapInfoUnits":"Undefined"
                  }
               ]
            }
         ]
      }
   }
}

This response contains additional raster size, field, and band details under the “rasterMetadata”.

The following table describes the fields used in the response:

Parameter Description
rasterMetadata Contains the metadata of the ratser in terms of raster size, field, and band details.
width Specifies the width of raster in pixels.
height Specifies the height of raster in pixels.
supportsGridCellValue Specifies whether the raster supports the grid cell value.
fields Specifies fields as array object. Each field object contains its name, type and bands in it. Applicable only for MRR.
name Specifies the name of the field.
type Defines the types of fields supported in MapInfo Pro Advanced. There are four types of fields:
  1. Classified
  2. Continuous
  3. Imagery
  4. Image Palette
bands Specifies bands in the MRR Field as array. Band object contains its name, type, data type, and mapinfoUnits.
name Specifies the name of the band.
type Specifies the source of the raster band values. Band types can be of the following types:
  1. Concrete: Band data is stored in the raster dataset.
  2. Concrete: Band data is stored in the raster dataset.
  3. Table Field: Band data is acquired from a classification table field.
  4. Table Field Component: Band data is an acquired component of another band acquired from a classification table field.
dataType Specifies the data type of the band. For example, Byte, Short, Integer, Long, BigInteger, Double, String, and so on.
mapInfoUnits Defines the MapInfo units. For example, miles, meters, chains, nautical miles, degree, arc minute, and so on.