request

Function
import { request } from '@esri/arcgis-rest-request';
//
request('https://www.arcgis.com/sharing/rest')
  .then(response) // response.currentVersion === 5.2
//
request('https://www.arcgis.com/sharing/rest', {
  httpMethod: "GET"
})
//
request('https://www.arcgis.com/sharing/rest/search', {
  params: { q: 'parks' }
})
  .then(response) // response.total => 78379

Generic method for making HTTP requests to ArcGIS REST API endpoints.

Parameters

Parameter Type Default Notes
url Required string

The URL of the ArcGIS REST API endpoint.

requestOptions Optional IRequestOptions { params: { f: "json" } }

Options for the request, including parameters relevant to the endpoint.

Available requestOptions

Property Type Notes
authentication Optional IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

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

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

headers Optional [key: string]: any

Additional Headers to pass into the request.

httpMethod Optional HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional number

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

params Optional IParams

Additional parameters to pass in the request.

portal Optional string

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

rawResponse Optional boolean

Return the raw response

Returns

A Promise that will resolve with the data from the response.

Promise<any>

Function defined in packages/arcgis-rest-request/src/request.ts:189