webPrintingJob

URI

<webPrintingJobs_uri>/{jobId}[.<format>]

支持的方法

GET、DELETE、HEAD

父资源

webPrintingJobs

子资源

webPrintingJobResult

介绍

webPrintingJob 资源是 Web 打印任务信息资源，通过发送 GET 请求，获取 Web 打印任务的信息、状态和结果地址。

支持的方法：

支持的表述格式：RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiserver 是服务器名。

http://supermapiserver:8090/iserver/services/webprinting/rest/webprinting/v1/jobs/{jobId}.rjson

GET 请求

获取 Web 打印任务的信息、状态和结果地址。

响应结构

对 webPrintingJob 资源执行 GET 请求，返回的资源表述结构如下：

字段 类型 说明
id String Web 打印任务的 id。
info object Web 打印信息类，包含打印内容、布局信息、输出信息等。
status String Web 打印任务的运行状态。
result object Web 打印任务的结果信息。
startTime String Web打印的起始时间。
endTime String Web打印的完成时间。

info 对象的结构如下：

名称 类型 含义
content object Web 打印的内容，例如：WebMap。
layoutOptions object Web 打印的布局选项，包含各种布局元素的设置。
exportOptions object Web 打印的输出选项，包含 DPI、页面大小等。

 

content 对象的结构如下：

名称 类型 含义
type String Web 打印内容支持的类型，包括：WEBMAP。
url String 待打印的 SuperMap iPortal WebMap 的 url。

token

 String SuperMap iPortal 用户的 token。

value

 object Web 打印的内容。

 

layoutOptions 对象的结构如下：

名称 类型 含义
templateName String 布局模板的名称。
title String 地图主标题名称。
subTitle String 地图副标题名称。
author String 地图作者名称。
copyright String 地图版权信息。
scaleBarOptions object 地图比例尺选项。
northArrowOptions object 地图指北针选项。
littleMapOptions object 小地图选项。
legendOptions object 图例选项。

 

scaleBarOptions 对象的结构如下：

名称 类型 含义
scaleText String 比例尺文本信息，例如：1:1000000。
type String 比例尺的样式，包括：LINE, BAR, BAR_SUB。
intervals number 比例尺条的段数。
unit String 比例尺的单位制，包括：METER, FOOT, DEGREES。

 

northArrowOptions 对象的结构如下：

名称 类型 含义

picAsBase64

 String 指北针的base64位图片信息。
picAsUrl String 指北针的图片 url 地址。

 

littleMapOptions 对象的结构如下：

名称 类型 含义
scale number 小地图的比例尺。
center Point2D 小地图的中心点。
layerNames String 指定 WebMap中图层名称的列表，用于渲染小地图。
layers object 指定 WebMap 中的 layers 图层。

legendOptions 对象的结构如下：

名称 类型 含义
title String 图例名称。
picAsUrl String 通过 url 传入图例的图片。
picAsBase64 String 传入图例的base64位图片信息。
customItems object 自定义一组图例元素，用户可以传入一个 JSON 字符串。

customItems 对象的结构如下：

名称 类型 含义
name String 图例元素的名称。
picAsBase64 String 图例元素 Base64 格式图片。
picAsUrl String 图例元素图片的获取地址。

exportOptions 对象的结构如下：

名称 类型 含义
format enum Web 打印输出的格式，包括：PNG、PDF。
dpi number Web 打印输出的分辨率，单位为每英寸点数。默认值为 96 dpi。
scale number Web 打印输出的地图比例尺。
rotation number Web 打印输出的地图角度。
center Point2D Web 打印输出的地图中心点。

result 对象的结构如下：

名称 类型 含义

downloadUrl

 String web 打印输出文档的下载链接地址。
id String Web 打印任务的 id。
startTime String Web打印的起始时间。
endTime String Web打印的完成时间。

 

响应示例

对 webPrintingJob 资源：http://supermapiserver:8090/iserver/services/webprinting/rest/webprinting/v1/jobs/{jobId}.rjson，执行 GET 请求，返回 rjson 格式的资源描述如下：

{

    "result": {

        "downloadUrl": "http://localhost:8090/iserver/services/webprinting/rest/webprinting/v1/jobs/90f7de02-b6d4-4bd9-a446-6cff3f321336@54af249d-69fb-415e-9bf3-46c902143e6b/result"

    },

    "startTime": "2020-09-25 11:13:35",

    "id": "90f7de02-b6d4-4bd9-a446-6cff3f321336@54af249d-69fb-415e-9bf3-46c902143e6b",

    "endTime": "2020-09-25 11:13:38",

    "info": {

        "layoutOptions": {

            "template": "A3_landscape",

            "copyright": "版权信息",

            "littleMapOptions": {

                "center": {

                    "x": 12659780.84769,

                    "y": 1630935.5331

                },

                "layers": [

                    {

                        "layerType": "TILE",

                        "name": "China",

                        "url": "http://localhost:8090/iserver/services/map-China100/rest/maps/China_4326"

                    }

                ],

                "scale": 2.63157894736842E-08

            },

            "subTitle": "副标题",

            "templateName": "A3_landscape",

            "author": "作者",

            "legendOptions": {

                "customItems": [

                    {

                        "name": "铁路",

                        "picAsUrl": "http://192.168.120.40:8090/iserver/services/map-China100/rest/maps/China/layers/Main_Railway_L@China@@China/legend"

                    },

                    {

                        "name": "河流",

                        "picAsUrl": "http://localhost:8090/iserver/services/map-China100/rest/maps/China/layers/River@China@@China/legend"

                    },

                    {

                        "name": "主干道",

                        "picAsUrl": "http://localhost:8090/iserver/services/map-China100/rest/maps/China/layers/Main_Road_L@China@@China/legend"

                    },

                    {

                        "name": "机场",

                        "picAsUrl": "http://localhost:8090/iserver/services/map-China100/rest/maps/China/layers/Airport_pt@China.1@@China/legend"

                    }

                ],

                "title": "图例"

            },

            "title": "主标题",

            "scaleBarOptions": {

                "scaleText": "比例尺"

            }

        },

        "exportOptions": {

            "format": "pdf",

            "dpi": 120

        },

        "content": {

            "type": "WEBMAP",

            "url": "http://localhost:8190/iportal/web/maps/1736272835/map.rjson"

        }

    },

    "status": "FINISHED"

}

DELETE 请求

取消并删除指定 id 的正在执行的 Web 打印任务。

响应结构

对 webPrintingJob 资源执行 DELETE 请求，返回的资源表述结构如下：

字段 类型 说明
successed boolean 取消并删除一个 Web 打印任务是否成功。
errorMsg String 出错信息。

响应示例

对 webPrintingJob 资源：http://supermapiserver:8090/iserver/services/webprinting/rest/webprinting/v1/jobs/{jobId}.rjson，执行 DELETE 请求，返回 rjson 格式的资源描述如下：

{

    "successed": true

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 webPrintingJob 资源是否存在，或者客户端是否有权限访问 webPrintingJob 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 webPrintingJob 资源是否支持<format>格式的表述。

请参见