Skip To Content

Entity

Description

An entity describes a table or view in a database. This resource provides information about whether the entity has any field of type esriFieldTypeGeometry, which (if any) fields participate in the primary key, and whether any indexes have been defined.

Request Parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json

Example Usage

https://services.myserver.com:port/arcgis/rest/services/<serviceName>/RelationalCatalogServer/entities/<entityCatalogId>?f=json

JSON Response Syntax


{
  "entity":{
    "hasGeometry": true | false,
    "primaryKeyFields": [], //comma-separated array of field catalog IDs
    "indexInfo": [
      {
         "type": "ATTRIBUTE" | "SPATIAL",
         "fields":[], //comma-separated array of field catalog IDs
         "unique": true | false
      },…
    ]
  }
}

JSON Response Example


{
  "entity":{
    "hasGeometry": true,
    "primaryKeyFields": ["dbo.flight_route.id"],
    "indexInfo": [
      {
         "type": "ATTRIBUTE",
         "fields":["dbo.flight_route.id"],
         "unique": true
      },
      {
         "type": "SPATIAL",
         "fields":["dbo.flight_route.shape_geog"],
         "unique": false
      },
      {
         "type": "SPATIAL",
         "fields":["dbo.flight_route.shape_geom"],
         "unique": false
      }
    ]
  }
}