- URL:
- https://<root>/<serviceName>/TopographicProductionServer/jobs/download
- Methods:
GET- Required Capability:
- Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
- Version Introduced:
- 12.2
Description
The download operation packages the outputs of one or more completed jobs into a single ZIP file that can be retrieved from the server. It submits an asynchronous download job and returns a job ID that you can use with the job operation to track the job's status. When the download job completes, the response includes the URL or URLs to the packaged output.
Only completed generate jobs (job type 1, Map) and task group jobs (job type 2, Workflow) are supported. If you include a job ID for any other job type in the job parameter, it is skipped and a warning is added to the job messages.
Request parameters
| Parameter | Details |
|---|---|
(Required) | A unique name for the generated download file. The value is used to name the output ZIP file returned by the operation. |
(Required) | A JSON array of job IDs to include in the download. Each ID must correspond to a completed |
(Required) |
Specifies the response format. Values: |
Output chunking
If the generated ZIP file exceeds the network transfer limit, the operation splits the output into smaller parts and returns a URL for each segment in the output array. The maximum chunk size is controlled by the Download field in the TPS table and is specified in bytes. The minimum supported value is 104857600 (100 MB); smaller values are ignored and the default value is used.
Example usage
Package the outputs of three completed generate jobs into a single ZIP file using the download REST operation.
Request URL and parameters:
https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/jobs/downloadf=json
name=weekly_products
jobIds=[
"1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2",
"4A2BF5B1-2D86-4B71-2D86-1EC280F653D2",
"F5B153D2-9C3F-4B71-9C3F-4A2B1EC280F6"
]JSON Response syntax
The following is the syntax of the response returned when the download job is submitted:
{
"jobId": "<jobID>",
"statusUrl": "<statusUrl>",
"success": <true | false>
}JSON Response example
The following is an example of a successful response:
{
"jobId": "0AECA2CE-8690-4EEC-935B-CEA8E403765F",
"statusUrl": "https://organization.example.com/<context>/rest/services/SampleService/TopographicProductionServer/jobs/job/0AECA2CE-8690-4EEC-935B-CEA8E403765F",
"success": true
}Retrieving the output
Use the job operation with the returned job to track the status of the download job. When the job completes, the response includes the following properties that describe the packaged output:
| Property | Details |
|---|---|
| The name of the generated download file, matching the |
| The format of the generated download file. The value is |
| The URL of the packaged ZIP file. If the output was split into multiple chunks because it exceeded the |