Quick reference

URI

Name

Description

http://<server>/sharing/rest

[Root Resource]

The root resource returns the version of the containing portal. It acts as a root to its child resources and operations. All other URIs in this table are listed relative to the root URI.

/generateToken

Generate Token

The Generate Token operation generates an access token in exchange for user or application credentials. All requests to portals that access secured resources need to include an access token or other authentication credentials depending on the portal.

Search

/search

Search

The Search operation searches against the content in the portal. The search index is updated whenever users add, update, or delete content. There can be a lag between the time the content was updated and the time when it's reflected in the search results. The results only contain items that the user, represented by the access token, has permission to access.

Community

/community

[Community Root]

The portal community root covers user and group resources and operations.

It's a placeholder URI in that there is no response available at this URI. It acts as a root to its child resources and operations.

/community/createGroup

Create Group

The Create Group operation (POST only) creates a new group.

Only authenticated users can create groups. The user who creates the group automatically becomes the owner of the group. The owner of the group is automatically an administrator for the group. The user provides the title for the group. The group ID is generated by the system. If the creating user is part of an organization, the created group is part of the same organization.

/community/self

Self

The community/self resource returns the resource corresponding to the current authenticated user.

Community - Users

/community/users

User Search

The User Search operation can be used to search for users within the portal.

The search index is updated whenever users are created, updated, or deleted. There can be a lag between the time the user was updated and the time when it's reflected in the search results.

The scope of the search is the caller's organization if the caller belongs to an organization for which canSearchPublic is false.

/community/users/<userName>

User

A user resource that represents a registered user in the portal.

Personal details of the user, such as email and groups, are returned only to the user or to an administrator within the user's organization.

Registered usernames are required to be unique within each identity provider supported by a portal.

/community/users/<userName>/update

Update User

The Update User operation (POST only) modifies properties such as full name, description, culture, and so on.

The primary identifier (the username property) cannot be modified. It's available only to the user or to the administrator of the user's organization. Only the properties that are to be updated need to be specified in the request. Properties not specified will not be affected.

/community/users/<userName>/delete

Delete User

The Delete User operation (POST only) is available only to the user in question or to the administrator of the user's organization.

/community/users/<userName>/notifications

User Notifications

The notifications that are available for the given user. Notifications are events that need the user's attention—application for joining a group administered by the user, acceptance of a group membership application, and so on. A notification is initially marked as new. The user can mark it as read or delete the notification.

/community/users/<userName>/notifications/<notificationId>

User Notification

A user notification resource available only to the user in question. A notification has the following fields:

{id : string, type : enum, data: string, status : enum }

Status is either new or read.

Type is the type of notification, e.g., "application to join group" or "invitation to join group."

/community/users/<userName>/notifications/<notificationId>/delete

Delete Notification

The Delete Notification operation (POST only) is available only to the user of the notification.

/community/users/<userName>/tags

User Tags

Users can add tags to content they own. This resource lists all the tags used by the current user along with the number of times each tag has been used.

/community/users/<userName>/invitations

User Invitations

The set of invitations that apply to the current user. Group administrators can invite users into their groups, resulting in the user receiving new invitations to which they can respond.

/community/users/<userName>/invitations/<invitationId>

User Invitation

An individual invitation for a given user.

/community/users/<userName>/invitations/<invitationId>/accept

Accept Invitation to Join Group

Group administrators can invite users into their groups; this results in the user receiving new invitations to which they can respond. The invited user can accept the invitation using the Accept Invitation operation (POST only). This operation adds the invited user to the group, and the invitation is deleted. This operation also creates a notification for the group administrator indicating that the invitation was accepted. Available only to authenticated users.

/community/users/<userName>/invitations/<invitationId>/decline

Decline Invitation to Join Group

An invited user can decline an invitation using the Decline Invitation operation (POST only). This operation deletes the invitation and creates a notification for the group administrator indicating that the invitation was declined. The invited user is not added to the group. Available only to authenticated users.

Community - Groups

/community/groups

Group Search

The Group Search operation can be used to search for groups in the portal.

The search index is updated whenever groups are created, updated, or deleted. There can be a lag between the time the group was updated and the time that it's reflected in the search results.

The results only contain groups that the user has permission to access.

/community/groups/<groupId>

Group

The Group resource represents a group within the portal.

Users can create groups and invite others into the group. Members of a group can use the group to share items amongst themselves.

The owner of a group is automatically an administrator. Admins can add members to a group.

/community/groups/<groupId>/update

Update Group

The Update Group operation (POST only) modifies properties such as the group title, tags, and visibility. Available only to the group administrators.

