Export Tiles

Description

The exportTiles operation, an asynchronous task, allows client applications to download vector tiles from a vector tile layer for offline use. The result of this operation is a vector tile service job. The job response contains a reference to the vector tile service's Result resource, which returns a URL to the resulting vector tile package (.vtpk file).

The vector tile service must be enabled to allow clients to export cache tiles before this operation can be performed. The enable operation can be run in ArcGIS Pro, the ArcGIS Enterprise portal, or the ArcGIS Online home app.

Learn how to enable vector tile layer export

Request parameters

You can provide arguments to the exportTiles operation as defined in the following parameters tables.

NoteNote:

There are additional parameters listed in the HTML interface for the operation, but the parameters below are those that are applicable.

ArcGIS Enterprise users

Parameter

Details

f

The response format. The default response format is html.

Values: html | json

exportExtent

The extent (bounding box) of the vector tile package to be exported. If the extent does not include a spatial reference, the extent values are assumed to be in the spatial reference of the map. The default value is the full extent of the vector tile service.

Syntax: <xmin>, <ymin>, <xmax>, <ymax>

Example 1: -104,35.6,-94.32,41

Example 2: {"xmin" : -109.55, "ymin" : 25.76, "xmax" : -86.39, "ymax" : 49.94,"spatialReference" : {"wkid" : 4326}}

exportBy

The criteria that will be used to select the tile service levels to export. The values should be Level IDs.

Values: LevelID

levels

Specifies the tiled service levels to export. The values should correspond to the Level IDs specified by the exportBy parameter. The values can be comma-separated values or a range of values.

The other parameters are not applicable to vector tile services.

ArcGIS Online users

Parameter

Details

f

The response format. The default response format is html.

Values: html | json

Extent

The extent (bounding box) of the vector tile package to be exported. If the extent does not include a spatial reference, the extent values are assumed to be in the spatial reference of the map. The default value is the full extent of the vector tile service.

Syntax: <xmin>, <ymin>, <xmax>, <ymax>

Example 1: -104,35.6,-94.32,41

Example 2: {"xmin" : -109.55, "ymin" : 25.76, "xmax" : -86.39, "ymax" : 49.94,"spatialReference" : {"wkid" : 4326}}

Levels

Specifies the tiled service levels to export. The values should correspond to the Level IDs of the service. The values can be comma-separated values or a range of values.

Store Output as an Item

Specifies whether the tile package will be available as an item in your ArcGIS Online organization.

Token

Your token for the service. The exportTiles operation always requires a token, even on a service that is shared with everyone.

Response properties

The response returned by the server will be a Job Statistics resource describing the status of the Export Tiles job, including a link to the URL of the vector tile package.

Response Example

Job Statistics

Type : EXPORTTILES

Status : esriJobSucceeded 

Output URL: https://lws-job-results-dev0.s3.amazonaws.com/export/bbb7f2ce369a249c.vtpk?response-content-disposition=Content-Disposition%3A%20attachment%3B%20filename%3Dbbb7f2ce369a249c.vtpk&X-Amz-Security-Token=FQoGZXIvYXdzEEIaDF8%2F5LjDLjZYdFTp7iK3AyIf4yoeK%2FCrNcTS1K4v7OBL%2FXHQRzR4ONW1Y3rtYO3RNQ5TpBygAzA5fw1Nh9poHj4bX5272s9QldilvKmicHku02pNeg5eYMGdDEj6zwIln61CIRrZ9sDfX5nwTbi%2FObaJaDQxnCYvtZGooZ%2BAu5NhDGGVrbjPuTHuuJ5H%2BIyOg5KiUlzAxdv2yOh88PewuxKri2ECyZoIG7S315xd9Ajb4FH23cxoLNELbDPVbZK9AVS4eoYgtvZY8Y68CxLzMr%2BD1y3nhpSR75KCpbWX%2BO%2BPuEBXQSqCIhmXU5dPh%2B0Qwwvy%2F2rIPHAxHh2smgs02bs%2BV3irpJv5%2B4JAHshBLFWfEyRDu6sJ2ebuNZQZsRaUK9qFgtWacA0VKkY77hTaPDEGUqhwAwTzUP6pDQLfKD6WmNxzRmjGWhE%2BCffkznpP5ne4SkCofvMtfPOQj5%2BfrpmP0F9pYpsR4EhlfNAZSc2wEeII1oq%2FYZJsv4NBOmL7Y7JUagTr5X3Wyas4QJuVJ%2BrQBRyYTeB2ZRQDom50A0UCN1qfanrfFmz0hXiJwVBwfK%2BMPiQGaeZqM9YJyorJ40X2nxg8%2ByIo1p%2BY3gU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20181016T172241Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=ASIAYR3L7MZVBQTODGP3%2F20181016%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=3f328f1167ddb5b891c10faa19c75124854500381613de60e4d67ef3f9a64eee

Extent: -2.0037507842788246E7,-2.0037508342787E7,2.0037507842788246E7,2.0037508342787E7

Start Time : 10/16/2018, 10:22:39 AM 
Last Time : 10/16/2018, 10:22:42 AM 

Number of Tasks : 1
Number of Finished Tasks : 1
Number of Processing Tasks : 0
Number of Error Tasks 0
Number of Canceled Tasks : 0
Number of Submitted Tasks : 0

Estimated Number of Tiles : 2
Export Level(s) : [ 0 , 1 ]