Update Product

productName

(Required)

The name of the product.

description

(Optional)

The new description for the product.

enabled

(Optional)

Enables or disables the product. If a product is disabled, the generateProduct operation returns an error for that product.

Values: true | false

sheetIDField

(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.

raster

(Optional)

The path to a raster on disk (server path) or the URL of an image service.

productVersions

(Optional)

Indicates the product version. Use the following syntax to add or update the version:

1
2
3
4
5
6
7
8
9
10
{
"operation": "<add | update>",
"versions": [
	{
		"name":"<name of version>",
		"template": "<name of template>"
	},
	...
]
}

Use the following syntax to remove the version:

1
2
3
4
5
6
7
8
{
"operation": "remove",
"versions": [
	"<name of version 1>",
	"<name of version 2>",
	...
]
}

Starting at ArcGIS Enterprise 11.2, additional properties can be applied:

• extractionDatabase—Overwrites the extractionDatabase value at the map product level.
• operationOverrides—Overwrites the parameters key-value pairs on an existing operation with the provided ID. The ID must match an existing operation.
• excludedOperations—The operations identified by the IDs provided are not run for this map product version.

The following example uses operationOverrides to identify an operation and override its parameter key-value pairs with the ones provided and excludedOperations to identify operations that will be excluded:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
"productVersions": [
{
	"name": "TRD_4_5",
	"template": "MTM50_TRD45_Layout.pagx"
	"extractionDatabase": "",
	"operationOverrides": [
	{
		"id": "26C62049-A11F-4D5B-BC80-00CF3597555C",
		"parameters": [
		{
			"name": "input_map",
			"value": "Map"
		},
		]
	},
	]
	"excludedOperations": [
	"45B62049-A11F-4D5B-BC80-00CF3597555C",
	...
	]
}
]

ancillaryLayers

(Optional)

Indicates the product layers. Use the following format to add or update layers:

1
2
3
4
5
6
7
8
9
10
11
12
{
	"operation" : "<add | update>",
	"layers": [
	{
		"layer": "<url of layer>",
		"featureClass": "<name of feature class to extract to>",
		"map": "<name of map layer will be inserted into>",
		"layerIndex": "<insertion index of layer>"
	},
	...
	]
}

Use the following format to remove the layer:

1
2
3
4
5
6
7
8
9
{
	"operation" : "remove",
	"layers": [
	{
		"layer": "<url of layer>"
	},
	...
	]
}