Exports Map Content, based on ESRI Export Web Map Specification by accepting various additional Parameters and Layouts or Layout Packages.
Specify a registered Layout Folder Datastore if Layout Templates are locally hosted and the mandatory Task Parameters before submit.
| Parameter | Explanation |
|---|---|
| Web_Map_as_JSON |
Web Map as JSON. Default is {}. See Task Request Schema. |
| Web_Map_as_FILE (Optional) |
Web Map as FILE. Reference to ZIP File uploaded to the Hosting Server containing the compressed Value of 'Web_Map_as_JSON'. This Parameter can be used to overcome HTTP POST Size Limitations. See https://developers.arcgis.com/rest/services-reference/enterprise/upload.htm. |
| Output_File |
Location of the default Output File. Default is C:\temp\default.pdf. |
| Format (Optional) |
Output Format [AIX|BMP|EMF|EPS|GIF|JPG|PDF|PNG|PNG32|SVG|SVGZ|TGA|TIFF]. Default is PDF. |
| Layout_Template (Optional) |
Layout Template [MAP_ONLY|Layout Ref|Layout Package Ref]. Default is MAP_ONLY. See Task Request Schema. |
| Additional_Settings_as_JSON (Optional) |
Additional Settings as JSON. Default is {}. See Task Request Schema. |
| Additional_Web_Maps_as_JSON (Optional) |
Additional Web Maps as JSON. Default is []. See Task Request Schema. |
| Additional_Web_Maps_as_FILE (Optional) |
Additional Web Maps as FILE. Reference to ZIP File uploaded to the Hosting Server containing the compressed Value of 'Additional_Web_Maps_as_JSON'. This Parameter can be used to overcome HTTP POST Size Limitations. See https://developers.arcgis.com/rest/services-reference/enterprise/upload.htm. |
Task Request Schema :: Parameter: 'Web_Map_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-webmap.schema.json",
"title": "VertiGIS Printing Export Web Map Specification.",
"description": "Specification for VertiGIS Printing 'Web_Map_as_JSON' Request Parameter. Defines Schema of the Map Content for the Main Map Frame Element in the Default Layout. This Specification is based on the ESRI Export Web Map Specification (see https://enterprise.arcgis.com/en/server/latest/publish-services/windows/exportwebmap-specification.htm). The Attributes defined here are Extensions to the ESRI Export Web Map Specification.",
"type": "object",
"mapOptions": {
"description": "VertiGIS Export Web Map - Map Options as JSON. Remaining Properties are defined by ESRI Export Web Map - Map Options Specification.",
"type": "object",
"properties": {
"rangeOptions": {
"description": "(optional) Series Value Range Options.",
"type": "object",
"operationalLayers": {
"description": "(optional) Operational Layer - Field References. Layer ID - Field Mapping is necessary for Web Clients, since no active Range Information can be fetched by the Engine for Web Maps.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"description": "Operational Layer - Field Reference.",
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"id":{
"description": "Operational Layer ID.",
"type": "string"
},
"field":{
"description": "Operational Layer Field.",
"type": "string"
}
}
}
]
}
]
}
}
}
},
"legendOptions": {
"description": "(optional) VertiGIS Export Web Map - Legend Options as JSON. Remaining Properties are defined by ESRI Export Web Map - Legend Options Specification.",
"type": "object",
"properties": {
"operationalLayersAutoSet": {
"description": "(optional) Whether all Layers in the Map should be automatically shown in the ESRI Legend Layout Element. Default is False.",
"type": "boolean"
}
}
},
"required": [
"mapOptions"
]
}
Task Request Schema :: Parameter: 'Layout_Template'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema":"http://json-schema.org/schema",
"$id":"https://vertigis.com/print-request-param-layout-template.schema.json",
"title":"VertiGIS Printing Layout Template Specification.",
"description":"Specification for VertiGIS Printing 'Layout_Template' Request Parameter. Parameter Value might be the Name of a Default Layout PAGX File in a Folder Datastore, a VGS ID of a Default Layout Portal Item, a VGS ID of a Layout Package Portal Item or a List of ESRI CIM Layout Documents as JSON as defined by this Schema.",
"type":"object",
"properties":{
"version":{
"description":"Schema Version.",
"type":"string",
"default":"0.1"
},
"type":{
"description":"Layout Template Request Type.",
"type":"string",
"default":"pagx_json"
},
"layout_id":{
"description":"Default Layout ID.",
"type":"string"
},
"layout_pagx_jsons":{
"description":"List of ESRI CIM Layout Documents.",
"type":"array",
"minItems": 1,
"uniqueItems":true,
"items":{
"type":"object",
"properties":{
"name":{
"description":"Layout Name.",
"type":"string"
},
"pagx_json":{
"description":"ESRI CIM Layout Document as JSON.",
"type":"object",
"properties":{
}
}
},
"required":[
"name",
"pagx_json"
]
}
}
},
"required":[
"type",
"layout_id",
"layout_pagx_jsons"
]
}
Task Request Schema :: Parameter: 'Additional_Settings_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-additional-settings.schema.json",
"title": "VertiGIS Printing Additional Settings Specification.",
"description": "Specification for VertiGIS Printing 'Additional_Settings_as_JSON' Request Parameter. Defines Schema of the Properties for related Layouts, dynamic Layout Elements, Time- and Range Series Settings, Feature Selections, Attribute Tables, Stylings, etc.",
"type": "object",
"properties": {
"version": {
"description": "Schema Version.",
"type": "string",
"default": "0.1"
},
"authentication": {
"description": "(optional) Authentication Information for Access to an ArcGIS Online / ArcGIS Enterprise Organization. Authentication Information is required for the Access of Layout Portal Items.",
"type": "object",
"properties": {
"anonymous": {
"description": "Whether the Access to an ArcGIS Online / ArcGIS Enterprise Organization is anonymous. If anonymous is true, no token is required.",
"type": "boolean"
},
"portal_url": {
"description": "(optional) Portal URL of an ArcGIS Enterprise Organization. If not defined, ArcGIS Online Access is assumed.",
"type": "string"
},
"token": {
"description": "(optional) Access Token. Required for non-anonymous Access.",
"type": "string"
},
"referer": {
"description": "(optional) Access Token Referer. Required for non-anonymous Access if the token was created with the ESRI 'Generate Token Service'.",
"type": "string"
}
},
"required": ["anonymous"]
},
"security": {
"description": "(optional) Security Settings.",
"type": "object",
"properties": {
"outputPassword": {
"description": "(optional) AES-128 encrypted Password to secure resulting PDF Documents. Clients must use shared AES Crypto-Key for Password encryption.",
"type": "string"
}
}
},
"dynamicElements": {
"description": "(optional) Dynamic Elements additionally to the dynamic Text Elements in the Layout Options of the Main Web Map.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"type": {
"description": "Dynamic Element Type. One of ['string', 'image'].",
"type": "string"
},
"value": {
"description": "Dynamic Element Value.",
"type": "string"
},
"name": {
"description": "Dynamic Element Name.",
"type": "string"
}
},
"required": ["type", "value", "name"]
}
]
},
"selection": {
"description": "(optional) Layer Objects Selections.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"oidList": {
"description": "Layer Object IDs.",
"type": "array",
"items": [
{
"description": "Layer Object ID.",
"type": "integer",
"minimum": 0
}
]
},
"layerId": {
"description": "Web Map Layer ID.",
"type": "string"
},
"visible": {
"description": "(optional) Whether the default Feature Selection Graphics should be visible for selected Features. If 'true' or not defined, the Engine's default Feature Selection Graphics is used. If 'false', Feature Selection Graphics are expected in the Webmap Request Parameter (e.g. operational Layer with custom Renderer for selected Features, or predefined Selection Geometries with custom Renderer in the Feature Collection).",
"type": "boolean",
"default": true
}
},
"required": ["oidList", "layerId"]
}
]
},
"timeSeries": {
"description": "(optional) Series Time Properties for Time-Aware Layers.",
"type": "object",
"properties": {
"maxCount": {
"description": "(optional) Maximum Count of Spatial Time Series PDF Documents within the returned ZIP Archive. If not set, no limit for Time Series PDF Document Exports is used. Depending on the Client and the Execution Environment and Template- / Map Properties, the Clients should always define a suitable Value.",
"type": "number"
},
"timeZone": {
"description": "(optional) Client Time Zone Information. Default is UTC.",
"type": "object",
"properties": {
"utcOffset": {
"description": "Offset in Hours to UTC without Daylight Saving Time (DST).",
"type": "number"
},
"name": {
"description": "Timezone Name. Used for the Time Function Field.",
"type": "string"
}
}
},
"datetimePattern": {
"description": "(optional) Human-readable Date Time Pattern in ESRI Format: https://pro.arcgis.com/en/pro-app/latest/help/data/tables/format-numeric-and-date-fields.htm. Used for the Time Function Field. Default is 'yyyy-MM-dd hh:mm:ss'.",
"type": "string"
},
"interval": {
"description": "(optional) Export Interval Property in Milliseconds or in other Interval Units if defined. Requires a single Export Time in the Array with a Time Range > 0. If defined, an Export is triggered for each Interval starting at the Time Range <startTime> and stopping at <endTime>. If no Main Map with one or more visible Time-Aware Layers is available for Exporting, or if the defined Interval does not fit into the specified Time Range, this Property is ignored.",
"type": "number"
},
"intervalUnits": {
"description": "(optional) Export Interval Units Property. Requires a defined Interval. Default is MILLISECONDS. Possible Values are MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES.",
"type": "string"
},
"times": {
"description": "Export Times Properties. Triggers an Export for each defined Export Time.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"description": "Export Time in Milliseconds UTC.",
"type": "array",
"minItems": 1,
"items": [
{
"description": "Time Instant or Time Range Value in Format '<timeInstant> | <startTime>, <endTime>'.",
"type": "number",
"minItems": 1
}
]
}
]
}
},
"required": ["times"]
},
"rangeSeries": {
"description": "(optional) Series Value Range Properties for Range/z-Aware Layers.",
"type": "object",
"properties": {
"maxCount": {
"description": "(optional) Maximum Count of Value Range Series Pages per PDF Document. If not set, no limit for Value Range Series PDF Page Exports is used. Depending on the Client and the Execution Environment and Template- / Map Properties, the Clients should always define a suitable Value.",
"type": "number"
},
"interval": {
"description": "(optional) Export Interval Property in Integer or Float. Requires a single Export Value Range in the Array with a Value Range Extent > 0. If defined, an Export is triggered for each Interval starting at the Value Range <start> and stopping at <end>. If no Main Map with one or more visible z-Aware Layers is available for Exporting, or if the defined Interval does not fit into the specified Value Range Span, this Property is ignored.",
"type": "number"
},
"ranges": {
"description": "Export Value Ranges Properties. Triggers an Export for each defined Export Value Range.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"description": "Export Value Range.",
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"start": {
"description": "Start Value.",
"type": "number"
},
"end": {
"description": "End Value.",
"type": "number"
},
"includeStart": {
"description": "Whether the Start Value is included in the Value Range.",
"type": "boolean"
},
"includeEnd": {
"description": "Whether the End Value is included in the Value Range.",
"type": "boolean"
}
}
}
]
}
]
}
},
"required": ["ranges"]
},
"attributeTables": {
"description": "(optional) Attribute Tables Properties.",
"type": "array",
"minItems": 0,
"uniqueItems": false,
"items": [
{
"type": "object",
"properties": {
"name": {
"description": "Name of Attribute Table.",
"type": "string"
},
"layerId": {
"description": "ID of the Map Layer used as Data Source.",
"type": "string"
},
"mode": {
"description": "(optional) Data Selection Mode.",
"type": "string",
"pattern": "^(All|InExtent|SelectedAll|SelectedInExtent)$",
"default": "InExtent"
},
"fields": {
"description": "List of Table Fields.",
"type": "array",
"minItems": 1,
"items": [
{
"description": "Field Name.",
"type": "string"
}
]
}
},
"required": ["name", "layerId", "fields"]
}
]
},
"page": {
"description": "(optional) Page Properties. Mandatory for Projected Single Page Print Requests.",
"type": "object",
"properties": {
"scale": {
"description": "Page Scale.",
"type": "number",
"minimum": 1
},
"rotation": {
"description": "(optional) Page Rotation.",
"type": "number",
"default": 0
},
"geometry": {
"description": "Projected Page Geometry. An Array of Geometry Points according to the ESRI Specification.",
"type": "array",
"minItems": 2,
"items": [
{
"description": "X-Coordinate of the Point.",
"type": "number"
},
{
"description": "Y-Coordinate of the Point.",
"type": "number"
}
]
},
"spatialReference": {
"description": "Spatial Reference of the projected Page Geometry. ESRI Spatial Reference Specification.",
"type": "object",
"properties": {
"wkid": {
"description": "Spatial Reference WKID.",
"type": "integer",
"default": 102100
}
},
"required": ["wkid"]
},
"spatialReferenceOut": {
"description": "Output Spatial Reference of the projected Page Geometry for Export. ESRI Spatial Reference Specification.",
"type": "object",
"properties": {
"wkid": {
"description": "Spatial Reference WKID.",
"type": "integer",
"default": 102100
}
},
"required": ["wkid"]
},
"transformationName": {
"description": "(optional) Transformation Name for projecting the Page Geometry between the Geometry Spatial Reference and the Output Spatial Reference.",
"type": "string"
},
"transformationString": {
"description": "(optional) Transformation WKT String for projecting the Page Geometry between the Geometry Spatial Reference and the Output Spatial Reference.",
"type": "string"
},
"dynamicElements": {
"description": "(optional) Dynamic Elements of the Page additionally to the dynamic Text Elements in the Layout Options of the Main Web Map and the dynamic Elements in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"type": {
"description": "Dynamic Element Type. One of ['string', 'image'].",
"type": "string"
},
"value": {
"description": "Dynamic Element Value.",
"type": "string"
},
"name": {
"description": "Dynamic Element Name.",
"type": "string"
}
},
"required": ["type", "value", "name"]
}
]
},
"selection": {
"description": "(optional) Layer Objects Selections of the Page additionally to the Layer Objects Selections in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"oidList": {
"description": "Layer Object IDs.",
"type": "array",
"items": [
{
"description": "Layer Object ID.",
"type": "integer"
}
]
},
"layerId": {
"description": "Web Map Layer ID.",
"type": "string"
},
"visible": {
"description": "(optional) Whether the default Feature Selection Graphics should be visible for selected Features. If 'true' or not defined, the Engine's default Feature Selection Graphics is used. If 'false', Feature Selection Graphics are expected in the Webmap Request Parameter (e.g. operational Layer with custom Renderer for selected Features, or predefined Selection Geometries with custom Renderer in the Feature Collection).",
"type": "boolean",
"default": true
}
},
"required": ["oidList", "layerId"]
}
]
}
},
"required": [
"scale",
"geometry",
"spatialReference",
"spatialReferenceOut"
]
},
"pages": {
"description": "Series Page Properties. Mandatory for Spatial Series Pages Print Requests.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"scale": {
"description": "Page Scale.",
"type": "number",
"minimum": 1
},
"rotation": {
"description": "(optional) Page Rotation.",
"type": "number",
"default": 0
},
"centerX": {
"description": "(optional) Page Centerpoint x-Coordinate.",
"type": "number"
},
"centerY": {
"description": "(optional) Page Centerpoint y-Coordinate.",
"type": "number"
},
"geometry": {
"description": "(optional) Projected Page Geometry. An Array of Geometry Points according to the ESRI Specification.",
"type": "array",
"minItems": 2,
"items": [
{
"description": "X-Coordinate of the Point.",
"type": "number"
},
{
"description": "Y-Coordinate of the Point.",
"type": "number"
}
]
},
"spatialReference": {
"description": "(optional) Spatial Reference of the projected Page Geometry. ESRI Spatial Reference Specification.",
"type": "object",
"properties": {
"wkid": {
"description": "Spatial Reference WKID.",
"type": "integer",
"default": 102100
}
},
"required": ["wkid"]
},
"spatialReferenceOut": {
"description": "(optional) Output Spatial Reference of the projected Page Geometry for Export. ESRI Spatial Reference Specification.",
"type": "object",
"properties": {
"wkid": {
"description": "Spatial Reference WKID.",
"type": "integer",
"default": 102100
}
},
"required": ["wkid"]
},
"transformationName": {
"description": "(optional) Transformation Name for projecting the Page Geometry between the Geometry Spatial Reference and the Output Spatial Reference.",
"type": "string"
},
"transformationString": {
"description": "(optional) Transformation WKT String for projecting the Page Geometry between the Geometry Spatial Reference and the Output Spatial Reference.",
"type": "string"
},
"dynamicElements": {
"description": "(optional) Dynamic Elements of the Page additionally to the dynamic Text Elements in the Layout Options of the Main Web Map and the dynamic Elements in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"type": {
"description": "Dynamic Element Type. One of ['string', 'image'].",
"type": "string"
},
"value": {
"description": "Dynamic Element Value.",
"type": "string"
},
"name": {
"description": "Dynamic Element Name.",
"type": "string"
}
},
"required": ["type", "value", "name"]
}
]
},
"selection": {
"description": "(optional) Layer Objects Selections of the Page additionally to the Layer Objects Selections in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"oidList": {
"description": "Layer Object IDs.",
"type": "array",
"items": [
{
"description": "Layer Object ID.",
"type": "integer"
}
]
},
"layerId": {
"description": "Web Map Layer ID.",
"type": "string"
},
"visible": {
"description": "(optional) Whether the default Feature Selection Graphics should be visible for selected Features. If 'true' or not defined, the Engine's default Feature Selection Graphics is used. If 'false', Feature Selection Graphics are expected in the Webmap Request Parameter (e.g. operational Layer with custom Renderer for selected Features, or predefined Selection Geometries with custom Renderer in the Feature Collection).",
"type": "boolean",
"default": true
}
},
"required": ["oidList", "layerId"]
}
]
}
},
"required": [
"scale",
"centerX",
"centerY",
"geometry",
"spatialReference",
"spatialReferenceOut"
]
}
]
},
"seamless": {
"description": "Seamless Page Properties. Mandatory for Seamless Page Print Requests.",
"type": "object",
"properties": {
"scale": {
"description": "Page Scale.",
"type": "number",
"minimum": 1.0
},
"geometry": {
"description": "Index Line or Polygon Geometry. An Array of Geometry Points according to the ESRI Array Specification. Excepted Geometries are a Polyline with CENTER LEFT and CENTER RIGHT Coordinates or a Rectangle with BOTTOM LEFT, TOP LEFT, TOP RIGHT, BOTTOM RIGHT Coordinates or a complex Polygon with arbitrary vertices. A Polyline Geometry defines the delta, the current template's mapframe width should be updated with. A Rectangle or complex Polygon Geometry defines an arbitrary extent, for the current template's mapframe. For complex Polygons the extent is defined by the Polygon's Bounding Box. For complex Polygons Geometry Rotation can not be considered.",
"type": "array",
"minItems": 2,
"items": [
{
"description": "A Geometry Point.",
"type": "array",
"items": [
{
"description": "X-Coordinate of the Point.",
"type": "number"
},
{
"description": "Y-Coordinate of the Point.",
"type": "number"
}
]
}
]
},
"spatialReference": {
"description": "(optional) Spatial Reference of the Line or Polygon Geometry. ESRI Spatial Reference Specification.",
"type": "object",
"properties": {
"wkid": {
"description": "Spatial Reference WKID.",
"type": "integer",
"default": 102100
}
},
"required": ["wkid"]
}
},
"required": ["scale", "geometry"]
},
"pageCover": {
"description": "(optional) Cover Page Properties.",
"type": "object",
"properties": {
"visible": {
"description": "Whether the Cover Page is visible.",
"type": "boolean",
"default": false
}
},
"dynamicElements": {
"description": "(optional) Dynamic Elements of the Page additionally to the dynamic Text Elements in the Layout Options of the Main Web Map and the dynamic Elements in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"type": {
"description": "Dynamic Element Type. One of ['string', 'image'].",
"type": "string"
},
"value": {
"description": "Dynamic Element Value.",
"type": "string"
},
"name": {
"description": "Dynamic Element Name.",
"type": "string"
}
},
"required": ["type", "value", "name"]
}
]
}
},
"pageOverview": {
"description": "(optional) Overview Page Properties.",
"type": "object",
"properties": {
"visible": {
"description": "Whether the Overview Page is visible.",
"type": "boolean",
"default": false
},
"pageGraphics": {
"description": "(optional) Page Graphics Settings.",
"type": "object",
"properties": {
"visible": {
"description": "(optional) Whether the Page Graphics are visible.",
"type": "boolean",
"default": true
},
"colorStroke": {
"description": "(optional) Page Stroke RGB Color according to the ESRI RGB Color Specification.",
"type": "array",
"items": [
{
"description": "Red Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
},
{
"description": "Green Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Blue Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Alpha Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
}
]
},
"colorFill": {
"description": "(optional) Page Fill RGB Color according to the ESRI RGB Color Specification.",
"type": "array",
"items": [
{
"description": "Red Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
},
{
"description": "Green Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Blue Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Alpha Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
}
]
}
}
},
"pageGraphicsOverlap": {
"description": "(optional) Page Overlap Graphics Settings.",
"type": "object",
"properties": {
"visibleFill": {
"description": "(optional) Whether the Page Overlap Fill Graphics are visible.",
"type": "boolean",
"default": true
},
"colorFill": {
"description": "(optional) Page Overlap Fill RGB Color according to the ESRI RGB Color Specification.",
"type": "array",
"items": [
{
"description": "Red Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
},
{
"description": "Green Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Blue Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Alpha Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
}
]
}
}
},
"pageGraphicsIndex": {
"description": "(optional) Page Graphics Index Settings.",
"type": "object",
"properties": {
"visibleStroke": {
"description": "(optional) Whether the Index Line Graphics is visible.",
"type": "boolean",
"default": true
},
"visibleAnnotation": {
"description": "(optional) Whether the Page Number Annotations are visible.",
"type": "boolean",
"default": true
},
"colorStroke": {
"description": "(optional) Index Line Stroke RGB Color according to the ESRI RGB Color Specification.",
"type": "array",
"items": [
{
"description": "Red Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
},
{
"description": "Green Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Blue Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Alpha Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
}
]
},
"colorAnnotation": {
"description": "(optional) Page Number Annotations RGB Color according to the ESRI RGB Color Specification.",
"type": "array",
"items": [
{
"description": "Red Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
},
{
"description": "Green Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Blue Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
{
"description": "Alpha Value.",
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 255
}
]
}
}
}
}
},
"pageLegend": {
"description": "(optional) Legend Page Properties.",
"type": "object",
"properties": {
"visible": {
"description": "Whether the Legend Page is visible.",
"type": "boolean",
"default": false
},
"layerCompositeExport": {
"description": "(optional) Whether the Legend Items of dynamic Layers organized in Composite Layers on Root Level should be exported on seperate Legend Pages. Legend Items are seperated if this Value is set to 'true'. This might cause additional Legend Page Exports.",
"type": "boolean",
"default": false
},
"itemsAutoVisibility": {
"description": "(optional) Whether the Legend Items of visible Layers should only be exported if related Features are visible in the Map. If not defined, the Value from the Layout's default Legend Item ('Only show feature visible in the map extent') is used.",
"type": "boolean"
}
},
"dynamicElements": {
"description": "(optional) Dynamic Elements of the Page additionally to the dynamic Text Elements in the Layout Options of the Main Web Map and the dynamic Elements in the Additional Settings.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"type": {
"description": "Dynamic Element Type. One of ['string', 'image'].",
"type": "string"
},
"value": {
"description": "Dynamic Element Value.",
"type": "string"
},
"name": {
"description": "Dynamic Element Name.",
"type": "string"
}
},
"required": ["type", "value", "name"]
}
]
}
},
"geoTransforms": {
"description": "(optional) Geo Transforms used for Maps to avoid spatial displacement between Operational Layers and Basemap Layers if they have incompatible underlying geographic Coordinate Systems. These Transforms are added to all Maps in the Request. They are ignored if no Geo Transform is necessary. Also see: https://developers.arcgis.com/rest/services-reference/enterprise/pdf/gtf_pdf_11.1.pdf",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"wkid": {
"description": "(optional) WKID. E.g.: 1618",
"type": "number"
},
"latestWkid": {
"description": "(optional) Latest WKID. E.g.: 1618",
"type": "number"
},
"wkt": {
"description": "(optional) WKT String. E.g.: 'MGI_To_WGS_1984_3'",
"type": "string"
},
"name": {
"description": "(optional) Name of Geo Transform. E.g.: 'GEOGTRAN[\"MGI_To_WGS_1984_3\", GEOGCS[\"GCS_MGI\",DATUM[\"D_MGI\" ,SPHEROID[\"Bessel_1841\",6377397.15 5,299.1528128]],PRIMEM[\"Greenwich \",0.0],UNIT[\"Degree\",0.017453292519 9433]],GEOGCS[\"GCS_WGS_1984\",DA TUM[\"D_WGS_1984\",SPHEROID[\"WG S_1984\",6378137.0,298.257223563]], PRIMEM[\"Greenwich\",0.0],UNIT[\"Degr ee\",0.0174532925199433]],METHOD[ \"Position_Vector\"],PARAMETER[\"X_Ax is_Translation\",577.326],PARAMETER[ \"Y_Axis_Translation\",90.129],PARAME TER[\"Z_Axis_Translation\",463.919],PA RAMETER[\"X_Axis_Rotation\",5.137],P ARAMETER[\"Y_Axis_Rotation\",1.474], PARAMETER[\"Z_Axis_Rotation\",5.297] ,PARAMETER[\"Scale_Difference\",2.42 32],OPERATIONACCURACY[1.5]] '",
"type": "string"
}
},
"required": ["wkid", "latestWkid", "wkt"]
}
]
}
},
"required": []
}
Task Request Schema :: Parameter: 'Additional_Web_Maps_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-additional-webmaps.schema.json",
"title": "VertiGIS Printing Additional Web Maps Specification.",
"description": "Specification for VertiGIS Printing 'Additional_Web_Maps_as_JSON' Request Parameter. Defines Schema of the Map Content for additional non-Main Map Frame Elements in the Layout Templates.",
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"name": {
"description": "Name of the Map Frame Element in the referenced Layout Templates. Additionally the Main Map Frame Element 'WEBMAP_MAP_FRAME' Content can be overwritten for specific Pages by defining a 'PAGE_[Name of the Page]' Suffix. E.g. 'WEBMAP_MAP_FRAME_PAGE_OVERVIEW': Overwites the Content of the 'WEBMAP_MAP_FRAME' Element in the Overview Page Layout with the specified Map.",
"type": "string"
},
"Map_As_JSON": {
"description": "VertiGIS Export Web Map as JSON.",
"type": "object"
}
},
"required": [
"name",
"Map_As_JSON"
]
}
]
}
Task Request Schema - Map Book :: Parameter: 'Web_Map_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-mapbook-map.schema.json",
"title": "VertiGIS Printing Map Book - Map Specification.",
"description": "Specification for VertiGIS Printing 'Web_Map_as_JSON' and 'Pro_Map_as_JSON' Request Parameters for Map Book Exports. Defines Schema of the Map Content for Main Map Frame Elements in the Default Layout Templates, related to the Map Book.",
"type": "object",
"mapBook": {
"description": "Map Book - Default Map Insets Definition.",
"type": "object",
"properties": {
"name": {
"description": "(optional) Map Book Name.",
"type": "string"
},
"merge": {
"description": "(optional) Whether the exported Map Book Pages should be merged to single Document. If False, each Composition of the Map Book is exported as seperate Document.",
"type": "boolean",
"default": true
},
"content": {
"description": "Default Map Insets.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"description": {
"description": "(optional) Default Map Inset Description.",
"type": "string"
},
"layoutRefs": {
"description": "List of Default Layout References for a Default Map Inset. VertiGIS Layout IDs.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"description": "VertiGIS Layout ID.",
"type": "string"
}
]
},
"mapId": {
"description": "Default Map Inset ID.",
"type": "string"
},
"mapFrame": {
"description": "Default Map Inset Map Frame.",
"type": "object",
"properties": {
"name": {
"description": "(optional) Name of the Main Map Frame Element in the referenced Default Layout Templates.",
"type": "string",
"default": "WEBMAP_MAP_FRAME"
},
"Map_As_JSON": {
"description": "ESRI Export Web Map or Pro Map Definition as JSON.",
"type": "string"
}
},
"required": [
"Map_As_JSON"
]
}
},
"required": [
"layoutRefs",
"mapId",
"mapFrame"
]
}
]
}
},
"required": [
"content"
]
}
}
Task Request Schema - Map Book :: Parameter: 'Additional_Settings_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-mapbook-additional-settings.schema.json",
"title": "VertiGIS Printing Map Book - Additional Settings Specification.",
"description": "Specification for VertiGIS Printing 'Additional_Settings_as_JSON' Request Parameter for Map Book Exports. Defines Schema of the Properties for related Layouts, dynamic Layout Elements, Time- and Range Series Settings, Feature Selections, Attribute Tables, Stylings, etc., related to the Map Book.",
"type": "object",
"mapBook": {
"description": "Map Book - Additional Setting Insets Definition.",
"type": "object",
"properties": {
"authentication": {
"description": "(optional) Authentication Information for Access to an ArcGIS Online / ArcGIS Enterprise Organization. Authentication Information is required for the Access of Layout Portal Items.",
"type": "object",
"properties": {
"anonymous": {
"description": "Whether the Access to an ArcGIS Online / ArcGIS Enterprise Organization is anonymous. If anonymous is true, no token is required.",
"type": "boolean"
},
"portal_url": {
"description": "(optional) Portal URL of an ArcGIS Enterprise Organization. If not defined, ArcGIS Online Access is assumed.",
"type": "string"
},
"token": {
"description": "(optional) Access Token. Required for non-anonymous Access.",
"type": "string"
},
"referer": {
"description": "(optional) Access Token Referer. Required for non-anonymous Access if the token was created with the ESRI 'Generate Token Service'.",
"type": "string"
}
},
"required": [
"anonymous"
]
},
"security": {
"description": "(optional) Security Settings.",
"type": "object",
"properties": {
"outputPassword": {
"description": "(optional) AES-128 encrypted Password to secure resulting PDF Documents. Clients must use shared AES Crypto-Key for Password encryption.",
"type": "string"
}
}
},
"content": {
"description": "Additional Setting Insets.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"description": {
"description": "(optional) Additional Setting Inset Description.",
"type": "string"
},
"layoutRef": {
"description": "Default Layout Reference for a Additional Setting Inset. VertiGIS Layout ID.",
"type": "string"
},
"mapRef": {
"description": "Default Map Inset Reference.",
"type": "string"
},
"Settings_As_JSON": {
"description": "Additional Settings as JSON. The following Settings Properties are used for Map Book only. For all remaining Settings Properties, see Schema print-request-param-settings-additional*.json.",
"type": "object",
"properties": {
"pageCover": {
"description": "(optional) Cover Page Properties.",
"type": "object",
"properties": {
"layoutRef": {
"description": "Cover Layout Reference. VertiGIS Layout ID.",
"type": "string"
}
}
},
"pageOverview": {
"description": "(optional) Overview Page Properties.",
"type": "object",
"properties": {
"layoutRef": {
"description": "Overview Layout Reference. VertiGIS Layout ID.",
"type": "string"
}
}
},
"pageLegend": {
"description": "(optional) Legend Page Properties.",
"type": "object",
"properties": {
"layoutRef": {
"description": "Legend Layout Reference. VertiGIS Layout ID.",
"type": "string"
}
}
}
}
}
},
"required": [
"layoutRef",
"mapRef",
"Settings_As_JSON"
]
}
]
}
},
"required": [
"content"
]
}
}
Task Request Schema - Map Book :: Parameter: 'Additional_Web_Maps_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-request-param-mapbook-additional-maps.schema.json",
"title": "VertiGIS Printing Map Book - Additional Maps Specification.",
"description": "Specification for VertiGIS Printing 'Additional_Web_Maps_as_JSON' and 'Additional_Pro_Maps_as_JSON' Request Parameters for Map Book Exports. Defines Schema of the Map Content for additional non-Main Map Frame Elements in the Layout Templates, related to the Map Book.",
"type": "object",
"mapBook": {
"description": "Map Book - Additional Maps Insets Definition.",
"type": "object",
"properties": {
"content": {
"description": "Additional Maps Insets.",
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"description": {
"description": "(optional) Additional Maps Inset Description.",
"type": "string"
},
"layoutRef": {
"description": "Default Layout Reference for a Additional Maps Inset. VertiGIS Layout ID.",
"type": "string"
},
"mapRefs": {
"description": "List of Default Map Inset References for a Additional Maps Inset. VertiGIS Layout IDs.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"description": "VertiGIS Layout ID.",
"type": "string"
}
]
},
"mapFrames": {
"description": "List of Additional Maps Inset Map Frames.",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "object",
"properties": {
"name": {
"description": "Name of the Additional Map Frame Element in the referenced Layout Templates. Additionally the Main Map Frame Element 'WEBMAP_MAP_FRAME' Content can be overwritten for specific Pages by defining a 'PAGE_[Name of the Page]' Suffix. E.g. 'WEBMAP_MAP_FRAME_PAGE_OVERVIEW': Overwites the Content of the 'WEBMAP_MAP_FRAME' Element in the Overview Page Layout with the specified Map.",
"type": "string"
},
"Map_As_JSON": {
"description": "ESRI Export Web Map or Pro Map Definition as JSON.",
"type": "object"
}
},
"required": [
"name",
"Map_As_JSON"
]
}
]
}
},
"required": [
"layoutRef",
"mapRefs",
"mapFrames"
]
}
]
}
},
"required": [
"content"
]
}
}
Task Response Schema
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV>
{
"$schema": "http://json-schema.org/schema",
"$id": "https://vertigis.com/print-response.schema.json",
"title": "Print Response Schema",
"type": "object",
"properties": {
"results": {
"description": "Print Results Output Parameters.",
"type": "array",
"minItems": 3,
"maxItems": 3,
"items": [
{
"type": "object",
"properties": {
"paramName": {
"description": "GP Process Print File Output Parameter Name.",
"type": "string"
},
"dataType": {
"description": "GP Process Print File Output Parameter Type.",
"type": "string"
},
"value": {
"description": "GP Process Print File Output Parameter Value.",
"type": "object",
"properties": {
"url": {
"description": "Print File URL.",
"type": "string"
}
},
"required": [
"url"
]
}
},
"required": [
"paramName",
"dataType",
"value"
]
},
{
"type": "object",
"properties": {
"paramName": {
"description": "GP Process APRX File Output Parameter Name.",
"type": "string"
},
"dataType": {
"description": "GP Process APRX File Output Parameter Type.",
"type": "string"
},
"value": {
"description": "GP Process APRX File Output Parameter Value.",
"type": "object",
"properties": {
"url": {
"description": "APRX File URL.",
"type": "string"
}
},
"required": [
"url"
]
}
},
"required": [
"paramName",
"dataType",
"value"
]
},
{
"type": "object",
"properties": {
"paramName": {
"description": "GP Process Log File Output Parameter Name.",
"type": "string"
},
"dataType": {
"description": "GP Process Log File Output Parameter Type.",
"type": "string"
},
"value": {
"description": "GP Process Log File Output Parameter Value.",
"type": "object",
"properties": {
"url": {
"description": "Log File URL.",
"type": "string"
}
},
"required": [
"url"
]
}
},
"required": [
"paramName",
"dataType",
"value"
]
}
]
},
"messages": {
"description": "GP Process Output Messages. Shown according to their Severity when publishing the Toolbox.",
"type": "array",
"minItems": 0,
"items": {}
}
},
"required": [
"results",
"messages"
]
}
Sample - Request Parameter :: 'Web_Map_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">Spatial Time Range Series Print</SPAN></P></DIV></DIV>
{
"mapOptions": {
"extent": {
"xmin": 1717832.151666021,
"ymin": 5953215.5152184395,
"xmax": 1718715.9548055683,
"ymax": 5954227.111514651,
"spatialReference": {
"wkid": 3857
}
},
"scale": 15000,
"rotation": 0,
"showAttribution": false,
"time": [
-11481527121000,
1293836400000
],
"rangeOptions": {
"operationalLayers": [
{
"id": "1018_5",
"field": "UMFANG"
},
{
"id": "1018_6",
"field": "DMPOL_C_P_"
}
]
}
},
"exportOptions": {
"outputSize": [
740,
847
],
"dpi": 288
},
"layoutOptions": {
"customTextElements": [
{
"syn_crs_caption": "CRS:"
},
{
"scale_caption": "Scale"
},
{
"scale_caption_ov": "Scale OV"
},
{
"createdat_caption": "Created"
},
{
"creator_caption": "Author"
},
{
"creator_value": "VERTIGIS\\n.author"
},
{
"creator_description": "My Information"
},
{
"title_value": "Demonstration (Web Server)"
},
{
"orgname_value": "VertiGIS GmbH"
},
{
"disclaimer_value": "My Disclaimer Text"
}
],
"legendOptions": {
"operationalLayersAutoSet": false,
"operationalLayers": [
{
"id": "1017"
},
{
"id": "1018_1"
},
{
"id": "1018_2"
},
{
"id": "1018_3"
},
{
"id": "1018_4"
},
{
"id": "1018_5"
},
{
"id": "1018_6"
}
]
},
"titleText": "Plot",
"authorText": "admin (admin)"
},
"operationalLayers": [
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/arcgis/rest/services/Cadaster_3857/FeatureServer/7",
"opacity": 0.5,
"visibility": true,
"id": "1017",
"title": "Cadaster - Plots",
"layerType": "ArcGISFeatureLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/CityMap_3857/FeatureServer/5",
"opacity": 1,
"visibility": true,
"id": "1018_1",
"title": "City Map - Forest",
"layerType": "ArcGISFeatureLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/CityMap_3857/FeatureServer/6",
"opacity": 1,
"visibility": true,
"id": "1018_2",
"title": "City Map - Grassland",
"layerType": "ArcGISFeatureLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/CityMap_3857/FeatureServer/7",
"opacity": 1,
"visibility": true,
"id": "1018_3",
"title": "City Map - Water Area",
"layerType": "ArcGISFeatureLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/CityMap_3857/FeatureServer/8",
"opacity": 1,
"visibility": true,
"id": "1018_4",
"title": "City Map - Traffic Area",
"layerType": "ArcGISFeatureLayer"
},
{
"visibleLayers": [
18
],
"url": "https://vw-dev-qa-vgs.int.vertigis.com/server/rest/services/Layer_Graz/Buildings/MapServer",
"opacity": 0.5,
"visibility": true,
"id": "1018_5_dynamic",
"title": "Buildings (dynamic)",
"layerType": "ArcGISMapServiceLayer"
},
{
"visibleLayers": [
14
],
"url": "https://vw-dev-qa-vgs.int.vertigis.com/server/rest/services/Layer_Graz/Monument_Protection/MapServer",
"opacity": 0.5,
"visibility": true,
"id": "1018_6_dynamic",
"title": "Monument Protection (dynamic)",
"layerType": "ArcGISMapServiceLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/Buildings_3857/FeatureServer/18",
"opacity": 1,
"visibility": true,
"id": "1018_5",
"title": "Buildings",
"layerType": "ArcGISFeatureLayer",
"layerDefinition": {
"definitionExpression": "KGNR_C = '63101'"
}
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/MonumentProtection_3857/FeatureServer/14",
"opacity": 1,
"visibility": true,
"id": "1018_6",
"title": "Monument Protection",
"layerType": "ArcGISFeatureLayer"
}
],
"baseMap": {
"title": "Graz Basemap",
"baseMapLayers": [
{
"url": "https://tiles.arcgis.com/tiles/p3UBboyC0NH1uCie/arcgis/rest/services/Orthophoto_2011_3857/MapServer",
"opacity": 0.3,
"visibility": true,
"id": "1020",
"title": "Orthophoto",
"layerType": "ArcGISTiledMapServiceLayer"
}
]
}
}
Sample - Request Parameter :: 'Additional_Settings_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Spatial Time Range Series Print</SPAN></P></DIV></DIV></DIV>
{
"version": "0.1",
"dynamicElements": [
{
"type": "image",
"value": "https://www.geocortex.com/wp-content/uploads/2019/05/vertigis-press-release-cover.jpg",
"name": "company_logo"
}
],
"selection": [
{
"oidList": [
2095,
685,
684,
104,
110,
513
],
"layerId": "1018_5"
}
],
"timeSeries": {
"timeZone": {
"utcOffset": 1,
"name": "W. Europe Standard Time"
},
"datetimePattern": "dd.MM.yyyy hh:mm",
"times": [
[
-11483856000000,
-8331015921000
],
[
-11483856000000,
-5175320721000
],
[
-11483856000000,
-2019625521000
],
[
-11483856000000,
1136069679000
],
[
1293840000000
],
[
-11483856000000
]
]
},
"rangeSeries": {
"ranges": [
{
"start": 123,
"end": 500,
"includeStart": true,
"includeEnd": false
}
]
},
"attributeTables": [
{
"name": "TABLE_VISIBLE_EXTENT",
"layerId": "1018_5",
"mode": "InExtent",
"fields": [
"OBJECTID",
"KGNR_C",
"BAUDATUM",
"UMFANG",
"FLAECHE"
]
},
{
"name": "TABLE_VISIBLE_EXTENT_SELECTED",
"layerId": "1018_5",
"mode": "SelectedInExtent",
"fields": [
"OBJECTID",
"KGNR_C",
"BAUDATUM",
"UMFANG",
"FLAECHE"
]
}
],
"pages": [
{
"rotation": -6.499346279777044,
"scale": 1128.497176,
"centerX": 1718120.5820149411,
"centerY": 5953613.82379552
},
{
"rotation": -6.499346279593618,
"scale": 1128.497176,
"centerX": 1718407.7663663635,
"centerY": 5953646.541000113
},
{
"rotation": -15.820888569887048,
"scale": 1128.497176,
"centerX": 1718657.8381641852,
"centerY": 5953695.875679197
},
{
"rotation": -55.03313272987185,
"scale": 1128.497176,
"centerX": 1718768.0108640224,
"centerY": 5953774.249536896
},
{
"rotation": -69.51766546326941,
"scale": 1128.497176,
"centerX": 1718877.4480515067,
"centerY": 5953982.479378451
}
],
"pageCover": {
"visible": true,
"dynamicElements": [
{
"type": "string",
"value": "Demonstration [My Cover Title]",
"name": "title_value"
}
]
},
"pageOverview": {
"visible": true,
"geometry": [
[
1718120.582014941,
5953613.82379552
],
[
1718781.0457124675,
5953689.066495238
],
[
1718896.8955834622,
5954027.061479687
]
],
"pageGraphics": {
"colorStroke": [
255,
204,
0,
100
],
"colorFill": [
255,
204,
0,
20
]
},
"pageGraphicsOverlap": {
"visibleFill": true,
"colorFill": [
0,
255,
0,
50
]
},
"pageGraphicsIndex": {
"visibleStroke": true,
"colorStroke": [
0,
0,
255,
80
],
"visibleAnnotation": true,
"colorAnnotation": [
0,
0,
255,
80
]
}
},
"pageLegend": {
"visible": true,
"layerCompositeExport": true
}
}
Sample - Request Parameter :: 'Additional_Web_Maps_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">Spatial Time Range Series Print</SPAN></P></DIV></DIV>
[
{
"name": "OVERVIEW",
"Map_As_JSON": {
"mapOptions": {
"extent": {
"xmin": 1716811,
"ymin": 5952194,
"xmax": 1719911,
"ymax": 5955256,
"spatialReference": {
"wkid": 3857
}
},
"scale": 69940.61215166743,
"showAttribution": false
},
"exportOptions": {
"dpi": 288
},
"operationalLayers": [
{
"url": "https://tiles.arcgis.com/tiles/p3UBboyC0NH1uCie/arcgis/rest/services/Overview_3857/MapServer",
"opacity": 1,
"visibility": true,
"id": "1020",
"title": "Overview",
"layerType": "ArcGISTiledMapServiceLayer"
},
{
"id": "Basemap_OSM",
"title": "Basemap OSM",
"visibility": false,
"type": "OpenStreetMap"
}
]
}
},
{
"name": "WEBMAP_MAP_FRAME_PAGE_OVERVIEW",
"Map_As_JSON": {
"mapOptions": {
"extent": {
"xmin": 1717832.151666021,
"ymin": 5953215.5152184395,
"xmax": 1718715.9548055683,
"ymax": 5954227.111514651,
"spatialReference": {
"wkid": 3857
}
},
"scale": 4513.988705381368,
"rotation": 0,
"showAttribution": false,
"time": [
-11481527121000,
1293836400000
],
"rangeOptions": {
"operationalLayers": [
{
"id": "1018_55",
"field": "UMFANG"
}
]
}
},
"operationalLayers": [
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/arcgis/rest/services/Buildings_3857/FeatureServer/18",
"opacity": 1,
"visibility": true,
"id": "1018_55",
"title": "Buildings",
"layerType": "ArcGISFeatureLayer"
}
],
"baseMap": {
"title": "Basemap Overview Page",
"baseMapLayers": [
{
"url": "https://tiles.arcgis.com/tiles/p3UBboyC0NH1uCie/arcgis/rest/services/Orthophoto_2011_3857/MapServer",
"opacity": 0.3,
"visibility": true,
"id": "1020",
"title": "Orthophoto",
"layerType": "ArcGISTiledMapServiceLayer"
}
]
},
"exportOptions": {
"dpi": 288
}
}
}
]
Sample - Request Parameter - Map Book :: 'Web_Map_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><P><SPAN STYLE="font-style:italic;">Seamless Polyline Time Range Series Print</SPAN></P></DIV></DIV>
{
"mapBook": {
"name": "Map Book :: Austria",
"content": [
{
"description": "Vienna Seamless Polyline Time-Range",
"layoutRefs": ["2f0819f2e73f411a93f6eb36ab916b69"],
"mapId": "490f7764c7e211edafa10242ac120002",
"mapFrame": {
"Map_As_JSON": {
"mapOptions": {
"extent": {
"xmin": 2642.9852002370676,
"ymin": 341142.8007290873,
"xmax": 2691.9352002370674,
"ymax": 341198.8132290873,
"spatialReference": {
"wkid": 31256
}
},
"scale": 10000,
"rotation": 0,
"time": [
1319500800000,
1575451880000
],
"rangeOptions": {
"operationalLayers": [
{
"id": "Vienna_Construction_Blocks_Hosted_31256",
"field": "BEZNR"
},
{
"id": "Vienna_Power_Lines_Hosted_31256",
"field": "STATUS"
}
]
}
},
"operationalLayers": [
{
"id": "Vienna_Borders_Hosted_31256",
"itemId": "16d800a0ffa6471a8aa39b4dcb1d8321",
"title": "Vienna Districts",
"visibility": true,
"opacity": 0.3,
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/Vienna%20Borders%20SHP%2031256/FeatureServer/0",
"layerType": "ArcGISFeatureLayer",
"layerDefinition": {
"definitionExpression": "BEZNR IN (1,2,3,4,5,6,7,8,9)",
"objectIds": []
},
"selectionObjectIds": [],
"selectionSymbol": {
"outline": {
"style": "esriSLSSolid",
"width": 1.5,
"color": [
0,
255,
255,
255
],
"type": "esriSLS"
},
"style": "esriSFSDiagonalCross",
"width": 1,
"angle": 0,
"color": [
0,
255,
255,
217
],
"type": "esriSFS"
}
},
{
"visibleLayers": [
6
],
"url": "https://vw-dev-qa-vgs.int.vertigis.com/server/rest/services/Layer_Vienna/Construction_Blocks/MapServer",
"opacity": 0.5,
"visibility": true,
"id": "Vienna_Construction_Blocks_Hosted_31256_dynamic",
"itemId": "1272fdfdc3064763bd5bdf9fc31358f1",
"title": "Vienna Construction Blocks (dynamic)",
"layerType": "ArcGISMapServiceLayer"
},
{
"visibleLayers": [
2
],
"url": "https://vw-dev-qa-vgs.int.vertigis.com/server/rest/services/Layer_Vienna/Power_Lines/MapServer",
"opacity": 0.5,
"visibility": true,
"id": "Vienna_Power_Lines_Hosted_31256_dynamic",
"itemId": "360b9a253e03417cadb06f62589d0d91",
"title": "Vienna Power Lines (dynamic)",
"layerType": "ArcGISMapServiceLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/ConstructionBlocks_31256/FeatureServer/0",
"opacity": 1,
"visibility": true,
"id": "Vienna_Construction_Blocks_Hosted_31256",
"title": "Vienna Construction Blocks",
"layerType": "ArcGISFeatureLayer"
},
{
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/PowerLines_31256/FeatureServer/0",
"opacity": 1,
"visibility": true,
"id": "Vienna_Power_Lines_Hosted_31256",
"title": "Vienna Power Lines",
"layerType": "ArcGISFeatureLayer"
}
],
"baseMap" : {
"title" : "Vienna Basemap",
"baseMapLayers" : [
{
"id": "Basemap_Vienna_WMTS_Web_Tiled_Neu",
"title": "Basemap Vienna WMTS (tiled OGC WMTS Map Image Layer)",
"visibility": true,
"opacity": 1,
"type": "WMTS",
"layerType": "WebTiledLayer",
"tileInfo": {
"spatialReference": {
"wkid": 31256
}
},
"wmtsInfo": {
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto",
"layerIdentifier": "bmaporthofoto",
"tileMatrixSet": "31256"
},
"templateUrl": "https://mapsneu.wien.gv.at/basemap/bmaporthofoto/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png",
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto"
}
]
},
"exportOptions": {
"dpi": 288
},
"layoutOptions": {
"customTextElements": [
{
"syn_crs_caption": "CRS:"
},
{
"scale_caption": "Scale"
},
{
"scale_caption_ov": "Scale OV"
},
{
"createdat_caption": "Created"
},
{
"creator_caption": "Author"
},
{
"creator_value": "VERTIGIS\\n.author"
},
{
"creator_description": "My Information"
},
{
"title_value": "Demonstration (Web Server)"
},
{
"orgname_value": "VertiGIS GmbH"
},
{
"disclaimer_value": "My Disclaimer Text"
}
],
"legendOptions": {
"operationalLayers": [
{
"id": "Vienna_Construction_Blocks_Hosted_31256"
},
{
"id": "Vienna_Power_Lines_Hosted_31256"
},
{
"id": "Vienna_Borders_Hosted_31256"
}
]
}
}
}
}
}
]
}
}
Sample - Request Parameter - Map Book :: 'Additional_Settings_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Seamless Polyline Time Range Series Print</SPAN></P></DIV></DIV></DIV>
{
"mapBook": {
"authentication": {
"anonymous": false,
"portal_url": "https://myhost.mysubdomain/portal",
"token": "Bx3nndfpBmK4g73oG7iOS7OtQIGgAprKaN-Qf6kOlAwmsi1nwrw4dyiDD18jtpdi5W_azbmmHZXL6Y9VDdLDEV86UI8XWNN-Z1c-j1-ikASeYj0hMzgTJfOUur5DcFwrKKvuUBDjI8ZzuPqaF4xYZvjYXcZeOlog652aXsJpPwU.",
"referer": "nbweingartner.int.vertigis.com"
},
"security": {
"outputPassword": ""
},
"content": [
{
"description": "Additional Settings :: Vienna Seamless Polyline Time-Range",
"layoutRef": "2f0819f2e73f411a93f6eb36ab916b69",
"mapRef": "490f7764c7e211edafa10242ac120002",
"Settings_As_JSON": {
"version": "0.1",
"selection": [
{
"oidList": [
5649,
7639,
6782,
5727,
119,
7073,
2521,
6453,
1668,
9565,
3099,
6720,
6322,
6200,
3789,
2434,
6951,
7373,
8081
],
"layerId": "Vienna_Construction_Blocks_Hosted_31256"
},
{
"oidList": [
2685
],
"layerId": "Vienna_Transport_Hosted_31256"
}
],
"seamless": {
"scale": 1200,
"geometry": [
[
2097.5,
341630.7
],
[
2651.1,
341174.3
]
],
"spatialReference": {
"wkid": 31256
}
},
"timeSeries": {
"maxCount": 15,
"timeZone": {
"utcOffset": 1,
"name": "W. Europe Standard Time"
},
"datetimePattern": "dd.MM.yyyy hh:mm",
"times": [
[
1319500800000,
1325376000000
],
[
1319500800000,
1356998400000
],
[
1319500800000,
1388534400000
]
]
},
"rangeSeries": {
"ranges": [
{
"start": 1,
"end": 1,
"includeStart": true,
"includeEnd": false
}
]
},
"pageCover": {
"layoutRef": "0d96f8d53e7e4a7c92f037e84f45c787",
"visible": true,
"dynamicElements": [
{
"type": "string",
"value": "Map Book :: A3 Portrait\nVienna Seamless Polyline Time-Range",
"name": "title_value"
}
]
},
"pageOverview": {
"layoutRef": "e834ee4817f246a9b08bf3463d0057ae",
"visible": true,
"pageGraphics": {
"colorStroke": [
255,
0,
0,
80
],
"colorFill": [
255,
0,
0,
20
]
}
},
"pageLegend": {
"layoutRef": "f67b8928b8c44ff5a7eaecbc26a43c07",
"visible": true
}
}
}
]
}
}
Sample - Request Parameter - Map Book :: 'Additional_Web_Maps_as_JSON'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Seamless Polyline Time Range Series Print</SPAN></P></DIV></DIV></DIV>
{
"mapBook": {
"content": [
{
"description": "Additional Maps :: Vienna Seamless Polyline Time-Range",
"layoutRef": "2f0819f2e73f411a93f6eb36ab916b69",
"mapRefs": ["490f7764c7e211edafa10242ac120002"],
"mapFrames": [
{
"name": "OVERVIEW",
"Map_As_JSON": {
"mapOptions": {
"extent": {
"xmin": 2642.9852002370676,
"ymin": 341142.8007290873,
"xmax": 2691.9352002370674,
"ymax": 341198.8132290873,
"spatialReference": {
"wkid": 31256
}
},
"scale": 120000,
"rotation": 0
},
"operationalLayers": [],
"baseMap" : {
"title" : "Vienna Basemap",
"baseMapLayers" : [
{
"id": "Basemap_Vienna_WMTS_Web_Tiled_Neu",
"title": "Basemap Vienna WMTS (tiled OGC WMTS Map Image Layer)",
"visibility": true,
"opacity": 1,
"type": "WMTS",
"layerType": "WebTiledLayer",
"tileInfo": {
"spatialReference": {
"wkid": 31256
}
},
"wmtsInfo": {
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto",
"layerIdentifier": "bmaporthofoto",
"tileMatrixSet": "31256"
},
"templateUrl": "https://mapsneu.wien.gv.at/basemap/bmaporthofoto/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png",
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto"
}
]
},
"exportOptions": {
"dpi": 288
}
}
},
{
"name": "WEBMAP_MAP_FRAME_PAGE_OVERVIEW",
"Map_As_JSON": {
"mapOptions": {
"extent": {
"xmin": 2642.9852002370676,
"ymin": 341142.8007290873,
"xmax": 2691.9352002370674,
"ymax": 341198.8132290873,
"spatialReference": {
"wkid": 31256
}
},
"scale": 7500,
"rotation": 0,
"time": [
1319500800000,
1575451880000
],
"rangeOptions": {
"operationalLayers": [
{
"id": "Vienna_Construction_Blocks_Hosted_31256",
"field": "BEZNR"
},
{
"id": "Vienna_Power_Lines_Hosted_31256",
"field": "STATUS"
}
]
}
},
"operationalLayers": [
{
"id": "Vienna_Construction_Blocks_Hosted_31256",
"itemId": "88b7da4aa4b34a348819ce44aef921ad",
"title": "Vienna Construction Blocks",
"visibility": true,
"opacity": 1,
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/arcgis/rest/services/ConstructionBlocks_31256/FeatureServer/0",
"layerType": "ArcGISFeatureLayer"
},
{
"id": "Vienna_Power_Lines_Hosted_31256",
"itemId": "636757af90954f97b0f19c37de4ed38d",
"title": "Vienna Power Lines",
"visibility": true,
"opacity": 1,
"url": "https://services.arcgis.com/p3UBboyC0NH1uCie/ArcGIS/rest/services/PowerLines_31256/FeatureServer/0",
"layerType": "ArcGISFeatureLayer"
}
],
"baseMap" : {
"title" : "Vienna Basemap",
"baseMapLayers" : [
{
"id": "Basemap_Vienna_WMTS_Web_Tiled_Neu",
"title": "Basemap Vienna WMTS (tiled OGC WMTS Map Image Layer)",
"visibility": true,
"opacity": 1,
"type": "WMTS",
"layerType": "WebTiledLayer",
"tileInfo": {
"spatialReference": {
"wkid": 31256
}
},
"wmtsInfo": {
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto",
"layerIdentifier": "bmaporthofoto",
"tileMatrixSet": "31256"
},
"templateUrl": "https://mapsneu.wien.gv.at/basemap/bmaporthofoto/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png",
"url": "https://mapsneu.wien.gv.at/basemap31256neu/1.0.0/WMTSCapabilities.xml?layer=bmaporthofoto"
}
]
},
"exportOptions": {
"dpi": 288
}
}
}
]
}
]
}
}
Sample - Response Parameter :: 'Output_File'
<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Print Output URL</SPAN></P></DIV></DIV></DIV>
{
"url": "https://myhost.mydomain.com/server/rest/directories/arcgisjobs/vertigis_utilities/vertigis_printing_tools_gpserver/j8af4c332adbb4b1c936bbd47d0afffc1/scratch/_EXP_eacffc4744bc40b6a3db6262cff7d37e.pdf"
}
VertiGIS, Printing
Copyright 2023, VertiGIS GmbH
There are no use limitations for this item.