ICreateServiceOptions

Interface

Inheritance: ICreateServiceOptionsICreateUpdateItemOptions

Properties

PropertyTypeNotes
async
 optional 
boolean

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

A session representing a logged in user.

credentials
 optional 
RequestCredentials

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

dataUrl
 optional 
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
 optional 

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

filename
 optional 
string

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

folderId
 optional 
string

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

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

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

httpMethod
 optional 

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
 optional 
number

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

multipart
 optional 
boolean

If true, the file is uploaded in multiple parts.

overwrite
 optional 
boolean

If true, overwrite the existing file.

owner
 optional 
string

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

params
 optional 

Additional parameters to pass in the request.

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

rawResponse
 optional 
boolean

Return the raw response

signal
 optional 
AbortSignal

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

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

text
 optional 
string

The text content for the item to be submitted.

async optional

async: boolean

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

authentication

authentication: ArcGISIdentityManager

A session representing a logged in user.

credentials optional

credentials: RequestCredentials

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

dataUrl optional

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 optional

file: File | Blob

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

filename optional

filename: string

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

folderId optional

folderId: string

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

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

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 optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

item

item: ICreateServiceParams

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

maxUrlLength optional

maxUrlLength: number

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

multipart optional

multipart: boolean

If true, the file is uploaded in multiple parts.

overwrite optional

overwrite: boolean

If true, overwrite the existing file.

owner optional

owner: string

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

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

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 optional

rawResponse: boolean

Return the raw response

signal optional

signal: AbortSignal

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

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

text optional

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.