This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

queryRelated

Function
import { queryRelated } from '@esri/arcgis-rest-feature-layer'
//
queryRelated({
 url: "http://services.myserver/OrgID/ArcGIS/rest/services/Petroleum/KSPetro/FeatureServer/0",
 relationshipId: 1,
 params: { returnCountOnly: true }
})
 .then(response) // response.relatedRecords

Query the related records for a feature service. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IQueryRelatedOptions

Available requestOptions

Property Type Notes
url Inherited string

Layer service url.

definitionExpression Optional string
objectIds Optional number[] | number
outFields Optional "*" | string[] | string
relationshipId Optional number
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that will resolve with the query response

Property Type Notes
relatedRecordGroups IRelatedRecordGroup[] | IRelatedRecordGroup
fields Optional IField[] | IField
geometryType Optional GeometryType
spatialReference Optional ISpatialReference
hasM Optional Inherited boolean
hasZ Optional Inherited boolean

Function defined in packages/arcgis-rest-feature-layer/src/queryRelated.ts:67