addItemResource

Function

import { addItemResource } from '@esri/arcgis-rest-items';

Parameters

Parameter Type Default Notes
requestOptions Required IItemResourceRequestOptions

Options for the request

Available requestOptions

Property Type Notes
authentication Inherited UserSession

A session representing a logged in user.

content Optional string

Text input to be added as a file resource.

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

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

headers Optional Inherited

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

id Inherited string

Unique identifier of the item.

maxUrlLength Optional Inherited number

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

name Optional string

New resource filename.

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

private Optional boolean

Controls whether access to the file resource is restricted to the owner or inherited from the sharing permissions set for the associated item.

rawResponse Optional Inherited boolean

Return the raw response

resource Optional any

Object to store

Returns

Promise<IItemResourceResponse> - A Promise to add item resources.


// Add a file resource addItemResource({ id: '3ef', resource: file, name: 'bigkahuna.jpg', authentication }) .then(response)

// Add a text resource addItemResource({ id: '4fg', content: "Text content", name: 'bigkahuna.txt', authentication }) .then(response)

Add a resource associated with an item. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-resources.htm) for more information.
Property Type Notes
folder string
itemId string
owner string
success boolean

Function defined in packages/arcgis-rest-items/src/add.ts:166