- URL:
- https://<root>/<serviceName>/TopographicProductionServer/updateProduct
- 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 update
operation updates properties of a map product definition.
Request parameters
Parameter | Details |
---|---|
(Required) |
The name of the product. |
(Optional) | The new description for the product. |
(Optional) | Enables or disables the product. If a product is disabled, the Values: |
(Optional) | Updates the sheet ID field. This is the field name that identifies the area of interest (AOI) for which the map product is generated. It must be a field that exists on the features used to define the AOI. |
(Optional) |
The path to a raster on disk (server path) or the URL of an image service. |
(Optional) | Indicates the product version. Use the following syntax to add or update the version:
Use the following syntax to remove the version:
Starting at ArcGIS Enterprise 11.2, additional properties can be applied:
The following example uses
|
(Optional) | Indicates the product layers. Use the following format to add or update layers:
Use the following format to remove the layer:
|
Example usage
The following URL queries the products in the Topographic Production Service resource by product
and updates it:
Request URL and parameters:
https://machine.domain.com/server/rest/services/MTM50/TopographicProductionServer/updateProduct
productName=MTM50
description=example
enabled=true
sheetIDField=NRN
raster=https://servermachine.domain.com/server/rest/service/DEM/ImageServer
productVersions=
{
"operation": "update",
"versions": [
{
"name": "TRD_4_5",
"template": "MTM50_TRD45_Layout.pagx"
},
...
]
}
ancillaryLayers=
{
"operation": "update",
"layers": [
{
"layer": "https://servermachine.domain.com/server/rest/services/SampleWorldCities/MapServer/1",
"featureClass": "",
"map": "BaseMap",
"layerIndex": "0"
},
...
]
}
f=html
JSON Response syntax
The following is the syntax of a response:
{
"productName": <productName>,
"success": <true | false>
}
JSON Response example
The following is an example response when a product's properties were successfully updated:
{
"productName": "MTM50",
"success": true
}
The following is an example of error response when the product fails to update:
{
"error": {
"code": -2147211775,
"message": "Product name not found.",
"details": [
]
}
}