Updated operations and resources

Organization webhooks can now be created or updated to include new event triggers for adding, deleting, and updating comments left on items, as well as event triggers for users requesting to join organization groups.

New item types

Knowledge Studio Project— A Knowledge Studio Project file contains all of the information needed to store a working instance of the application. This includes references or definitions to investigations, link charts, maps, or data cards as well as Knowledge Studio specific configuration settings.

New operations, item types and privileges

• /canReassign— A new endpoint, that checks whether the item owned by one user can be successfully reassigned to another user.
• Pro Report Template— A new item type, that contains a user defined report. Once added and opened in ArcGIS Pro, the user can specify a data source, and then view and export the report. Available to Organizations and public accounts.
• premium:user:places— A new premium privilege that grants the ability to perform local place, or point of interest search with the new places-service (beta). This is available only for developers subscriptions.

Updated operations and resources

• A new property, iotViewerUrl, has been added as a supported property for the portalConfigProperties JSON object in the Settings resource and Update Settings operation. The iotViewerUrl property represents the URL ArcGIS Velocity application that points to an installed ArcGIS Velocity deployment.
• The Search operation supports the enriched parameter. The enriched parameter specifies whether the search results will include both literal and relevant matches or only literal matches.
• The Portal resource has been updated to return a semanticSearchEnabled property as part of the portalProperties JSON object.
• The Export Group operation now supports including the Web Experience and Web Experience Templates item types as part of the export package.
• The Publish Layers operation now supports setting preferred time zone information for published layers. As well, a new parameter, applySvcConfigChanges, has been added to the operation. The applySvcConfigChanges operation specifies whether changes to the template service configuration should be applied to previously published layers.

Updated operations and resources

• /relatedItems— This operation has been updated to include pagination.
• /report— This operation has been updated to include a new reportSubType called itemUsages, and two new timeDuration values, quarterly and yearly.

Updated operations and resources

• A new property, lastViewed, has been added to the item response. This property is returned in the item JSON response when an item is accessed after the update. The default value is blank. The lastViewed value is updated each time the item details page is opened in the front-end UI, when the item data endpoint is accessed in the API, or when the feature service owned by the item is accessed.
• The query string has been removed from search operations (search, user search, group search, and group content search).

New item types

• Deep Learning Studio Project—The Deep Learning Studio Project item type is a project that includes references to input imagery, hosted feature services that contain training samples collected by users, model training input and output information, and applicable inferencing information, which can be used for training a model for specific, user-defined inference purposes.
• Esri Classifier Definition—The Esri Classifier Definition item type is a JSON file that contains attribute information, statistics, and other information for classification and regression models for raster analysis and training tools.
• Insights Data Engineering Model—The Insights Data Engineering Model is used to store the model created in ArcGIS Insights.
• Insights Data Engineering Workbook—An Insights Data Engineering Workbook stores the data engineering model and its associated data together in one place.

New privileges

• portal:user:reassignItems—Assigning a user this privilege grants them the ability to reassign only their content to another member with the privilege to receive content.
• portal:user:receiveItems—Assigning a user this privilege grants them the ability to receive content that is reassigned to them by another member with the privilege to reassign content.

New operations and resources

• canReassignItems—This operation checks whether the items owned by one user can be successfully reassigned to a specified user before performing the reassignItems operation.
• reassignItems—This operation reassigns items owned by one user to another user in the organization.

Update operations and resources

• Support for administrative reports (ExecuteReport webhooks) was added for organization webhooks.
• Bulgarian has been added as a supported localization language for ArcGIS Enterprise. The language information for Bulgarian has been added to the languages resource.
• The export operation now supports including the StoryMap and StoryMap Theme item types in an export package.

Portal configuration file updates

Starting at ArcGIS Enterprise 11.0, the update operation can be used to customize advanced portal options, such as configuring a disconnected deployment, using the portalConfigProperties parameter. Previously, administrators who needed to customize their portal's behavior would make updates to the editable version of the portal's configuration file (config.js). Though administrators no longer need to update the configuration file, it is recommended that they make a backup of it prior to upgrading to an 11.0 deployment to preserve the portal's previous customization and settings as a reference. After the upgrade, the properties defined in the configuration file will need to be manually applied to the portalConfigProperties parameter, as the Sharing API will not automatically harvest and apply the information in the file.

New privileges

• portal:admin:updateMemberCategorySchema—Assigning a user this privilege grants them the ability to configure organization member category schema.

New operations and resources

