This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

removeItemResource

Function

Remove a resource associated with an item

Parameters

Parameter Type Default Notes
requestOptions Required IRemoveItemResourceOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

id Inherited string

Unique identifier of the item.

deleteAll Optional boolean

If true, all file resources are removed.

resource Optional string

Resource item to be removed. Resource prefix needs to be specified if the file resource has one.

credentials Optional Inherited RequestCredentials

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

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional 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 Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

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

owner Optional Inherited string

Item owner username. If not present, authentication.username is utilized.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional 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 Optional Inherited boolean

Return the raw response

Returns

A Promise that deletes an item resource.

Promise<{
success:
boolean
}>

Function defined in packages/arcgis-rest-portal/src/items/remove.ts:81