Interface
Properties
| Property | Type | Notes |
|---|---|---|
asyncinherited | boolean | If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously. |
authenticationinherited | A session representing a logged in user. | |
credentialsinherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
dataUrlinherited | string | The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item. |
fileinherited | The file to be uploaded. If uploading a file, the request must be a multipart request. | |
filenameinherited | string | The filename being uploaded in multipart mode. Required if multipart=true. |
string | Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the root folder. | |
headersinherited | { [key: string]: any } | Additional Headers to pass into the request. |
hideTokeninherited | 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. |
httpMethodinherited | The HTTP method to send the request with. | |
boolean | Specifies if the request is generating a location tracking view. A view can only be created if there is already a Location Tracking Service that has been created. | |
A JSON object specifying the properties of the newly-created service. See the REST Documentationfor more information. | ||
maxUrlLengthinherited | number | If the length of a GET request's URL exceeds |
multipartinherited | boolean | If true, the file is uploaded in multiple parts. |
boolean | If true, the service is overwritten. The default value is false. | |
ownerinherited | string | The owner of the item. If this property is not present, |
paramsinherited | Additional parameters to pass in the request. | |
portalinherited | 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'. |
rawResponseinherited | boolean | Return the raw response |
signalinherited | AbortSignal | An AbortSignal object instance; allows you to abort a request and via an AbortController. |
suppressWarningsinherited | boolean | Suppress any ArcGIS REST JS related warnings for this request. |
textinherited | string | The text content for the item to be submitted. |
async
async: booleanIf true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.
authentication
authentication: ArcGISIdentityManagerA session representing a logged in user.
credentials
credentials: RequestCredentialsA string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
dataUrl
dataUrl: stringThe URL where the item can be downloaded. The resource will be downloaded and stored as a file type. Similar to uploading a file to be added, but instead of transferring the contents of the file, the URL of the data file is referenced and creates a file item.
file
file: File | BlobThe file to be uploaded. If uploading a file, the request must be a multipart request.
filename
filename: stringThe filename being uploaded in multipart mode. Required if multipart=true.
folderId
folderId: stringAlphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the root folder.
headers
headers: { [key: string]: any }Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
hideToken: booleanPrevents 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: HTTPMethodsThe HTTP method to send the request with.
isView
isView: booleanSpecifies if the request is generating a location tracking view. A view can only be created if there is already a Location Tracking Service that has been created.
item
Interface Propertyitem: ICreateServiceParamsA JSON object specifying the properties of the newly-created service. See the REST Documentationfor more information.
maxUrlLength
maxUrlLength: numberIf the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
multipart
multipart: booleanIf true, the file is uploaded in multiple parts.
overwrite
overwrite: booleanIf true, the service is overwritten. The default value is false.
owner
owner: stringThe owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.username.
params
params: IParamsAdditional parameters to pass in the request.
portal
portal: stringBase 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: AbortSignalAn AbortSignal object instance; allows you to abort a request and via an AbortController.
suppressWarnings
suppressWarnings: booleanSuppress any ArcGIS REST JS related warnings for this request.
text
text: stringThe text content for the item to be submitted.