ArcGIS Online and Enterprise content and user helpers for ArcGIS REST JS.
Install
npm install @esri/arcgis-rest-portal
Import
@esri/arcgis-rest-portal
is distributed as both ES Modules and Common JS modules.
import * as portalTools from "@esri/arcgis-rest-portal"
const portalTools = require("@esri/arcgis-rest-portal");
CDN
You can use @esri/arcgis-rest-portal
as an ES Module from the esm.run CDN.
<script type="module">
import * as portalTools from "https://esm.run/@esri/arcgis-rest-portal@4.5.0";
</script>
You can also use @esri/arcgis-rest-portal
from a script tag. All exports will be added to a global arcgisRest
object.
<script
src="https://unpkg.com/@esri/arcgis-rest-portal@4.5.0/dist/bundled/portal.umd.js"
integrity="sha512-woZ7/O5Wg0nNahdw2KkpROhzgSXvocL3xR9Z9wju/PpJKr9mX34P7qSAUPYPLyTfYVlkCQLCNTaNv9+1a6Ep9g==">
</script>
Exports
- SearchQueryBuilder
- acceptInvitation
- addGroupUsers
- addItemData
- addItemPart
- addItemRelationship
- addItemResource
- bboxToString
- cancelItemUpload
- commitItemUpload
- createFolder
- createGroup
- createGroupNotification
- createItem
- createItemInFolder
- createOrgNotification
- declineInvitation
- determineOwner
- determineUsername
- ensureMembership
- exportItem
- getGroup
- getGroupCategorySchema
- getGroupContent
- getGroupUsers
- getItem
- getItemBaseUrl
- getItemData
- getItemGroups
- getItemInfo
- getItemMetadata
- getItemParts
- getItemResource
- getItemResources
- getItemStatus
- getPortal
- getPortalSettings
- getPortalUrl
- getRelatedItems
- getSelf
- getSharingUrl
- getUniqueServiceName
- getUser
- getUserContent
- getUserInvitation
- getUserInvitations
- getUserMembership
- getUserNotifications
- getUserProperties
- getUserTags
- getUserUrl
- inviteGroupUsers
- isBBox
- isItemOwner
- isItemSharedWithGroup
- isOrgAdmin
- isServiceNameAvailable
- joinGroup
- leaveGroup
- moveItem
- protectGroup
- protectItem
- reassignItem
- removeFolder
- removeGroup
- removeGroupUsers
- removeItem
- removeItemRelationship
- removeItemResource
- removeNotification
- scrubControlChars
- searchCommunityUsers
- searchGroupContent
- searchGroupUsers
- searchGroups
- searchItems
- searchUsers
- setItemAccess
- setUserProperties
- shareItemWithGroup
- unprotectGroup
- unprotectItem
- unshareItemWithGroup
- updateGroup
- updateItem
- updateItemInfo
- updateItemResource
- updateUser
- updateUserMemberships
- IAddFolderResponse
- IAddGroupUsersOptions
- IAddGroupUsersResult
- IAddItemDataOptions
- ICommitItemOptions
- ICreateFolderOptions
- ICreateGroupNotificationOptions
- ICreateGroupOptions
- ICreateItemOptions
- ICreateItemResponse
- ICreateOrgNotificationOptions
- ICreateOrgNotificationResult
- ICreateUpdateItemOptions
- IExportItemRequestOptions
- IExportItemResponse
- IExportLayerInfo
- IExportParameters
- IFolder
- IFolderIdOptions
- IGetGroupContentOptions
- IGetItemGroupsResponse
- IGetItemInfoOptions
- IGetItemPartsResponse
- IGetItemResourceOptions
- IGetItemStatusResponse
- IGetRelatedItemsResponse
- IGetUserInvitationOptions
- IGetUserOptions
- IGetUserTagsResponse
- IGroup
- IGroupAdd
- IGroupCategory
- IGroupCategorySchema
- IGroupContentResult
- IGroupSharingOptions
- IGroupUsersResult
- IInvitation
- IInvitationResult
- IInviteGroupUsersOptions
- IInviteGroupUsersResult
- IItem
- IItemAdd
- IItemDataOptions
- IItemInfoOptions
- IItemInfoResponse
- IItemPartOptions
- IItemRelationshipOptions
- IItemResourceOptions
- IItemResourceResponse
- IItemStatusOptions
- IItemUpdate
- IManageItemRelationshipOptions
- IMoveItemOptions
- IMoveItemResponse
- INotification
- INotificationResult
- IPagedResponse
- IPagingParams
- IPortal
- IPortalSettings
- IRemoveGroupUsersOptions
- IRemoveGroupUsersResult
- IRemoveItemResourceOptions
- IRemoveNotificationOptions
- ISearchGroupContentOptions
- ISearchGroupUsersOptions
- ISearchGroupUsersResult
- ISearchOptions
- ISearchResult
- IServiceNameAvailable
- ISetAccessOptions
- ISharingOptions
- ISharingResponse
- ITagCount
- IUpdateGroupOptions
- IUpdateGroupUsersOptions
- IUpdateGroupUsersResult
- IUpdateItemOptions
- IUpdateItemResponse
- IUpdateUserOptions
- IUpdateUserResponse
- IUser
- IUserContentRequestOptions
- IUserContentResponse
- IUserGroupOptions
- IUserItemOptions
- IUserProperties
- IUserSearchOptions
- FetchReadMethodName
- GroupMembership
- ItemRelationshipType
- NotificationChannelType
- UnixTime