FRAMES | NO FRAMES | Description | Parameters | Examples | Response |
URL | http://<featurelayer-url>/queryRelatedRecords |
Parent Resource | Layer |
---|
The query operation is performed on a feature service layer resource. The result of this operation are featuresets grouped by source layer / table object IDs. Each featureset contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the featureset. For related tables, the featureset does not include geometries.
Note that all parameters related to geometry will be ignored when querying related tables.
You can provide arguments to the query operation as query parameters defined in the parameters table below.
Parameter | Details |
---|---|
f |
Description: The
response format. The default response format is html. Values: html | json | amf |
objectIds |
Description:
The object IDs of this layer / table to be queried. Records related to these object IDs will be queried.
Syntax: objectIds=<objectId1>, <objectId2>
Example: objectIds=37, 462
|
relationshipId |
Description:
The ID of the relationship to be queried.
The relationships that this layer / table participates in are included in the
Feature Service Layer Resource response.
Records in tables / layers corresponding to the related table / layer of the relationship are queried.
Example: relationshipId=4
|
outFields |
Description:
The list of fields from the related table / layer to be included in the returned featureset. This list
is a comma delimited list of field names. If you specify the
shape field in the list of return fields, it is ignored. To
request geometry, set returnGeometry to true .
You can also specify the wildcard "*" as the value of this parameter. In this case, the results will include all the field values. Example: outFields=AREANAME,ST,POP2000 Example (wildcard usage): outFields=*
|
definitionExpression |
Description:
The definition expression to be applied to the related table / layer.
From the list of objectIds , only those records that conform to this expression will be returned.
Example: definitionExpression=POP2000 > 100000
|
returnGeometry |
Description:
If true , the featureset includes the geometry associated with each feature.
The default is true .
Note that this parameter only applies to related layers. It will be ignored for related tables. Also, note that if the outFields parameter is set to the wildcard "*",
it implicitly implies returnGeometry=true and
setting returnGeometry to false has no effect.
Values: true | false
|
outSR |
Description:
The spatial reference of the returned geometry.
The spatial reference can be specified as either a well-known ID or as a spatial reference json object. If outSR
is not specified, the geometry is returned in the spatial reference of the map.
Note that this parameter only applies to related layers. It will be ignored for related tables. |
Example 1: Query related records
TODO
{ "geometryType" : "<geometryType>", //if records include geometry "spatialReference" : <spatialReference>, //if records include geometry "relatedRecordGroups" : [ { "objectId" : <objectId1>, "relatedRecords" : [ //features may include geometry for related layers only <relatedFeature11>, <relatedFeature12> ] }, { "objectId" : <objectId2>, "relatedRecords" : [ <relatedFeature21>, <relatedFeature22> ] } ] }
{ "geometryType" : "esriGeometryPolygon", "spatialReference" : { "wkid" : 4267 }, "fields" : [ { "name" : "OBJECTID", "type" : "esriFieldTypeOID", "alias" : "OBJECTID"}, { "name" : "FIELD_KID", "type" : "esriFieldTypeString", "alias" : "FIELD_KID", "length" : 25}, { "name" : "APPROXACRE", "type" : "esriFieldTypeDouble", "alias" : "APPROXACRE"}, { "name" : "FIELD_NAME", "type" : "esriFieldTypeString", "alias" : "FIELD_NAME", "length" : 150} ], "relatedRecordGroups" : [ { "objectId" : 3, "relatedRecords" : [ { "attributes" : { "OBJECTID" : 5540, "FIELD_KID" : "1000147595", "APPROXACRE" : 95929, "FIELD_NAME" : "LOST SPRINGS", }, "geometry" : { "rings" : [ [ [ -96.929599633999942, 38.52426809800005 ], [ -96.929602437999961, 38.522448437000037 ], [ -96.92959118999994, 38.529723252000053 ], [ -96.929594022999936, 38.527905578000059 ], [ -96.929596839999988, 38.526087119000067 ], [ -96.929599633999942, 38.52426809800005 ] ] ] } } ] } ] }