ICreateServiceOptions

Interface

Inheritance: ICreateServiceOptionsICreateUpdateItemOptions

Properties

Hide inherited properties
PropertyTypeNotes
async
 inherited 
boolean

If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.

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.

dataUrl
 inherited 
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.

file
 inherited 

The file to be uploaded. If uploading a file, the request must be a multipart request.

filename
 inherited 
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.

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.

A JSON object specifying the properties of the newly-created service. See the REST Documentationfor more information.

maxUrlLength
 inherited 
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

multipart
 inherited 
boolean

If true, the file is uploaded in multiple parts.

overwrite
 inherited 
boolean

If true, overwrite the existing file.

owner
 inherited 
string

The owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.username.

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.

text
 inherited 
string

The text content for the item to be submitted.

async

optionalinherited
Interface Property
async: boolean

If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously.

authentication

inherited
Interface Property
authentication: ArcGISIdentityManager

A session representing a logged in user.

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

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

dataUrl

optionalinherited
Interface Property
dataUrl: 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.

file

optionalinherited
Interface Property
file: File | Blob

The file to be uploaded. If uploading a file, the request must be a multipart request.

filename

optionalinherited
Interface Property
filename: string

The filename being uploaded in multipart mode. Required if multipart=true.

folderId

optional
Interface Property
folderId: string

Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the root folder.

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any

hideToken

optionalinherited
Interface Property
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

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

item

Interface Property
item: ICreateServiceParams

A JSON object specifying the properties of the newly-created service. See the REST Documentationfor more information.

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

multipart

optionalinherited
Interface Property
multipart: boolean

If true, the file is uploaded in multiple parts.

overwrite

optionalinherited
Interface Property
overwrite: boolean

If true, overwrite the existing file.

owner

optionalinherited
Interface Property
owner: string

The owner of the item. If this property is not present, item.owner will be passed, or lastly authentication.username.

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

portal

optionalinherited
Interface Property
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'.

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

signal

optionalinherited
Interface Property
signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

text

optionalinherited
Interface Property
text: string

The text content for the item to be submitted.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.