• assignMemberCategorySchema—Allows organization administrators and custom roles with the portal:admin:updateUsers privilege the ability to categorize their organization members.
• deleteMemberCategorySchema—Allows organization administrators and custom roles with the portal:admin:updateUsers privilege the ability to remove the member category schema set for the organization.

New item types

• Experience Builder Widget—A custom widget that can be used in ArcGIS Experience Builder in an organization. This item type can only be created and owned by organization administrators. This item is not allowed to be shared outside the organization. This item type is only applicable to ArcGIS Online organizations.
• Experience Builder Widget Package—A custom widget that is configurable and shareable functional unit for use in ArcGIS Experience Builder. This item type can only be created and owned by organization administrators. This item is also not allowed to be shared outside the organization. This item type is only applicable to ArcGIS Online organizations.
• Hub Project—A premium capability in ArcGIS Hub to enable customers to set goals, define a timeline, and report progress through dynamic indicators. This item type is only applicable to ArcGIS Online organizations.

Updated operations and resources

• PKCE support—Starting from the March 2022 ArcGIS Online release, support for Proof Key for Code Exchange (PKCE) has been added to the authorize and token operations. PKCE is an extension to authorization grant flow and is recommended for all applications, including the web applications.

New topic

• Metadata reference—A new reference topic explaining how a user can enable or disable metadata for an organization, add or update item metadata, and view metadata in different formats and outputs.

Updates operations and resources

• Support for a new webhook type, ExecuteReport, was added to the createTask and update operations. This type, added as an accepted value to the type parameter, gives users the ability to schedule, edit, disable, enable, and delete scheduled administrative reports. Using createTask for administrative reports is different from using it for ArcGIS Notebooks and Insights because administrative reports do not require an itemID.

New limitations

• generate and analyze—The maximum upload size for shapefiles is now 2 MB and 10 MB for all other supported file types.

New relationship types

• Mission2Item—Models the association of ArcGIS Mission to the items created as part of a mission.

New item types

• Insights Workbook Package—This item type is an exportable file containing all aspects of an Insights workbook. All pages, data, models, and themes are included in the package exactly as they appear in the original workbook. Support for this item type was first introduced for ArcGIS Online during the June 2021 release (see ArcGIS Online—June 2021 below).
• Apache Parquet—This item type is a highly compressed column-oriented tabular, nonspatial storage and sharing format. Support for this item type was first introduced for ArcGIS Online during the June 2021 release (see ArcGIS OnlineJune 2021 below).

Updated operations and resources

• Changes have been made to the following operations and resources to support creating a webhook for a notebook that executes when triggered:
  • Webhooks
  • Create Webhooks
  • List Specific Webhook
  • Update Webhook
• Two new webhook triggers have been added to Create Webhooks: /groups/<groupID>/itemShare and /groups/<groupID>/itemUnshare.

New item types

• GeoBIM Application—This item type is the end-user ArcGIS Web Application that allows various stakeholders in the life cycle of engineered assets (infrastructure, buildings) to engage with diverse views of these assets including GIS, BIM, project management, and schedule information. This item type is only applicable to ArcGIS Online organizations.
• GeoBIM Project—This item type is a JSON file containing a complete ArcGIS Experience Builder application with additional properties specific to ArcGIS GeoBIM products. This item type is only applicable to ArcGIS Online organizations.

Limitations

• Considerations and limitations—Maximum number of external organizations allowed per group is now 250.

New item types

• Insights Workbook Package—This item type is an exportable file containing all aspects of an Insights workbook. All pages, data, models, and themes are included in the package exactly as they appear in the original workbook. This item type is only applicable to ArcGIS Online organizations.
• Apache Parquet—This item type is a highly compressed column-oriented tabular, nonspatial storage and sharing format. This item type is only applicable to ArcGIS Online organizations.
• OGCFeatureServer—This is an OGC feature service. This item type is only applicable to ArcGIS Online organizations.

New privileges

The following user privileges have been added to the Privileges topic:

• portal:user:invitePartneredCollaborationMembers—Grants the ability to invite members from partnered collaboration organizations to groups.
• portal:user:addExternalMembersToGroup—Grants the ability to create groups that allow members from other organizations, as well as to invite external members to groups.

Pagination change to user content

• The user content resource supports optional num and start parameters. Previously, if neither the num nor start parameter were included, the resource would return all items in a folder. With the June 2021 ArcGIS Online update, if the num or start parameters are not provided, the results are paginated and will display 1,000 items per page by default. This value cannot be modified.

New operation

