moveItem

Function

import { moveItem } from '@esri/arcgis-rest-items';
//
moveItem({
  itemId: "3ef",
  folderId: "7c5",
  authentication: userSession
})

Move an item to a folder. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IItemMoveRequestOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

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

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

folder Optional Inherited string

Id of the folder to house the item.

folderId Optional string

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

headers Optional Inherited

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

itemId string

Alphanumeric id of item to be moved.

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

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 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

Promise<IItemMoveResponse> - A Promise that resolves with owner and folder details once the move has been completed

Property Type Notes
folder string

Alphanumeric id of folder now housing item.

itemId string

Alphanumeric id of moved item.

owner string

Name of owner of item.

success boolean

Success or failure of request.


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