Only the properties that are to be updated need to be specified in the request. Properties not specified will not be affected.

The group name and organization flag cannot be modified.

/community/groups/<groupId>/reassign

Reassign Group

The Reassign Group operation (POST only) allows the administrator of an organization to reassign a group to another member of the organization.

/community/groups/<groupId>/delete

Delete Group

The Delete Group operation (POST only) is available only to the owner of the group.

/community/groups/<groupId>/join

Join Group

Users apply to join a group using the Join Group operation (POST only). This creates a new group application that the group administrators can accept or decline. This operation also creates a notification for the user indicating that the user had applied to join this group. Available only to authenticated users.

Information pertaining to the applying user, such as full name, email address, or organization, can be sent as part of the group application.

/community/groups/<groupId>/invite

Invite to Group

Using the Invite to Group operation (POST only), a group administrator invites users to join their group. This creates a new user invitation that the users can accept or decline. This operation also creates a notification for the user indicating that the user was invited to join the group. Available only to authenticated users.

/community/groups/<groupId>/leave

Leave Group

The Leave Group operation (POST only) is available to all group members other than the group owner. Leaving a group automatically results in the unsharing of all items the user has shared with the group.

/community/groups/<groupId>/removeUsers

Remove Users from Group

The operation to Remove Users from Group (POST only) is available only to the group administrators, including the owner. Both users and admins can be removed using this operation. Group owners cannot be removed from the group.

/community/groups/<groupId>/users

Group Users

The users, owner, and administrators of a given group are returned.

/community/groups/<groupId>/applications

Group Applications

When users apply to join a group, a group application is created. The group administrators can accept or decline. Available only to the group admins.

/community/groups/<groupId>/applications/<userName>

Group Application

When an individual user applies to join a group, a group application is created. The group administrators can accept or decline. Available only to the group admins.

/community/groups/<groupId>/applications/<userName>/accept

Accept Group Application

When a user applies to join a group, a group application is created. Group administrators can accept this application using the Accept Group Application operation (POST only). This operation adds the applying user to this group, then deletes this application. This operation also creates a notification for the user indicating that the user's group application was accepted. Available only to group admins.

/community/groups/<groupId>/applications/<userName>/decline

Decline Group Application

When a user applies to join a group, a group application is created. Group administrators can decline this application using the Decline Group Application operation (POST only). This operation deletes this application and creates a notification for the user indicating that the user's group application was declined. The applying user will not be added to the group. Available only to group admins.

Content

/content

[Content Root]

The portal content root covers content that is owned by users and shared via groups. It's a placeholder URI in that there is no response available at this URI. It acts as a root to its child resources and operations. All resources and operations (other than publicly accessible items) under this URI require an authenticated user.

/content/users/<userName>[/<folderId>]

User Content Folder

Each item in a portal has a unique URI that is common across all users.

In addition, each user has a personal view of the content they own. The user's content is organized into a set of personal folders.

A user's personal view consists of items that are either in the root content folder for the user (the My Contents home folder) or in a subfolder of the home folder with a given folderId. Multilevel folders are not supported. Each item in the portal has both an absolute and an owner-specific URI.

Accessible only to the user.

/content/users/<userName>/addRelationship

Add Relationship

Adds a relationship of a certain type between two items.

Relationships are not tied to an item. They are directional links from an origin item to a destination item. They have an owner and a type. The type defines the valid origin and destination item types as well as some "composite" rules. See Relationship types.

Users don't have to own any of the items they relate unless the relationship is a composite relationships.

Users can only delete relationships that they own.

Relationships are deleted automatically if one of the two items is deleted.

/content/users/<userName>/deleteRelationship

Delete Relationship

Deletes a relationship of a certain type between two items. The current user must own the relationship to delete it. If the relationship does not exist, an error is thrown.

/content/users/<userName>/createFolder

Create Folder

The Create Folder operation (POST only) is available only on the user's root content folder. Multilevel folders are not supported.

The user provides the title for the folder. The folder ID is generated by the system.

/content/users/<userName>/createService

Create Service

The Create Service operation can be used for creating hosted feature services.

/content/users/<userName>/<folderId>/delete

Delete Folder

The Delete Folder operation (POST only) is available only on the user's non-root folders. The user's root folder cannot be deleted.

Deleting a folder also deletes all items that it contains.

/content/users/<userName>[/<folderId>]/addItem

Add Item

The Add Item operation (POST only) is used to add an item to a user-specified folder. Adding an item can involve uploading an item file, submitting text content, or submitting a URL. This operation is available only to the user specified in the folder URL. The user owning the folder automatically becomes the owner of the item. The item by default is flagged as private (e.g., not shared with any group). This can be changed with the Share operation on the item.

