Products

URL:: https://<root>/<serviceName>/TopographicProductionServer/jobs/products
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 products operation retrieves the products that a Topographic Production Service resource supports.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	Specifies the response format. Values: `html` \| `json` \| `pjson`
`includeDef` (Optional)	Specifies whether the full `json` definition of the map product is included. Values: `true` \| `false`
`includeDataTypes` (Optional)	Specifies whether the data type of the productDefinition parameter's `operations` property is included in the JSON response. Values: `true` \| `false` Note This parameter is available starting at ArcGIS Enterprise 11.2 and can only be used when the `includeDef` parameter value is set to `true`.

f

(Required)

Specifies the response format.

Values: html | json | pjson

includeDef

(Optional)

Specifies whether the full json definition of the map product is included.

Values: true | false

includeDataTypes

(Optional)

Specifies whether the data type of the productDefinition parameter's operations property is included in the JSON response.

Values: true | false

Example usage

The following URL queries the REST resource of the products:

Use dark colors for code blocksCopy
https://machine.domain.com/server/rest/services/SampleService/TopographicProductionServer/products?f=json

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
{
 "products": [
  {
   "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": [
   ],
   "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:

Use dark colors for code blocksCopy
{
 "products": [
  {
   "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": [
   ],
   "lastModified": "2020-08-11T20:26:58Z"
  },
  {
   "name": "MTM100",
   "description": "MTM100 Map Product",
   "gridType": "TM100",
   "sheetIDField": "NRN",
   "productVersions": [
    {
     "name": "TRD_4_5",
     "template": "MTM100_Layout.pagx"
    }
   ],
   "enabled": "True",
   "raster": "",
   "ancillaryLayers": [
   ],
   "lastModified": "2020-07-31T00:36:23Z"
  }
 ]
}

JSON Response example

The following is an example of an error response:

Use dark colors for code blocksCopy
{
 "error": {
  "code": -2147211775,
  "message": "Product name not found.",
  "details": [
  ]
 }
}