Describe Named Tables

Description

Takes a list of named tables as the input and returns metadata for those tables from 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).

ACL Authorization Flow

To see the metadata of the named tables from the repository from list of named tables as input, the user (or any roles they belong to) will need Execute permission in the following manner:

  • “EXECUTE” for entity type “Location Intelligence.Named Resources”
Note: Note that the response will contain metadata for tables on which user has EXECUTE permission. If the user lists named tables for which they do not have EXECUTE permission or if they list tables that do not exist in the repository, then the metadata response for those tables will contain an access denied error.

HTTP POST URL Format

The following format is used for HTTP POST requests:


HTTP POST:	/tables/metadata.json
POST DATA:	{
                          "namedTablesList": ["/Samples/NamedTables/WorldTable",
                                              "/Samples/NamedTables/USA",
                                              "/InvalidTable"]
                 }

POST BODY: Content-Type:application/json {list of tables}

Parameters

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

Parameter Type Required Description
tables=<tables> List of Strings optional Comma-separated list containing paths of named tables that need to be described.

Returns

Returns the metadata of named tables. The metadata information returned is same as it is for the Describe Table response only wrapped in the TableMetadataList and name is used for identifying the NamedTable.

Example

Request body:

{
    "namedTablesList": ["/Samples/NamedTables/WorldTable",
                        "/Samples/NamedTables/USA",
                        "/InvalidTable"]
}
Response:
{  
   "TableMetadataList":[  
      {  
         "name":"/Samples/NamedTables/WorldTable",
         "Metadata":[...],
         "TableMetadata":{...}
      },
      {  
         "name":"/Samples/NamedTables/USA",
         "Metadata":[...],
         "TableMetadata":{...}
      },
                 {
         "name": "/InvalidTable",
         "errorMessage": "RepositoryEx_ResourceNotFound: Resource was not found - /InvalidTable"
     }
   ]
}