- URL:
- https://<root>/<serviceName>/TopographicProductionServer/generateProduct
- Methods:
GET
- Required Capability:
- Requires an ArcGIS GIS Server Advanced license and a Production Mapping or Defense Mapping server extension license
- Version Introduced:
- 10.9
Description
The generate
operation automates the process of producing a layout or map based on an existing map product definition.
Request parameters
Parameter | Details |
---|---|
(Required) |
The name of the product. This parameter's value must match one of the product names from |
(Required) | A string value of the product version name to generate.
The product version name must match a Alternatively, a JSON object with the following properties can be included starting at ArcGIS Enterprise 11.2.
The following example shows how to use
|
(Required) | The URL of the layerused to define the product's area of interest. |
(Required) | The object ID of the area of interest feature in the |
(Optional) | A featureSet used to define the product's area of interest (AOI). Only one feature is allowed.
|
(Optional) | An array of layer names to exclude from the product. Syntax:
|
(Optional) | An array of layer URLs to include in the final product. Syntax:
Ancillary layers are added as feature service layers of the final product and don't extract data to the local geodatabase. |
(Required) | A string value that specifies the output type. Supported values include
|
(Optional) | The name to use for the exported file. If no name is provided, the sheet identifier value is used. |
(Optional) | The predefined settings for a PDF or TIFF output type. Allowed inputs can either be the name of a preset file included with the ArcGIS Production Mapping, the ArcGIS Defense Mapping Enterprise product files, or a JSON data structure that identifies the output settings in one of the formats detailed below. This parameter was added at Enterprise 11.0. |
outputSettings JSON properties
The following tables contain information about the output
parameter. Each table corresponds to a different output:
PDF properties JSON data structure
Property | Details |
---|---|
| Specifies that the output file type is PDF.
Value: |
| Specifies whether vector content streams are compressed. Set this value to Values: |
| The compression scheme used to compress images and raster data in the output file. Choose from the following:
|
| Specifies whether embeddable fonts should be included in the output file to maintain font consistency across different platforms. Fonts that do not support embedding are not included, regardless of the value set for this property. Values: |
| Specifies whether layers should be included in the output file that can be viewed and managed in supported PDF readers. You can also specify whether attribute data from the features should be included. The range of acceptable values is
|
| Specifies whether geospatial information from the map frames is included in the output file. When geospatial information is included, you can extract x,y coordinate information from the map frames and perform geographic measurement directly on the map frame in supported PDF readers. Values: |
| Specifies the amount of image resampling for raster imagery. This is a ratio that uses the value specified in the The value for this property specifies the ratio used to resample raster data. A value of |
| Specifies the amount of compression applied to images in the output file. Lower values result in smaller file sizes and reduced image quality, while higher values result in larger file sizes and higher image quality. This property is only applied when the |
| Specify a password that must be provided before the output file can be viewed. |
| Specifies whether all content should be output as an image. For maps or layouts containing vector layers with a high density of vertices, this can drastically reduce the size of the output file. Vector-specific properties are not supported if this property's value is Values: |
| Specifies a password that must be provided before edits can be made to the output file or before changes can be made to the permissions on the output file. |
| Specifies whether to include an overprint preview in the output file. When this property is set to Values: |
| If you cannot embed fonts due to licensing or file format restrictions, set this value to Values: |
| Specifies the language of the text in the output layout so a screen reader can interpret it correctly. If multiple languages are included in the output layout, additional post-processing may be required to set the language appropriately for individual text elements. The value should be in IETF BCP 47 format. |
| Specifies the title of the output file. This is displayed when the document is opened. |
| Specifies a brief overview of what the output file is about. |
| Specifies the author of the output file. Some accessibility guidelines suggest that this should be the office or group producing the document, not an individual person. |
| Specifies keywords that help with document searches. |
| Specifies whether the output is a tagged PDF document, which can be read by screen readers or other assistive technologies. Values: |
| Specifies the dots per inch '(dpi)' of the vector data in the output layout.
If the |
| Specifies whether the extent of the output layout is cropped to only include areas with layout elements to help eliminate empty space. Values: |
The following JSON data structure is an example of the properties and values associated with the output
parameter for a PDF output.
{
"formatClass": "PDFFormat",
"properties": {
"DoCompressVectorGraphics": true,
"ImageCompression": 5,
"DoEmbedFonts": false,
"LayersAndAttributes": 1,
"HasGeoRefInfo": true,
"ImageQuality": 5,
"ImageCompressionQuality": 100,
"Password": "test",
"DoFullRasterization": true,
"MasterPassword": "testediting",
"DoSimulateOverprint": false,
"DoConvertCharacterMarkerSymbolsToPolygon": false,
"LanguageCode": "en-US",
"Title": "MyTitle",
"Subject": "MySubject",
"Author": "JohnDoe",
"Keywords": "Test GPL",
"IncludeAccessibilityTags": true,
"Resolution": 200,
"DoClipToGraphicExtent": true
}
}
TIFF properties JSON data structure
Property | Details |
---|---|
| Specifies that the output file format is TIFF.
Value: |
| Specifies how many bits are used to describe color in a pixel.
|
| The compression scheme used to compress images and raster data in the output file.
|
| Specifies if GeoTIFF information is added directly to the TIFF file header. This allows the output file to be used as raster data in ArcGIS Pro or other GIS applications. Values: |
| Specifies the amount of compression applied to images in the output layout. Lower values result in smaller file sizes and reduced image quality, while higher values result in larger file sizes and higher image quality. This property is only applied when the |
| Specifies whether the output layout is on a transparent page instead of a white page. Values: |
| Specifies the map frame on which the GeoTIFF information is based. |
| Specifies the dpi of the output layout file. |
| Specifies whether the extent of the layout is cropped to include only areas with layout elements to help eliminate blank space. Values: |
The following JSON data structure is an example of the properties and values associated with the output
parameter for a TIFF output.
{
"formatClass": "TIFFFormat",
"properties": {
"ColorMode": 3,
"TIFFImageCompression": 3,
"HasGeoTiffTags": true,
"ImageCompressionQuality": 100,
"HasTransparentBackground": false,
"GeoReferenceMapFrameName": "Map Frame",
"Resolution": 400,
"DoClipToGraphicExtent": false
}
}
Response properties
The following details are for the properties of a response:
Property | Details |
---|---|
| The job identifier. |
| The URL to query for the status of a running job. |
Example usage
Generate a map product output using the generate
REST operation.
Request URL and parameters:
https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/generateProduct
productName=MTM50
productVersion=TRD_4_5
aoiLayer=https://machine.domain.com/server/rest/services/AOIService/MapServer/0
aoiFeatureId=120733
layerExclusion=
[
"https://servermachine.domain.com/server/rest/services/SampleWorldCities/MapServer/1",
"https://servermachine.domain.com/server/rest/services/SampleWorldCities/MapServer/2",
"https://servermachine.domain.com/server/rest/services/SampleWorldCities/MapServer/3"
]
outputType=pdf
f=json
JSON Response syntax
The following is the syntax of a response:
{
"jobId": "<jobID>",
"statusURL": "<statusURL>",
"success": <true | false>
}
JSON Response example
The following is an example of a successful response:
{
"jobId": "0AECA2CE-8690-4EEC-935B-CEA8E403765F",
"statusUrl": "https://machine.domain.com/server/rest/services/SampleMapService/MapServer/exts/TopographicProductionServer/jobs/job/0AECA2CE-8690-4EEC-935B-CEA8E403765F",
"success": true
}