• Copy item—The copy item operation (POST requests only) creates a new item that is a copy of the original item on the server side. Support for this operation was first introduced for ArcGIS Online during the September 2020 release.

New item types

• StoryMap Theme—A set of fonts, colors, block styles, and other design elements that define the appearance of a story. Support for this item type was first introduced for ArcGIS Online during the September 2020 release.
• Web AppBuilder Widget—A custom widget (available via marketplace) is a configurable and shareable functional unit for use in ArcGIS Web AppBuilder. It will allow administrators to enable the use of a custom widget in the ArcGIS Web AppBuilder UI so an organization can leverage the ArcGIS Online or ArcGIS Enterprise platform to host their applications. Support for this operation was first introduced for ArcGIS Online during the December 2020 release.
• Earth Configuration—This item is used to create custom settings in ArcGIS Earth. It can be uploaded through the Add item dialog box in My Content and shared in the organization with qualified accounts and user types. Support for this item type was first introduced for ArcGIS Online during the April 2021 release.

New relationship types

• Solution2Item—Models the association of Solution to the items created as part of the Solution. Support for this relationship type was first introduced for ArcGIS Online during the December 2020 release.
• Theme2Story—Models the association between a StoryMap Theme and the stories that use that theme. The relationship can be queried in either direction. Support for this relationship type was first introduced for ArcGIS Online during the September 2020 release.
• WebStyle2DesktopStyle—Models the association of Web Style to Desktop Style that is used to publish the Web Style. Support for this relationship type was first introduced for ArcGIS Online during the September 2020 release.

Updated operations and resources

• The Import Group Content operation has been updated to include two new parameters: folderID and folderOwnerUsername.
• A new property, bidirectionalSyncCapable, has been added as a response property for the Collaboration Workspaces and Collaboration Workspace resources. This value will be returned as true when a new workspace is created at 10.9. If a workspace has been upgraded to 10.9, this property will be false.
• The Update Portal Group Link operation has been updated to include a new parameter: enableFeatureServiceBidirectionalSync.
• Scheduled tasks are now supported for ArcGIS Workflow Manager and scene services.
• The Publish operation now supports publishing map, image, and vector tile layers. Prior to 10.9, the only supported services for this operation were scene services.
• The Add Resource operation now supports the following file formats:
  • glb
  • stylx
  • pdf
  • wav
  • webp
  • webm

Table of contents

The sharing API table of contents has been reorganized to make it easier to find information. Topics are now organized by the structure of the URL of the resource or operation.

For example, the previous section, Content - Group Content, has been updated to reflect the URL structure of that resource and its child endpoints as /content/groups/[groupID]. The topics have been sorted by their URL structure to better demonstrate the relationship between endpoints. For example, under the .../[username]/items/[itemID]/proxies section, the topics Delete and Update have been renamed to /[proxyID]/delete and /[proxyID]/update so that the relationship between the topics and its related endpoints can be easily determined.

In addition, endpoints that share the same name (for example, endpoint /register) have been given additional contextual phrases to differentiate among them. For example, the topic for registering a server is called /register (server) with the (server) context appended to differentiate it from other register endpoints, such as registering IDP /register (idp) and registering federation /register (federation).

Also, a new conceptual hierarchy page has been added to group endpoints together based on the conceptual relationship between endpoints.

Topics

Topic information has also been improved. Each topic has had its title updated to reflect both the true endpoint name and its user-friendly alias. For example, the topic name for "Check Service Name" has been updated to "/isServiceNameAvailable: Check Service Name". Also, the URL section, located at the top of each endpoint topic, has been updated to show the full path. Additionally, the example usage sections have been moved to the top of each topic next to the URL section.

New item types

• Earth Configuration—This item is used to create custom settings in ArcGIS Earth. It can be uploaded through the Add Item dialog box in My Content and shared in the organization with qualified accounts and user types. This item type is only applicable to ArcGIS Online organizations.

New operations and resources

• Reports—The Reports operation generates the reports of the overall usage of the organizations. Reports define organization usage metrics in one place for the day, week, or month. Administrators can monitor who is using which services and how many credits and how much storage they are consuming within a specific time period.

New item types

• Web AppBuilder Widget—A custom widget (available from ArcGIS Marketplace) is a configurable and shareable functional unit for use in ArcGIS Web AppBuilder. It allows administrators to enable the use of a custom widget in the ArcGIS Web AppBuilder UI so an organization can use ArcGIS Online to host its applications. This item type is only applicable to ArcGIS Online organizations.

