Skip to content
URL:
https://<root>/<serviceName>/TopographicProductionServer
Methods:
GET
Operations:
Add Product, Calculate Extent, Generate Product, Remove Product, Update Product
Child Resources:
Jobs, Products, Workflows
Required Capability:
Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:
10.9

Description

The Topographic Production Service resource represents a topographic production server-object extension (SOE). It is the entry point for all functionality related to creating topographic map products in ArcGIS Server. This page provides information about the service and how it enables the topographic production server capabilities on a map service. It includes details about its child resources and operations defined by the SOE.

The service supports the following:

  • addProduct—Adds a definition of a map product to the service that can be used to generate a map.

  • calculateExtent—Calculates a custom area of interest (AOI) for a given product and version.

  • delete—Deletes jobs that have been run or were canceled so that they no longer appear in queries or occupy server space.

  • generateProduct—Automates the process of producing a layout or map based on an existing map product definition.

  • jobs

    • cancel—Cancels a job submitted to the server.

    • job—Tracks the status of a server job. Returns the status, start date, last modified date, and messages for the job.

    • query—Tracks the status of server jobs. Returns the status, start date, last modified date, and messages for a set of jobs.

    • pause—Pauses a job submitted to the server.

    • resume—Resumes a job submitted to the server that has been paused by the pause operation.

  • products—Gets the map products that the Topographic Production Service supports.

    • product—Gets a single map product from the products that the Topographic Production Service supports.
  • properties—Gets some of the service and database properties.

  • removeProduct—Removes a map product from the Topographic Production Service.

  • workflows—Contains the topographic production workflow resources to be run in a topographic production server and interact with ArcGIS Workflow Manager in an ArcGIS Enterprise organization to manage production workflows.

    • projects—Contains the operations used to create and manage topographic production workflow projects.

      • addProject—Adds a project to the server.

      • queryProject—Returns details about an existing project on the server.

      • removeProject—Removes a project from the server.

      • updateProject—Updates the properties of an existing project on the server.

    • taskgroups—Contains the operations used to manage task groups, which define the work done by a parent job in a topographic production workflow using ArcGIS Workflow Manager.

      • addTaskGroup—Adds task groups from the Topographic Production Service-based workflows.

      • createTaskGroupJob—Creates the parent Workflow Manager job with which child workflow task jobs are associated.

      • getTaskGroups—Gets parent Workflow Manager jobs.

      • hasNextTask—Specifies whether the parent Workflow Manager job has remaining child job tasks.

      • insertTasks—Inserts a set of child job tasks into a task group.

    • tasks—Contains operations that update, run, or get child tasks.

  • updateProduct—Updates the properties of an existing map product.

Request parameters

ParameterDetails

f

(Optional)

Parameter to specify the response format. The default response format is html.

Values: html | json | pjson

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
1
{"name":"<name>","type":"<type>"}

JSON Response example

The following is an example of a response:

Use dark colors for code blocksCopy
1
{"name":"Topographic Production Server","type":"Map Server Extension"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.