/content/users/<userName>/<itemId>/addPart

Add Part

Add Part allows for multipart item uploads. Each upload takes a part number, which must be sequential.

/content/users/<userName>/<itemId>/Parts

Parts

Lists the file parts of a multiitem upload.

/content/users/<userName>/<itemId>/commit

Commit

Commit is called once all parts are uploaded. The parts are combined into a file, and the original uploads are overwritten. The status call checks the status of the operation.

/content/users/<userName>/<itemId>/cancel

Cancel

Cancels the multipart item upload.

/content/users/<userName>/publish

Publish Item

Publishes a service item to ArcGIS Online. The resulting item is a feature service. Available only to users with an organizational subscription.

/content/users/<userName>/export

Export Item

Exports a service item to the specified output format (POST only). Available only to users with an organizational subscription. Invokable only by the service item owner or an administrator.

/content/users/<userName>/shareItems

Share Items

Shares a batch of items 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 items with "everyone", in which case, the items are publicly accessible.

/content/users/<userName>/unshareItems

Unshare Items

Unshares a batch of items with the specified list of groups (POST only).

/content/users/<userName>/moveItems

Move Items

Moves a batch of items from the current folder to the target folder specified as a parameter.

/content/users/<userName>/deleteItems

Delete Items

Deletes a batch of items from the user's folder.

/content/users/<userName>/<itemId>/status

Status

Inquires about status when publishing an item, adding an item in async mode, or adding with a multipart upload. "Partial" is available for Add Item Multipart, when only a part is uploaded and the item is not committed.

/content/users/<userName>[/<folderId>]/items/<itemId>

User Item

The owner-specific view of an item in a portal. Includes the list of groups that share the item. Access to the item via this URI is available only to the user.

Each item in a portal has a well-known URI (/content/items/<itemId>) that is common across all users. In addition, each item has an owner-specific URI (/content/users/<userName>[/<folderId>]/items/<itemId>) that is accessible only by the owner of the item. The actual item is stored just once.

/content/users/<userName>[/<folderId>]/items/<itemId>/update

Update Item

The Update Item operation (POST only) allows users to update information for an item. Users can use this operation to update item information such as the name, description, tags, and so on.

The parameters that are to be updated need to be specified in the request. Parameters not specified will not be affected. All parameters for this operation are optional.

Available only to the user and administrators.

/content/users/<userName>[/<folderId>]/items/<itemId>/reassignitem

Reassign Item

The Reassign Item operation (POST only) allows the administrator of an organization to reassign a member's item to another member of the organization.

/content/users/<userName>[/<folderId>]/items/<itemId>/delete

Delete Item

The Delete Item operation (POST only) removes an item owned by the user. Available only to the user and administrators.

/content/users/<userName>[/<folderId>]/items/<itemId>/move

Move Item

The Move Item operation (POST only) moves the item from the current folder to the target folder specified as a parameter. Moving an item does not change the well-known URI item, which continues to be /content/items/<itemId>.

Available only to the user and administrators.

/content/users/<userName>[/<folderId>]/items/<itemId>/share

Share Item

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 with your "organization", in which case, everyone within your organization will have access to it.

Available only to the user and administrators.

/content/users/<userName>[/<folderId>]/items/<itemId>/unshare

Unshare Item

Stops sharing the item with the specified list of groups (POST only).

Available only to the user and administrators.

/content/groups/<groupID>

Group Content

The group's content provides access to the items that are shared with the group.

Group items are stored by reference and are not physically stored in a group. Rather, they are stored as links to the original item (/content/items/<itemId>).

Available only to the users of the group.

/content/items/<itemID>

Item

An item in the portal. Items have a title, type, snippet, description, tags, an optional URL (if the item represents a service or other web resource with its own URL), and optional associated data that is available as a child resource (/<item>/data).

Each item in a portal has a well-known URI (/content/items/<itemId>) that's common across all users. In addition, each item has an owner-specific URI (/content/users/<userName>[/<folderId>]/items/<itemId>) that's accessible only by the owner of the item. The actual item is stored just once.

The well-known item is the resource returned by all search operations. Search results do not reflect the organization of items within the contributing user's folders.

/content/items/<itemId>addComment

Add Comment

Adds a comment to an item accessible to you (POST only). Available only to authenticated users.

/content/items/<itemId>/comments

Item Comments

Lists all comments for the item accessible to you. Available only to authenticated users.

/content/items/<itemId>/comments/<commentId>

Item Comment

Lists details for a particular comment.

/content/items/<itemId>/comments/<commentId>/update

Update Comment

Updates a comment on an item that you created (POST only). Available only to authenticated users.

