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.

getPortalUrl

Function

Helper that returns the appropriate portal url for a given request. requestOptions.portal is given precedence over authentication.portal. If neither portal nor authentication is present, www.arcgis.com/sharing/rest is returned.

Parameters

Parameter Type Default Notes
requestOptions Optional IRequestOptions {}

Request options that may have authentication manager

Available requestOptions

Property Type Notes
authentication Optional IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

credentials Optional RequestCredentials

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

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.

hideToken Optional 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 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 authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional boolean

Return the raw response

Returns

Portal url to be used in API requests

string

Function defined in packages/arcgis-rest-portal/src/util/get-portal-url.ts:14