Skip To Content

Related Entities

  • URL:https://<catalog-url>/<serviceName>/RelationalCatalogServer/entities/<entityCatalogId>/relatedEntities
  • Version Introduced:10.5

Description

This resource provides information about any entities that are related to the current entity via a relationship that is established in the database's data dictionary.

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>/relatedEntities?f=json

JSON Response Syntax


{
  "relatedEntities":[
    {
      "catalogId":"",   //id of table/view that is related to the current one
      "keyFields":[],  //one or more fields used to establish a relationship with parent table/view
      "parentKeyFields":[] //one or more fields in the parent table/view that relate to the specified keyFields
    },…
  ]
}

JSON Response Example


{
  "relatedEntities":[
    {
      "catalogId":"dbo.flight_departure",
      "keyFields":["dbo.flight_departure.route_id"],
      "parentKeyFields":["dbo.flight_route.id"]
    }
  ]
}