queryRelated

Function

import { queryRelated } from '@esri/arcgis-rest-feature-service'
//
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 IQueryRelatedRequestOptions

Available requestOptions

Property Type Notes
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

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

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

headers Optional Inherited

Additional Headers to pass into the request.

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.

objectIds Optional number[]
outFields Optional "*" | string[]
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 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

relationshipId Optional number
url string

Returns

Promise<IQueryRelatedResponse> - A Promise that will resolve with the query response

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

Function defined in packages/arcgis-rest-feature-service/src/queryRelated.ts:66