/update: Update Item

title

The title of the item. This is the only name that users and applications use for the title, as there is no concept of display names or aliases in the API.

thumbnail

The path to the thumbnail image to be used for the item. For best results, images that are 600 pixels wide by 400 pixels high or larger with an aspect ratio of 1.5:1 are recommended. Supported file formats are PNG, GIF, and JPEG with a maximum file size of 10 MB. The file will be stored on the sharing servers.

Supported retrievable thumbnail widths for item are 200 pixels (default), 400 pixels, 800 pixels, and 2400 pixels, with an aspect ratio of 1.5:1. Other specified sizes will be snapped to the next highest supported dimension for query. If the original image dimension is smaller than the size queried, the original image will be returned.

Example:

1
subfolder/thumbnail.jpg

Item thumbnails can be retrieved at different dimensions by specifying a URL parameter w for the desired image width:

1
https://<item-url>/info/thumbnail/thumbnail.png?w=400

thumbnailUrl

Enter the URL to the thumbnail image to be used for the item. The recommended image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG. The maximum file size for an image is 1 MB.

1
https://server/arcgis/subfolder/thumbnail.jpg

metadata

The file that stores the metadata information for an item. It's stored in the metadata folder under esriinfo, for example:

https://www.arcgis.com/sharing/rest/content/items/<itemid>/info/metadata/metadata.xml.

Example:

1
metadata.xml

metadataEditable

Indicates if the organization has metadata enabled.

If metadataEditable is true, all members of the organization can view the metadata. Only item owners and administrators can update metadata. If metadataEditable is false, no one in the organization can access the metadata.

Values: true | false

metadataFormats

Metadata style used for organization. Default is iso19139.

Values: fgdc | inspire | iso19139 | iso19139-3.2 | iso19115

typeKeywords

Type keywords describe the type and should logically apply to all items of that type. See Items and Item types for a list of predefined type keywords that will be automatically added based on the supplied type. This parameter should be used only if you want to add additional type keywords. Keywords can be applied to any type of item, in addition to hosted feature services.

Syntax:

1
<keyword1>, <keyword2>

Example:

1
Static

description

An item description. The size of the description needs to be less than 63 KB.

Example:

1
2
3
4
This application represents point locations within the United States
  and Canada for common institution landmark types including hospitals,
  educational institutions, religious institutions, government centers,
  and cemeteries.

tags

Tags are words or short phrases that describe the specific item, separated by commas.

Syntax:

1
<tag1>, <tag2>

Example:

1
landmarks, United States, Canada

snippet

Snippet or summary for the item. Limit this brief descriptive text to 2048 characters.

Example:

1
Landmarks in United States and Canada

extent

The bounding rectangle of the item.

Syntax:

1
<xmin>, <ymin>, <xmax>, <ymax>

Example:

1
-110.05, 44.13, -110, 44.98

spatialReference

The coordinate system of the item.

Example:

1
spGCS_North_American_1983

accessInformation

The source credits for the item.

1
Copyright:© 2008 ESRI, AND, TANA, ESRI Japan, UNEP-WCMC

classification

Introduced at ArcGIS Enterprise 11.4. The classification marking for an item. The JSON object should contain properties related to the attributes specified in the schema and reference a valid value for each attribute. The JSON object must include a banner property. The banner value must correspond to the values for bannerText or bannerTextExpression, whichever was included in the schema. The attributes and values in the banner property must use the value and attribute delimiter information as specified in the schema. Before updating the item's classification it is recommended that the updated classification JSON object be submitted to the Validate Schema operation to ensure its properly formatted.

1
2
3
4
5
6
{
  "classification": "In-confidence",
  "banner": "In-confidence//Legal Privilege/To be reviewed on 2025-05-05",
  "distribution": "Legal Privilege",
  "reviewDate": "2025-05-05"
}

licenseInfo

Includes any license information or restrictions.

1
2
3
This work is licensed under a Creative Commons
  Attribution-Noncommercial-Share Alike 3.0
  United States License.

culture

The item locale (language and country) information. The browser locale will not be taken into consideration if the culture parameter is used to update an item. The format for a culture code is based on a language code and country code, separated by a dash. The language code is based on the two-letter codes found in the Library of Congress Codes for the Representation of Names of Languages. The country code is based on the two-letter codes found by searching the ISO Online Browsing Platform.

Example:

1
en

properties

A JSON object that primarily applies to system requirements, terms and conditions, version, supported platforms, and video IDs associated with the application.

If the item is of type notebook, you can specify the runtime version of the notebook.

Notebook example:

1
2
3
4
{
  "notebookRuntimeName":"ArcGIS Notebook Python 3 Standard",
  "notebookRuntimeVersion":"5.0"
}

