[itemID]: User Item (Link)

Example usage

The following is a sample ArcGIS Online request URL used to access the user item resource:

Use dark colors for code blocksCopy
1
https://org.arcgis.com/sharing/rest/content/users/jsmith/items/1851c185888a43fcb3d6fffb78ae7c94?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the user item resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/sharing/rest/content/users/jsmith/items/1851c185888a43fcb3d6fffb78ae7c94?f=pjson

Description

An individual user-uploaded item link resource returns alist of groups with which the item is shared. The item is not physically stored in the user's folder but is stored as a link to the original item in the item resource (/content/items/[itemId]). Access to the item via this link is available only to the user.

Request parameters

ParameterDetails

[Common Parameters]

For a complete listing, see Common parameters.

inRecycleBin

Returns an item from the recycle bin. The default is false. If the value is set to true and the item exists in the recycle bin, then the item is successfully returned. This parameter was introduced in the ArcGIS Online June 2024 update.

Values: true | false

Example:

Use dark colors for code blocksCopy
1
https://org.arcgis.com/sharing/rest/content/users/jsmith/items/1851c185888a43fcb3d6fffb78ae7c94?inRecycleBin=true

An error is returned, if the value is set to true and the item does not exist in the recycle bin, or if the value is set to false and the item exists in the recycle bin.

Error message

Use dark colors for code blocksCopy
1
Item does not exist or is inaccessible.

Response properties

PropertyDetails

id

The unique ID for this item.

owner

The username of the user who owns this item.

created

The date the item was created. Shown in UNIX time in milliseconds.

modified

The date the item was last modified. Shown in UNIX time in milliseconds.

name

The file name of the item for file types. Read-only.

title

The title of the item. This is the name that's displayed to users and by which they refer to the item. Every item must have a title.

url

The URL for the resource represented by the item. Applies only to items that represent web-accessible resources such as map services.

type

The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and Web Mapping Application. See the overview section of Items and item types to get an understanding of the item type hierarchy.

typeKeywords

An array of keywords that further describes the type of this item. Each item is tagged with a set of type keywords that are derived based on its primary type.

description

Item description.

tags

An array of user defined tags that describe the item.

snippet

A short summary description of the item.

thumbnail

The URL to the thumbnail used for the item.

extent

An array that defines the bounding rectangle of the item. Should always be in WGS84.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
[
  [
    -117.78452081090789,
    33.46744709844458
  ],
  [
    -72.31511555464664,
    42.11377951830049
  ]
]

categories

An array of organization categories that are set on the item.

Example:

Use dark colors for code blocksCopy
1
2
3
4
[
  "/Categories/Hydrography/River",
  "/Categories/Protected sites"
]

spatialReference

The coordinate system of the item.

accessInformation

Information on the source of the item and its copyright status.

licenseInfo

Any license information or restrictions.

culture

The item locale information (language and country).

access

Indicates the level of access to the item.

Values: private | shared | org | public

proxyFilter

A JSON object used to restrict service item response results based on specified filter, i.e. limit results returned from a geocode service based on defined filters. See serviceProxyFilter for object details.

properties

A JSON object that primarily applies to system requirements, Terms and Conditions, version, supported platforms, YouTube video ID, etc associated with the application. If the item is of type notebook, you can specify the runtime version of the notebook.

Notebook example:

Use dark colors for code blocksCopy
1
properties: {"notebookRuntimeName":"ArcGIS Notebook Python 3 Standard","notebookRuntimeVersion":"5.0"}

appCategories

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

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 used for the application.

banner

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

screenshots

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

listed

If true, the item is listed in the marketplace.

ownerFolder

The ID of the folder in which the owner has stored the item. The property is only returned to the item owner or the org admin.

size

The size of the item in bytes.

protected

Protects the item from deletion. false is the default.

numComments

Number of comments on the item.

numRatings

Number of ratings on the item.

avgRating

Average rating. Uses a weighted average called "Bayesian average."

numViews

Number of views of the item.

itemControl

(Optional)

Indicates user's control to the item.

Values: admin (for item owner and org admin) | update (for members of groups with item update capability that the item is shared with)

contentStatus

Item content status. Organization members, as well as public members for verified organizations, can search for items that have these badges using the contentStatus filter. Authoritative items are automatically protected to prevent accidental deletion and are boosted in search results to increase visibility and encourage use.

Example:

