updateItem

Function
import { updateItem } from "@esri/arcgis-rest-portal";
//
updateItem({
  item: {
    id: "3ef",
    description: "A three hour tour"
  },
  authentication
})
  .then(response)

Update an Item. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IUpdateItemOptions

Options for the request.

Available requestOptions

Property Type Notes
item IItemUpdate
authentication Inherited UserSession

A session representing a logged in user.

async Optional Inherited boolean

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

credentials Optional Inherited RequestCredentials

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

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

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

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

file Optional Inherited any

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

filename Optional Inherited string

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

folderId Optional Inherited string

Id of the folder to house the item.

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.

multipart Optional Inherited boolean

If true, the file is uploaded in multiple parts.

overwrite Optional Inherited boolean

If true, overwrite the existing file.

owner Optional Inherited string

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

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

text Optional Inherited string

The text content for the item to be submitted.

Returns

A Promise that updates an item.

Property Type Notes
id string
success boolean

Function defined in packages/arcgis-rest-portal/src/items/update.ts:54