Products

URL:: https://<root>/<serviceName>/TopographicProductionServer/jobs/products
Methods:: GET
Child Resources:: Product
Required Capability:: Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:: 10.9

Description

The products operation retrieves the products that the Topographic Production Service 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`.
`definitionType` (Optional)	The string value to filter the list of configured products by. This must be an exact match to the `definitionType` value in the product definition. Empty or misspelled strings will return all of the products.

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

definitionType

(Optional)

The string value to filter the list of configured products by. This must be an exact match to the definitionType value in the product definition. Empty or misspelled strings will return all of the products.

Example usage

Review the map product definitions currently supported by the Topographic Production Service by using the products REST resource.

Request URL and parameters:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/products

Use dark colors for code blocksCopy
f=json

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
{
 "products": [
  {
   "name": <name of the product>,
   "description": <description of the map product>,
   "type": <type of map product>,
   "definitionType": <type of definition>,
   "gridType": <type of grid>,
   "sheetIDField": <ID of the sheet>,
   "productVersions": [
    {
     "name": <name of the product version>,
     "template": <name of the 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",
   "type": "MTM",
   "definitionType": "MapDefinition",
   "gridType": "TM50",
   "sheetIDField": "NRN",
   "productVersions": [
    {
     "name": "TRD_4_5",
     "template": "MTM50_Layout.pagx"
    }
   ],
   "enabled": "True",
   "raster": "https://organization.example.com/<context>/rest/services/SampleRaster/ImageServer",
   "ancillaryLayers": [
   ],
   "lastModified": "2020-08-11T20:26:58Z"
  },
  {
   "name": "MTM100",
   "description": "MTM100 Map Product",
   "type": "MTM",
   "definitionType": "MapDefinition",
   "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": [
  ]
 }
}