Interface
Properties
Property | Type | Notes |
---|---|---|
authentication inherited | A session representing a logged in user. | |
credentials inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
"html" | The response format. The default and the only response format for this resource is HTML. | |
headers inherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideToken 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 inherited | The HTTP method to send the request with. | |
id inherited | string | Unique identifier of the item. |
string | The job ID returned during publish, generateFeatures, export, and createService calls. | |
"publish" | "generateFeatures" | "export" | "createService" | The type of asynchronous job for which the status has to be checked. Default is none, which check the item's status. | |
maxUrlLength inherited | number | If the length of a GET request's URL exceeds |
owner inherited | string | Item owner username. If not present, |
params inherited | Additional parameters to pass in the request. | |
portal inherited | 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 inherited | boolean | Return the raw response |
signal inherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarnings inherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
authentication
authentication: ArcGISIdentityManager
A session representing a logged in user.
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
format
format: "html"
The response format. The default and the only response format for this resource is HTML.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: 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
httpMethod: HTTPMethods
The HTTP method to send the request with.
jobId
jobId: string
The job ID returned during publish, generateFeatures, export, and createService calls.
jobType
jobType: "publish" | "generateFeatures" | "export" | "createService"
The type of asynchronous job for which the status has to be checked. Default is none, which check the item's status.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
owner
owner: string
Item owner username. If not present, authentication.username
is utilized.
portal
portal: 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'.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.