New relationship types

• APIKey2Item—Models the association of API keys to an item on the ArcGIS for Developers item pages. This relationship type is only applicable to ArcGIS Online organizations.
• Solution2Item—Models the association of Solution to the items created as part of the solution. This relationship type is only applicable to ArcGIS Online organizations.

Update operations and resources

• Publish item has been updated to include the new CSV publish parameter candidateFieldsType.

New operation

• Copy item—The copy item operation creates a new item that is a copy of the original item on the server side.

New item types

• StoryMap Theme—A set of fonts, colors, block styles, and other design elements that define the appearance of a story. This item is only applicable to ArcGIS Online organizations.
• Hub Event—A central premium capability in ArcGIS Hub Premium, enabling customers and their trusted community members to create, edit, and manage in-person and online events. This item is only applicable to ArcGIS Online organizations.

New relationship types

• Theme2Story—Models the association between a StoryMap Theme and the stories that use that theme. The relationship can be queried in either direction. This item is only applicable to ArcGIS Online organizations.
• WebStyle2DesktopStyle—Models the association of Web Style to Desktop Style that is used to publish the Web Style. This item is only applicable to ArcGIS Online organizations.

Updated operations and resources

• Common parameters, Group Search, Search reference, Group, and Considerations and limitations are updated to include typeKeywords for a group.
• Portal Self—Updated Geocode helper service properties to show placeholder in the syntax and example.
• Add Resources and Update Resources—Added information related to maximum limits in size and number of the file resources per item.

Version Management Privilege

The version management privilege (features:user:manageVersions) has been added to the selection of User privileges that can be assigned to organization members through custom roles. Users assigned this privilege will have the ability to manage version locks as well as view, alter, delete, edit, reconcile, and post to all branch versions accessed through ArcGIS Server feature layers.

Help Base

