Relationship Query Task Activity


An activity that performs an ArcGIS Server query related records operation.

Inheritance Hierarchy:



This activity performs a query using a relationship defined in an ArcGIS server map service. This query will relate records with known IDs from one layer or table to records in another layer or table. The nature of the relationship (join) is defined in the map service (MXD).

In a Workflow:

The Relationship Query Task activity could be used in a workflow where there are known IDs for features of a layer and the map service defines a relationship between those features to some other business data. The known feature IDs are supplied as an argument and the query would return the related records from the other table.


Name Description

In Arguments


The network credentials that are sent to the host and used to authenticate the request.

Custom Parameters

Additional parameters to include in the request.

Definition Expression

The definition expression to be applied to the related table / layer. From the list of records that are related to the specified objectIds, only those records that conform to this expression will be returned. For example: POP2000 > 100000.

Disable Client Caching

If true, adds a timestamp parameter (_ts) to the request to prevent it from being loaded from the application's cache.

Max Allowable Offset

The maximum allowable offset to be used for generalizing geometries returned by the query operation.

Object Ids

The object IDs of this layer/table to be queried. Records related to these object IDs will be queried. This list is a comma delimited list of object ID integers.

Out Fields

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. To return all fields, specify the wildcard '*' as the value of this parameter. In this case, the query results include all the field values. Note that the wildcard also implicitly implies returnGeometry=true and setting returnGeometry to false will have no effect.

Out Spatial Reference

The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the containing map. Note that this parameter only applies to related layers. It will be ignored for related tables.

Proxy Url

The URL to proxy the request through.

Query Service Url

The URL of the ArcGIS Server query service. For example: http://server/arcgis/rest/services/<serviceName>/MapServer/<layerOrTableId>.

Relationship Id


The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Layer/Table Resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried.

Return Geometry

If true, each related records includes geometry. Since the geometry makes up a significant portion of the response, only use this when you plan to use the geometry of the feature, for example, to include them on a map. By default, this is true.

Return M

If true, M values will be included in the results if the features have M values.

Return Z

If true, Z values will be included in the results if the features have Z values.


The token for accessing a secure ArcGIS task.


Display Name


You can change the name of an activity to one that describes what it does. A descriptive name can make a workflow easier to interpret and maintain.

Out Arguments


The results of the related records query.

Version Information:

Supported from: Geocortex Essentials 3.7.