/export: Export Group Content

Example usage

POST /webadaptor/sharing/rest/community/groups/3ca5299f4b3d423ebd66e9f72f9ef638/export HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryYhbOXGMMNAbGl1gv

------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="itemIdList"


------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="async"

true
------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundaryYhbOXGMMNAbGl1gv--

Description

Note:

This operation is only supported in ArcGIS Enterprise.

This operation allows you to extract all supported items, or set of supported items, from a group into an export package (.epk) that can be uploaded and published into a separate ArcGIS Enterprise organization.

For example, say you wish to move content from a group in a development environment to a staging environment to a production environment. By calling this operation and downloading the resulting .epk, content can be uploaded to the staging portal and then, using the import operation, be published to a group in the staging environment. This process can be replicated to move content from the staging environment to the production environment.

In addition, the export operation can be used to extract content so that it can be moved between disconnected environments, as well as work for workflows where select content needs to be backed up and restored or archived.

Supported items

The following lists of items are supported by this operation:

ArcGIS Enterprise item types

• ArcPad Package
• CAD Drawing
• CityEngine Web Scene
• Code Attachment
• CSV Collection
• CSV
• Deep Learning Package
• Desktop Application Template
• Hosted Feature Services
  Note:

  Only hosted feature services are supported. Spatiotemporal-based hosted feature services, proxied feature services, and hosted feature service views are not supported.

• File Geodatabase
• GeoJson
• GeoPackage
• Geoprocessing Sample
• Image Collection
• Image
• iWork Keynote
• iWork Numbers
• iWork Pages
• KML Collection
• KML
• Map Template
• Microsoft Excel
• Microsoft Powerpoint
• Microsoft Word
• PDF
• Shapefile
• SQLite Geodatabase
• Visio Document
• Web Map
• Web Mapping Application
• Web Scene

Note:

Hosted feature services will be exported with their associated data. References to layers within web map, web scene, and web mapping applications will be updated to reflect the ArcGIS Enterprise organization where they have been imported.

Esri configurable app template

• Attachment Viewer
• Story Map Cascade
• Compare
• Crowdsource Polling
• Directions
• Edit
• GeoForm
• Image Mask
• Imagery Viewer
• Image Visit
• Impact Summary
• Informational Lookup
• Filter
• Interactive Legend
• Local Perspective
• Story Map Journal
• Story Map Series
• Map Tools
• Story Map Tour
• Media Map
• Minimalist
• Nearby
• Classic Viewer
• Elevation Profile
• Public Information
• Simple Map Viewer
• Story Map Basic
• Story Map Swipe and Spyglass
• Map Styler
• Summary Viewer
• Time Aware
• Basic Viewer
• Zone Look Up

Note:

Group-based ESRI configurable app templates are not supported.

Additional considerations

Only items contained in the group will be exported. If an item has any dependencies, such as a web map with a dependency on the operation service items contained in the map, both the item and its dependency must be shared with the group. If the dependent items are not included in the export package, and they don't already exist in the receiving portal, any calls made to the dependent items will fail.

An .epk cannot exceed 5 GB, and any one item within the package cannot exceed 1 GB. The system will check to ensure that the portal content store has a minimum of 10 GB of disk space available before attempting to either export or import group content.

Request parameters

Example

Below is a sample POST request for export that submits the job asynchronously:

POST /webadaptor/sharing/rest/community/groups/3ca5299f4b3d423ebd66e9f72f9ef638/export HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryYhbOXGMMNAbGl1gv

------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="itemIdList"


------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="async"

true
------WebKitFormBoundaryYhbOXGMMNAbGl1gv
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundaryYhbOXGMMNAbGl1gv--

Accessing results

If async is false, and f is set to html, the response is an octet stream a client uses for downloading the EPK package.

If f is set to json, the octet stream response cannot be returned on a successful export and an HTTP Status 400 error is returned.

If there are no items to export, a JSON response resembling the one below will be returned:

{
  "itemsExported": [],
  "itemsSkipped": [],
  "itemsFailedExport": []
}

If async is true, a jobID and key is returned:

{
  "jobId": "0c3d9012681845e4aa3ca3e5f9aae8fa",
  "key": "DjUElZ3XQjbJ2S/g7D5644SCEaTfDniHo5XQYYVWGjY="
}

The job ID can be used to check the job's results and status using the following URL format:

https://machine.domain.com/webadaptor/sharing/rest/portals/<orgID>/jobs/<jobID>

If successful, a success response will be returned containing an itemID and other job information. To download the export package, append the itemID from the response using the following URL format:

https://machine.domain.com/webadaptor/portal/sharing/rest/content/items/<itemID>/data

JSON Response example

{
  "id": "fadcd0a7b58c422ebcf0847aad76885d",
  "definition": {
    "type": "export",
    "operationId": "cm009fe62d885748a4a19050844e1f8c20",
    "groupId": "3ca5299f4b3d423ebd66e9f72f9ef638",
    "groupTitle": "myGroup"
  },
  "status": "succeeded",
  "created": 1586901221029,
  "modified": 1586901241914,
  "messages": [
    "Starting export of items in group 'myGroup' with id '142b3c7995ec447288f15db4d301fe53'.",
    "{\"itemsExported\":[{\"itemId\":\"7c1124277b2f4847ae668de6c5135e6d\"},{\"itemId\":\"ac34a93042bb468faf17e933609ade79\"},{\"itemId\":\"f672235d835d46008b4d68145238ab19\"}],\"itemsSkipped\":[],\"itemsFailedExport\":[]}",
    "Added Export Package item with id '63a078b6aef54f1c91102fd9d4aa47f5' for group with id '142b3c7995ec447288f15db4d301fe53'."
  ],
  "result": {
    "itemId": "63a078b6aef54f1c91102fd9d4aa47f5",
    "created": 1586901241910
  }
}