Administrators, with the appropriate privileges, will be able to update the help source option for your organization. The helpBase property can be updated to determine whether the help is derived from a locally installed source or via the web help (https://enterprise.arcgis.com) when internet access is available. By default, helpBase is set to use the local, installed source. For more information on this property and how to update it, see Update portal.

Schedule Notebooks

Administrators and notebook authors with the Schedule Notebook privilege can now schedule ArcGIS Notebooks to run remotely at a scheduled time, either once or on a recurring basis through the Sharing API. The following operations and resources have been added to help in task creation and management:

• All Scheduled Tasks (Organization)—This resource returns a list of all scheduled tasks that exist within your organization.
• All User Scheduled Tasks—This resource returns a list of all scheduled tasks owned by a user.
• Get Specific Task—This resource returns information on a specific scheduled task, such as it's title, additional task parameters, and schedule.
• Create New Scheduled Task—This operation creates a new scheduled task for either ArcGIS Notebooks or ArcGIS Insights workbook.
• Delete Task—This operation deletes a previously configured task, preventing any additional runs and removing any associated resource files associated with the item.
• Disable Task—This operation disables a task, making it inactive and preventing any additional runs from being performed.
• Edit Existing Task—This operation edits a current task. Changes made to the task will go into effect during the next scheduled run.
• Enable Task—This operation reenables a task that had previously been disabled, allowing for the task to continue performing it's scheduled runs.
• Runs for Task—This resource returns a list of all the runs that have been executed for a specific task.
• Delete Run—This operation deletes a run, removing any resource files associated with the item.
• Edit Run—This operation updates a run, allowing for elements such as the run status to be updated.

New item types

• Web Experience Template—An experience template item that contains a pattern or blueprint of Web Experiences created from ArcGIS Experience Builder.
• Hub Initiative Template—A package of multiple Solutions oriented at a specific project or goal. This item type is only applicable to ArcGIS Online organizations
• Mission—A collection of portal items that provides a focused user experience when working with ArcGIS Mission.
• Export Package—A package tat allows administrators or group owners to export a group, and its content, into a downloadable package.

New operations and resources

• Export Group Content allows administrators to extract all supported items, or a set of supported items, from a group and export them into an export package (.epk) that can be uploaded and have it's contents imported and published into another ArcGIS Enterprise organization's group.
• Import Group Content allows administrators to import items from an export package, which results from the Export operation, and adds all supported content items from the package to the selected group. When these items are added, their item IDs are maintained and associated URLs from the originating portal are swizzled to ensure they function in the new organization.
• Describe Data Store allows for initial and incremental discovery of a data store's content. The result of the operation is a list of content available from either the root folder of the data store or in folders that are available off of the root.
• Publish Datasets publishes services, by reference, from specified datasets in a data store. Currently, this operation only supports publishing scene services.

Updated operations and resources

• Servers and Server now support WorkflowManager as a server function value.
• Add Item and Publish Item have been updated to include the itemIdToCreate parameter.
• Publish Layers now includes the ability to set the syncItemInfo parameter.
• Users will now be able to set apps and add-on licenses for new member defaults through the Set User Default Settings operation.

Licensing updates

User type extensions provide members of your organization access to Utility Network and Parcel Fabric functionalities. The GIS Professional Standard and GIS Professional Advanced user types include both the Utility Network and Parcel Fabric extensions. The Parcel Fabric extension can be included as an add-on for user types with at least the capability to view and edit data such as Editor, Field Worker, Creator and GIS Professional Basic user types. The Utility Network extension is compatible with all user types. You can view a user's user type, user type extensions, and add-on applications through the User License Type and Provisioned Listings resources.

New member defaults

In June 2019 for ArcGIS Online, and starting at ArcGIS Enterprise 10.8, organizations now have the ability to set new member defaults for users who create their own built-in accounts, are added to the organization by an administrator, or are added through automatic account creation. Previously, new member defaults were set through the Portal Admin API or from the Roles tab in the Organization Settings of the portal. Now, new member defaults are configurable only from the Set User Default Settings operation or from the New Member Defaults tab in the Organization Settings of the portal.

New operations and resources

• Delete Service Proxy Config remove Viewer credentials saved on the collaboration workspace. These credentials will be removed from all services after the next synchronization.
• Organization Settings returns the portal's current configuration as it would be seen by the user.
• Set User Default Settings allows administrators to configure and edit their new member defaults.
• Update Organization Settings allows administrators to set and configure access notices and information banners.
• Update Service Proxy Config adds Viewer credentials to services copied by reference in distributed collaborations. This allows recipients to access the shared content without requiring credentials from the originating portal. Services shared before the credentials were set will be updated during the next synchronization to include this information.
• User Default Settings returns the organization's stored new member default settings.

New operations and resources

Beginning with 10.7.1, you can publish layers in bulk from a data store item in the Enterprise portal. The following operations allow you to manage layers published from your data store:

• Add to Server—Registers a data store to ArcGIS Server. This operation also allows you to bind your data store to an additional federated server or servers.
• All Datasets—Provides access to bulk publishing operations.
• Delete Layers—Deletes all layers published from the data store.
• Get Layers—Returns a list of layers published in bulk from a data store.
• Get Servers for Data Store—Returns a list of servers to which a given data store has been registered.
• Publish Layers—Publishes or syncs the datasets from a data store on ArcGIS Server, resulting in at least one layer per dataset.
• Refresh Server—Propagates changes from your data store registration information to ArcGIS Server.
• Remove from Server—Unregisters a specified data store from ArcGIS Server.
• Validate Datastore—Ensures that ArcGIS Server can connect and use the datasets stored in a given data store.

New operations and resources

At 10.7, ArcGIS Enterprise portals support webhooks. A webhook is a mechanism that allows an app to provide other apps with event-driven information. As a portal administrator, you can create, manage, and configure webhooks using the following operations:

• Activate Webhook—Restarts a deactivated webhook.
• Create Webhook—Allows portal administrators to create a webhook.
• Deactivate Webhook—Pauses a specified webhook.
• Delete Webhook—Deletes a specified webhook.
• List a Specific Webhook—Displays information for a specified webhook and provides access to various operations.
• Notification Status—Displays information regarding trigger events associated with a specified webhook.
• Update Settings—Adjusts several advanced parameters that apply to your webhooks.
• Update Webhook—Allows administrators to update previously configured webhook parameters.
• Webhook Settings—Displays advanced parameters that configure webhook connection behavior.

Distributed collaboration now supports the Pause and Resume operations. The Pause operation suspends a scheduled job for synchronized items in a collaboration workspace, and Resume restarts a scheduled job for synchronized items in a collaboration workspace.

Licensing updates

User types replace member levels as a flexible way to license capabilities and apps in ArcGIS Enterprise and ArcGIS Online. User types allow organizations to allocate identity, privileges, and apps to align with the needs of members. You can view a user's user type, as well as their add-on apps and app bundles, through the User License Type, Provisioned Listings, and User App Bundles resources.

Updated operations and resources

• The copyFeatureServiceData parameter in the /updatePortalGroupLink operation now supports hosted feature layer views.