Use dark colors for code blocksCopy
1
"contentStatus": "org_authoritative"

scoreCompleteness

Item information completeness score based upon item snippet, thumbnail, description, title, tags etc.

groupDesignations

Any special groups the item may belong to.

Example:

Use dark colors for code blocksCopy
1
"groupDesignations":"livingatlas"

sharing

A JSON object with two properties access and groups, indicating the level of access to the item and the group IDs with which the item is shared.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "access": "org",
  "groups": [
    "374ad2c62efc462a8b9286034f5f3830",
    "da61010a40ff4b64af28bde5fa7ab72b"
  ]
}

apiToken1ExpirationDate

Epoch in milliseconds. Can be set for the registered app item. Used as expiration date when generating an API Token1.

Example:

Use dark colors for code blocksCopy
1
apiToken1ExpirationDate=1707943987000

apiToken2ExpirationDate

Epoch in milliseconds. Can be set for the registered app item. Used as expiration date when generating an API Token2.

Example:

Use dark colors for code blocksCopy
1
apiToken2ExpirationDate=1708203187000

lastViewed

The date/time the item was last accessed in UNIX format (in milliseconds).

Example:

Use dark colors for code blocksCopy
1
"lastViewed":1613148239000

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
  "item": {
    "id": "<item id>",
    "owner": "<owner username>",
    "created": date created shown in UNIX time,
    "modified": date modified shown in UNIX time,
    "guid": <unique id>,
    "name": "<item name>",
    "title": "<item title>",
    "type": "<type>",
    "typeKeywords": [
      "<keyword1>",
      "<keyword2>",
      "<keyword3>",
      "<keyword4>"
    ],
    "description": "<description>",
    "tags": [
      "<tag1>",
      "<tag2>"
    ],
    "snippet": "<summary>",
    "thumbnail": <file name>,
    "extent": [
      [
        minX,
        minY
      ],
      [
        maxX,
        maxY
      ]
    ],
    "spatialReference": <coordinate system>,
    "accessInformation": "<credits>",
    "licenseInfo": "<access and use constraints>",
    "culture": <culture code>,
    "url": <url>
    "access": "private | public | org | shared",
    "size": <size>,
    "contentStatus": "<contentStatus>",
    "numComments": <number of comments>,
    "numRatings": <number of ratings>,
    "avgRating": <average rating>,
    "numViews": <number of views>,
    "itemControl": "admin | update",
    "scoreCompleteness": <score>,
    "groupDesignations": <special groups list>,
    "apiToken1ExpirationDate": <Epoch in milliseconds>,
    "apiToken2ExpirationDate": <Epoch in milliseconds>,
    "lastViewed": <date/time in UNIX format>
  },
  "sharing": {
    "access": "private | public | org | shared",
    "groups": [<group id1>, <group id2>...]
  }
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "item": {
    "id": "1851c185888a43fcb3d6fffb78ae7c94",,
    "owner": "jsmith33",
    "created": 1264091913000,
    "modified": 1290625900000,
    "guid": null,
    "name": "Usa_Prime_Imagery",
    "title": "Usa_Prime_Imagery",
    "type": "Layer",
    "typeKeywords": [
      "Data",
      "Layer",
      "ArcGIS Pro",
      "ArcGlobe",
      "ArcGIS Explorer",
      "lyr"
    ],
    "description": "This detailed imagery map presents satellite imagery for the world and high-resolution (1m or better) imagery for the United States.",
    "tags": [
      "layer",
      "imagery"
    ],
    "snippet": "Imagery of Southern California",
    "thumbnail": null,
    "documentation": null,
    "extent": [],
    "spatialReference": null,
    "accessInformation": "Provided by Satellite Technologies",
    "licenseInfo": "This imagery is licensed to Satellite Technologies and non-commercial use is allowed.",
    "culture": <en_us>,
    "url": null,
    "access": "org",
    "size": 38912,
    "contentStatus": "org_authoritative",
    "numComments": 6,
    "numRatings": 17,
    "avgRating": 4,
    "numViews": 23,
    "itemControl": "admin",
    "scoreCompleteness": 60,
    "groupDesignations": "livingatlas",
    "apiToken1ExpirationDate": 1707943987000,
    "apiToken2ExpirationDate": 1708203187000,
    "lastViewed": 1613148239000
  },
  "sharing": {
    "access": "org",
    "groups": ["4774c1c2b79046f285b2e86e5a20319e"]
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.