getItem
import { getItem } from "@esri/arcgis-rest-portal";
//
getItem("ae7")
.then(response);
// or
getItem("ae7", { authentication })
.then(response)
Get an item by id. See the REST Documentation for more information.
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
id Required | string |
Item Id |
|
requestOptions Optional | IRequestOptions |
Options for the request |
Available requestOptions
Property | Type | Notes |
---|---|---|
Optional | IAuthenticationManager |
The instance of |
Optional | RequestCredentials |
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
Optional | function(input: RequestInfo, init: RequestInit) : Promise<Response> |
The implementation of |
Optional | [key: string]: any |
Additional Headers to pass into the request. |
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. |
Optional | HTTPMethods |
The HTTP method to send the request with. |
Optional | number |
If the length of a GET request's URL exceeds |
Optional | IParams |
Additional parameters to pass in the request. |
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'. |
Optional | boolean |
Return the raw response |
Returns
A Promise that will resolve with the data from the response.
Property | Type | Notes |
---|---|---|
number | ||
string | ||
number | ||
number | ||
string | ||
number | ||
string[] | string | ||
Inherited | string | |
Inherited | string | |
Optional | boolean | |
Optional Inherited | string[] | string | |
Optional Inherited | string | |
Optional Inherited | string | |
Optional Inherited | string | |
Optional Inherited | number[] | number[] | number[] | number | |
Optional Inherited | any | |
Optional Inherited | string | |
Optional Inherited | ISpatialReference | |
Optional Inherited | string[] | string | |
Optional Inherited | string |
Function defined in packages/arcgis-rest-portal/src/items/get.ts:37