getRelatedItems

Function

import { getRelatedItems } from "@esri/arcgis-rest-items";
//
getRelatedItems({
  id: "ae7",
  relationshipType: "Service2Layer" // or several ["Service2Layer", "Map2Area"]
})
  .then(response)

Get the related items. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IItemRelationshipRequestOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

direction Optional "forward" | "reverse"

The direction of the relationship. Either forward (from origin -> destination) or reverse (from destination -> origin).

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.

id string

Id of the item.

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 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

relationshipType ItemRelationshipType | ItemRelationshipType[]

The type of relationship between the two items.

Returns

Promise<IGetRelatedItemsResponse> - A Promise to get some item resources.

Property Type Notes
relatedItems IItem[]
total number

Function defined in packages/arcgis-rest-items/src/get.ts:101