Share Item (as item owner)

Description

Shares the item with the specified list of groups (POST only). Users can only share items with groups to which they belong. This operation also allows you to share the item with everyone, in which case the item is publicly accessible, or to share it with all users of your organization.

An item can have one of four sharing levels represented in the access property of the item: private, public, org, and shared. Private indicates that the item can only be accessed by the user. Public items are accessible by all users. An item shared to the organization has an access level of org. Shared denotes an item shared to one or more groups.

NoteNote:

Only the 'highest' level is shown in the access property. For example, if the item is shared to groups and public, access=public, if the item is shared to groups and org, access=org.

Available to the user and administrators of the organization that the user is part of, if any.

Request Parameters

Parameter

Details

[Common Parameters]

For a complete listing, see Common parameters.

everyone

If true, this item will be shared with everyone, for example, it will be publicly accessible. If explicitly set to false, the item will not be shared with the public.

org

If true, this item will be shared with the organization. If set to false, the item will not be shared with the organization.

groups

A comma-separated list of group IDs with which the item will be shared.

NoteNote:

In order to make an item private, this parameter should be passed in as emtpy, e.g. " ".

confirmItemControl

Set to true when the item will be shared with groups with item update capability so that any member of such groups can update the item that is shared with them.

Response Properties

Property

Details

notSharedWith

Array of groups with which the item could not be shared.

itemId

ID of the item being shared.

Example Usage

URL for Share Item

http://www.arcgis.com/sharing/rest/content/users/jsmith/items/b512083cd1b64e2da1d3f66dbb135956/share
everyone=false
org=true
groups=4774c1c2b79046f285b2e86e5a20319e,cc5f73ab367544d6b954d82cc9c6dab7

JSON Response Syntax

{
  "notSharedWith": [<groups not able to share with>],
  "itemId": "<item id>"
}

JSON Response Example

{
  "notSharedWith": ["cc5f73ab367544d6b954d82cc9c6dab7"],
  "itemId": "b512083cd1b64e2da1d3f66dbb135956"
}

9/13/2017