/content/items/<itemId>/comments/<commentId>/delete

Delete Comment

Deletes the selected comment (POST only) on an item that you created. Available only to authenticated users.

/content/items/<itemId>/addRating

Add Rating

Adds a rating to an item accessible to you (POST only). Only one rating can be given to an item per user. If this call is made on an already rated item, the new rating will overwrite the current one. A user cannot rate their own item. Available only to authenticated users.

/content/items/<itemId>/deleteRating

Delete Rating

Deletes the rating that you created for the specified item (POST only).

/content/items/<itemId>/rating

Item Rating

Returns the rating given by the current user, if any.

/content/items/<itemId>/relateditems

Related Items

Gets all the items related by a certain relationship type to this item. An optional direction can be specified if the direction of the relationship is ambiguous. Otherwise, the service will try to infer it.

/content/items/<itemId>/shareItem

Share Item

Shares a public item with groups that you own. For the item owner, this Share Item resource works the same as user share Item.

Available to the user and the administrator of the organization.

/content/items/<itemId>/unshareItem

Unshare Item

Unshares a public item with groups that you own. For the item owner, this Unshare Item resource works the same as user unshare Item.

Available to the user and the administrator of the organization.

/content/items/<itemId>/groups

Groups

The Groups resource lists the groups the user can access for a particular item.

/content/items/<itemId>/data

Item Data

The data component of an item. Getting this resource streams the actual data represented by the item to the client. Only certain types of items have associated data as described in the item types page.

The content type of the response is derived from the mime type of the associated data. If the mime type cannot be derived, the response content type will be set to application/octet-stream.

/content/items/<itemId>/item.pkinfo

Package Info File

The Package Info File for the uploaded item is only available for items that are ArcGIS packages (e.g., Layer Package, Map Package). It contains information that's used by clients (ArcGIS Desktop, ArcGIS Explorer, etc.) to work appropriately with downloaded packages.

The package info file is an XML file, and it's the only format available.

/content/items/<itemId>/info/fileName

Item Info File

An item info file such as the item card, thumbnail, documentation, etc., can be packaged with the uploaded file.

The content type of the response is derived from the info file's mime type. If the mime type cannot be derived, the response content type will be set to application/octet-stream.

/content/features

Feature Operations

Feature operations consist of analyze and publish.

/content/features/analyze/

Analyze

Helps a client analyze a CSV or a shapefile prior to publishing or generating features.

/content/features/generate

Generate

Helps a client generate features from a CSV or shapefile.

Portals

/portals

[Portals Root]

A multitenant portal contains multiple portals, each one of which is owned by and represents an organization. Each user in the multitenant portal belongs to one of these organizational portals or to a default portal that includes all users who do not belong to an organization.

The Portals Root resource is a root placeholder resource that covers all the portals contained in the multitenant portal.

/portals/self

Self (Portal)

The portal to which the current user belongs. This is an organizational portal if the user belongs to an organization or the default portal if the user does not belong to one.

The Portal resource includes information such as the title, thumbnail, and description for the portal and the groups that contain featured content.

/portals/languages

Languages

Lists available languages.

/portals/regions

Regions

Lists available regions.

/portals/<portalId>

Portal

A specific portal within a multitenant portal. Accessible only by authenticated users.

/portals/<portalId>/update

Update Portal

The Update Portal operation allows portal administrators to update the properties of a portal.

Available only to administrators.

/portals/<portalId>/updateUserRole

Update User Role

Updates the role for a specific user within an organization.

Available only to administrators.

/portals/<portalId>/removeUsers

Remove Users

Removes users from an organization.

Available only to administrators.

/portals/<portalId>/addResource

Add Resource

Adds a resource, such as an image, that can be referenced from the description for a portal.

/portals/<portalId>/removeResource

Remove Resource

Removes a resource, such as an image, that can be referenced from the description for a portal.

/portals/<portalId>/users

Portal Users

Returns the set of users that belong to the portal.

/portals/<portalId>/resources

Portal Resources

Returns the set of descriptive resources for the portal.

/portals/<portalId>/isServiceNameAvailable

Check Service Name

This resource checks if a given service name and type are available for publishing a new service. Duplicate names are not allowed. True indicates that the name and type are not found in the organization's services and is available for publishing. False means the requested name and type are not available.

OAuth2

/oauth2

OAuth2 Root

The root of all OAuth2 resources and responses.

/oauth2/authorize

Authorize

This resource allows apps supporting user logins using OAuth2 to allow users to log in to the ArcGIS platform via the app.

/oauth2/token

Token

This resource allows the issuing and refreshing of user access tokens.

7/27/2017