url

The URL of the item to be updated.

serviceUsername

Sets the user name on a secure, on-premises map, feature, or image service.

1
myuser1

servicePassword

Sets the password on a secure, on-premises map, feature, or image service.

1
mypassword1

serviceProxyParams

A JSON object that provides rate limiting and referrer checks when accessing secured services.

Example:

1
2
3
4
5
{
  "hitsPerInterval":2,
  "intervalSeconds":60,
  "referrers":["https://<servername>"]
}

serviceProxyFilter

A JSON object with category, sourceCountry, and searchExtent properties that are used to restrict service item response results based on specified filters, such as limiting results returned from a geocode service based on defined filters. This parameter is only applicable to geocoding service item types. The category property is a comma-delimited list of one or more categories from the geocoding service. The sourceCountry property is a 2- or 3-digit country code supported by the geocoding service. The searchExtent property is a JSON envelope object that is used to limit geocoding to a specified search area. The three properties (category, sourceCountry, and searchExtent) can be used independently or in any combination; they are applied as a Boolean AND operator when combined.

Examples:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "sourceCountry": "USA",
  "searchExtent": {
    "xmin": -13184700,
    "ymin": 3988556,
    "xmax": -13004945,
    "ymax": 4061479,
    "spatialReference": {
      "wkid": 102100
    }
  }
}

//or
{
  "category" : "MGRS"
}

createAsServiceProxy

If true, a service URL item is updated as a proxy item without embedding credentials. It can be used to take advantage of the portal sharing model for security reasons, hide actual service URLs, rate limiting and referrer checks, and so on.

Values: true | false

removeServiceProxy

Allows users to remove the service proxy created for an item (true). The default value is false.

Values: true | false

appCategories

An array that primarily applies to a list of categories that the application item is applicable to.

clearEmptyFields

Clears any fields that are passed in empty (true). The default value is false.

Values: true | false

categories

A JSON array or comma-separated list of categories to add to the item.

1
2
3
4
5
//Format one
["/Categories/Basemaps", "/Categories/Transportation"]

//Format two
/Categories/Basemaps, /Categories/Transportation

industries

An array that primarily applies to industries associated with the application.

languages

An array that primarily applies to languages associated with the application.

largeThumbnail

Primarily applies to thumbnails associated with an application. The URL to the thumbnail is used for the application.

banner

Primarily applies to the banner associated with an application. The URL to the banner is used for the application.

screenshot

An array that primarily applies to screen shots associated with an application. The URL to the screen shots is used for the application.

listingProperties

A JSON object that consists of listing properties when the item is listed in ArcGIS Marketplace. For more information on syntax and properties, see Listing properties.

file

The file to be updated.

async

If true, the file is uploaded asynchronously. If false, the file is uploaded synchronously. This only applies to item types that require files. The default value is false.

Values: true | false

text

The JSON content for the item to be updated.

Example:

1
{'myAttribute':'myValue'}

dataUrl

The URL where the item can be downloaded. The resource will be downloaded and stored as a file type. This is 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.

Please see the implementation details section below which discusses this parameter in further details.

multipart

If true, the file is uploaded in multiple parts. See the description above for more information.

Values: true | false

filename

The name of the file being uploaded in multipart mode. This parameter is required if the file is being uploaded in multiple parts and the multipart parameter is set as true.

apiToken1ExpirationDate

OAuth App Token1 expiration date (upto one year from the date it was created) in milliseconds. Once this value is set, any previously generated active API Token1 will be invalidated. This does not invalidate API Token2. The user will be able to generate API Token after setting up this value.

Item needs to be registered first using Register App to set apiToken1ExpirationDate.

Example:

1
1707943987000

Additional usage:

1
2
3
POST /content/users/<username>/items/[itemID]/update

apiToken1ExpirationDate: 1707943987000

apiToken2ExpirationDate

OAuth App Token2 expiration date (upto one year from the date it was created) in milliseconds. Once this value is set, any previously generated active API Token2 will be invalidated. This does not invalidate API Token1. The user will be able to generate API Token after setting up this value.

Item needs to be registered first using Register App to set apiToken2ExpirationDate.

Example:

1
1708203187000

Additional usage:

1
2
3
POST /content/users/<username>/items/[itemID]/update

apiToken2ExpirationDate: 1708203187000

hitsPerInterval

Number of requests that will be allowed within a specified time interval of intervalInSeconds. Default value is 2.

intervalSeconds

Integer value indicating the interval time in seconds. Default value is 60.

referrers

Array of referrers allowed to access service.

success

Indicates if the operation was successful.

id

The ID of the updated item.