import { getItemResource } from "@esri/arcgis-rest-portal";

// Parses contents as blob by default getItemResource("3ef", { fileName: "resource.jpg", ...}) .then(resourceContents => {});

// Can override parse method getItemResource("3ef", { fileName: "resource.json", readAs: 'json', ...}) .then(resourceContents => {});

// Get the response object instead getItemResource("3ef",{ rawResponse: true, fileName: "resource.json" }) .then(response => {})

Fetches an item resource and optionally parses it to the correct format.

Note: provides JSON parse error protection by sanitizing out any unescaped control
characters before parsing that would otherwise cause an error to be thrown


Parameter Type Default Notes
itemId Required string
requestOptions Required IGetItemResourceOptions

Available requestOptions

Property Type Notes
fileName string

Name of the info file, optionally including the folder path

readAs Optional FetchReadMethodName

How the fetch response should be read, see:

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 ''.

rawResponse Optional Inherited boolean

Return the raw response



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