- URL:
- https://<root>/<serviceName>/TopographicProductionServer/jobs/products/<productName>
- 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 product
operation retrieves a single map product definition from the products that the Topographic Production Service supports.
Request parameters
Parameter | Details |
---|---|
(Required) |
Specifies the response format. Values: |
(Optional) |
Specifies whether the full Values: |
Example usage
Review the map product definition for an MTM50 map product by appending MT
to the products
REST resource URL.
Request URL and parameters:
https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/products/MTM50
f=json
JSON Response syntax
The following is the syntax of a response:
{
"name": <name of product>,
"description": <description of map product>,
"gridType": <type of grid>,
"sheetIDField": <ID of the sheet>,
"productVersions": [
{
"name": <name of the product version>,
"template": <name of template>
}
],
"enabled": true | false,
"raster": <URL of raster layer>,
"ancillaryLayers": [
{
"layer": <URL of the ancillary layer>,
"featureClass": <name of the feature class to extract to>,
"map": <name of the map the layer should be added to>,
"layerIndex": <index where the layer should be inserted in the map>
},
{
"layer": <URL of the ancillary layer>,
"featureClass": <name of the feature class to extract to>,
"map": <name of the map the layer should be added to>,
"layerIndex": <index where the layer should be inserted in the map>
}
],
"lastModified": <date and UTC time of last modification in ISO 8601 format YYYY-MM-DDThh:mm:ssZ>
}
JSON Response example
The following is an example of a response:
{
"name": "MTM50",
"description": "MTM50 Map Product",
"gridType": "TM50",
"sheetIDField": "NRN",
"productVersions": [
{
"name": "TRD_4_5",
"template": "MTM50_Layout.pagx"
}
],
"enabled": "True",
"raster": "https://machine.domain.com/server/rest/services/SampleRaster/ImageServer/",
"ancillaryLayers": [
{
"layer": "https://machine.domain.com/server/rest/services/Auxiliary/MapServer/0",
"featureClass": "AuxPoints",
"map": "BaseMap",
"layerIndex": 5
},
{
"layer": "https://machine.domain.com/server/rest/services/Auxiliary/MapServer/1",
"featureClass": "AuxLines",
"map": "BaseMap",
"layerIndex": 6
},
{
"layer": "https://machine.domain.com/server/rest/services/Auxiliary/MapServer/2",
"featureClass": "AuxPolygons",
"map": "ElevationGuide",
"layerIndex": 0
}
],
"lastModified": "2020-08-11T20:26:58Z"
}
JSON Response example
The following is an example of an error response:
{
"error": {
"code": -2147211775,
"message": "Product name not found.",
"details": [
]
}
}