updateVersionMetadata

Function

Updates the specified version's metadata

Parameters

Parameter Type Default Notes
id Required string
versionMetadata Required IVersionMetadata
owner Required string
requestOptions Required IHubUserRequestOptions

Available requestOptions

Property Type Notes
authentication UserSession
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.

hubApiUrl Optional Inherited string
isPortal Optional Inherited boolean
maxUrlLength Optional Inherited number

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

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

portalSelf Optional Inherited IHubRequestOptionsPortalSelf
rawResponse Optional Inherited boolean

Return the raw response

Returns

Promise<IVersionMetadata>
Property Type Notes
created number

The created timestamp

creator string

The username of the creator

id string

The id of the version

path string

The full path to the version

updated number

The updated timestamp

access Optional string

The access level of the version resource

description Optional string

The description of the version

name Optional string

The name of the version

parent Optional string

The parent version id

size Optional number

The size of the version resource


Function defined in common/src/versioning/updateVersionMetadata.ts:21