Task Request Schema :: Parameter: 'Request

20200730 08311500 1.0 TRUE 20250616 123614 150000000 5000 ItemDescription withheld <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Request as JSON. Default is {}. See Task Request Schema.</SPAN></P></DIV></DIV></DIV>

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Calculcates the Page Centerpoint Scales or Extents along specific Polylines and optionally projects Page Extents between different Spatial References.</SPAN></P></DIV></DIV></DIV>

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Specify a registered Layout Folder Datastore if Layout Templates are locally hosted and the mandatory Task Parameters before submit.</SPAN></P><P><SPAN /></P></DIV></DIV></DIV> Task Request Schema :: Parameter: 'Request_JSON'

{
  "$schema": "http://json-schema.org/schema",
  "$id": "https://vertigis.com/index-info-request-param.schema.json",
  "title": "Index Info Request Parameter Schema.",
  "description": "Index Info Request Parameter Schema for Requests of Calculation of Pages Properties. Used by Clients to determine the printable Map Frame Extent of Pages for an Index Line or for an Array of Center Point Scales.",
  "type": "object",
  "properties": {
    "version": {
      "description": "Request Parameter Schema Version.",
      "type": "string",
      "default": "0.1"
    },
    "maxPages": {
      "description": "(optional) Maximum count of Page Properties Calculations.",
      "type": "integer",
      "default": 10,
      "minimum": 1
    },
    "centerPointScales": {
      "description": "Center Point Scales. An Array of Center Point Scales according to the ESRI Specification.",
      "type": "array",
      "minItems": 1,
      "items": [
        {
          "description": "Center Point Scale.",
          "type": "object",
          "properties": {
            "rotation": {
              "description": "Rotation in Degree.",
              "type": "number",
              "default": 0.0
            },
            "scale": {
              "description": "Scale.",
              "type": "number",
              "default": 1000.0
            },
            "centerX": {
              "description": "Center Point X-Coordinate.",
              "type": "number"
            },
            "centerY": {
              "description": "Center Point Y-Coordinate.",
              "type": "number"
            }
          },
          "required": [
            "centerX",
            "centerY"
          ]
        }
      ]
    },
    "geometry": {
      "description": "Index Line 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"
        }
      ]
    },
    "method": {
      "description": "(optional) Method used for Calculation of Pages Properties if an Index Line is defined. DEFAULT: 'Creates a Series of Rectangles of given Width and Height, which are connected by the Midpoints of their left / right Sides, and all these side-Points lying on the Polyline, beginning with Polyline's first Point as first Rectangle Midpoint. Ensures that the Polyline is completely contained' :: DIAGONAL: 'Creates a Series of Rectangles of given Width and Height, which are connected by the upper / lower Points of their left / right Sides, depending on which of both is overlapping the previous Rectangle, and all right-side-Points lying on the Polyline, beginning with Polyline's first Point as first Rectangle Midpoint'.",
      "type": "string",
      "default": "DEFAULT"
    },
    "layout": {
      "description": "(DEPRECATED) Client should send 'pageUnits' and 'mapFrameSize' explicitly. The Name of the Layout to fetch the Web Map Frame Size and Page Units from.",
      "type": "string"
    },
    "scale": {
      "description": "Scale used for Calculation of Pages Properties if an Index Line is defined.",
      "type": "number",
      "default": 1000.0,
      "minimum": 1.0
    },
    "pageUnits": {
      "description": "Page Units in the Print Layout Template used for Calculation of Pages Properties.",
      "type": "string"
    },
    "mapFrameSize": {
      "description": "Map Frame Size in the Print Layout Template used for Calculation of Pages Properties.",
      "type": "array",
      "items": [
        {
          "description": "Width of the Map Frame.",
          "type": "number"
        },
        {
          "description": "Height of the Map Frame.",
          "type": "number"
        }
      ]
    },
    "overlapping": {
      "description": "(optional) Page Overlapping in Percent of the Page Width. Only used if an Index Line with Calculation Method DEFAULT is defined.",
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "maximum": 100
    },
    "errorOnIndexLineNotFullyCovered": {
      "description": "(optional) Flag whether to cause an Error while Calculation, if the Index Line Geometry can not be fully covered. Only used if an Index Line with Calculation Method DEFAULT is defined.",
      "type": "boolean",
      "default": false
    },
    "spatialReference": {
      "description": "Input Spatial Reference used for Calculation of Pages Properties. ESRI Spatial Reference Specification.",
      "type": "object",
      "properties": {
        "wkid": {
          "description": "Spatial Reference WKID.",
          "type": "integer",
          "default": 102100
        }
      },
      "required": [
        "wkid"
      ]
    },
    "spatialReferenceOut": {
      "description": "(optional) Output Spatial Reference used for Calculation of projected Pages Properties. ESRI Spatial Reference Specification.",
      "type": "object",
      "properties": {
        "wkid": {
          "description": "Spatial Reference WKID.",
          "type": "integer",
          "default": 102100
        }
      },
      "required": [
        "wkid"
      ]
    },
    "transformationName": {
      "description": "(optional) Transformation Name used for Calculation of projected Page Properties.",
      "type": "string"
    },
    "transformationString": {
      "description": "(optional) Transformation WKT String used for Calculation of projected Page Properties.",
      "type": "string"
    }
  },
  "required": [
  ]
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV></DIV> Task Response Schema

{
  "$schema": "http://json-schema.org/schema",
  "$id": "https://vertigis.com/index-info-response.schema.json",
  "title": "Index Info Response Schema.",
  "description": "Index Info Response Schema for Pages Properties Responses. Used by Clients to show the printable Map Frame Extent of Pages for an Index Line or for an Array of Center Point Scales.",
  "type": "object",
  "properties": {
    "results": {
      "description": "Index Info Results Output Parameters.",
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": [
        {
          "type": "object",
          "properties": {
            "paramName": {
              "description": "GP Process Output Parameter Name.",
              "type": "string"
            },
            "dataType": {
              "description": "GP Process Output Parameter Type.",
              "type": "string"
            },
            "value": {
              "description": "GP Process Output Parameter Value.",
              "type": "object",
              "properties": {
                "mapFrameSize": {
                  "description": "Map Frame Size.",
                  "type": "array",
                  "items": [
                    {
                      "description": "Width of the Map Frame.",
                      "type": "number"
                    },
                    {
                      "description": "Height of the Map Frame.",
                      "type": "number"
                    }
                  ]
                },
                "pages": {
                  "description": "The calculated Page Properties.",
                  "type": "array",
                  "minItems": 1,
                  "items": [
                    {
                      "type": "object",
                      "properties": {
                        "scale": {
                          "description": "Centerpoint Scale Page Scale.",
                          "type": "number"
                        },
                        "rotation": {
                          "description": "Centerpoint Scale Page Rotation in Degrees.",
                          "type": "number"
                        },
                        "centerX": {
                          "description": "Centerpoint Scale Center Point X-Coordinate if no Projection was performed.",
                          "type": "number"
                        },
                        "centerY": {
                          "description": "Centerpoint Scale Center Point Y-Coordinate if no Projection was performed.",
                          "type": "number"
                        },
                        "geometry": {
                          "description": "Reprojected Page Geometry in the Input Spatial Reference if Projection was performed. Geometry is a Polygon Ring Geometry according to the ESRI Specification.",
                          "type": "array",
                          "minItems": 5,
                          "items": [
                            {
                              "description": "X-Coordinate of the Point.",
                              "type": "number"
                            },
                            {
                              "description": "Y-Coordinate of the Point.",
                              "type": "number"
                            }
                          ]
                        },
                        "spatialReference": {
                          "description": "Input Spatial Reference if Projection was performed. ESRI Spatial Reference Specification.",
                          "type": "object",
                          "properties": {
                            "wkid": {
                              "description": "Spatial Reference WKID.",
                              "type": "integer"
                            }
                          },
                          "required": [
                            "wkid"
                          ]
                        },
                        "spatialReferenceOut": {
                          "description": "Output Spatial Reference if Projection was performed. ESRI Spatial Reference Specification.",
                          "type": "object",
                          "properties": {
                            "wkid": {
                              "description": "Spatial Reference WKID.",
                              "type": "integer"
                            }
                          },
                          "required": [
                            "wkid"
                          ]
                        },
                        "transformationName": {
                          "description": "(optional) Transformation Name if Projection was performed.",
                          "type": "string"
                        },
                        "transformationString": {
                          "description": "(optional) Transformation WKT String if Projection was performed.",
                          "type": "string"
                        }
                      }
                    }
                  ]
                },
                "maxPages": {
                  "description": "Actual count of calculated Page Properties.",
                  "type": "integer"
                }
              },
              "required": [
                "mapFrameSize",
                "pages",
                "maxPages"
              ]
            }
          },
          "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"
  ]
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">JSON Schema</SPAN></P></DIV></DIV></DIV> Sample - Request Parameter :: 'Request_JSON'

{
  "version": "0.1",
  "maxPages": 10,
  "geometry": [
    [
      2097.5,
      341630.7
    ],
    [
      2651.1,
      341174.3
    ],
    [
      2301.4,
      340517.5
    ]
  ],
  "method": "default",
  "scale": 2000,
  "pageUnits": "MILLIMETER",
  "mapFrameSize": [
    256.13,
    362
  ],
  "overlapping": 20,
  "spatialReference": {
    "wkid": 31256
  },
  "errorOnIndexLineNotFullyCovered": true
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Page Centerpoint Scale Calculation with DEFAULT Method</SPAN></P></DIV></DIV></DIV> Sample - Request Parameter :: 'Request_JSON'

{
  "version": "0.1",
  "maxPages": 10,
  "geometry": [
    [
      2097.5,
      341630.7
    ],
    [
      2651.1,
      341174.3
    ],
    [
      2301.4,
      340517.5
    ]
  ],
  "method": "diagonal",
  "layout": "A3_portrait_extended",
  "scale": 2000,
  "spatialReference": {
    "wkid": 31256
  },
  "spatialReferenceOut": {
    "wkid": 3857
  },
  "transformationName": "MGI_To_WGS_1984_3"
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Page Extent Calculation with DIAGONAL Method and SR Projection with local Layout Reference</SPAN></P></DIV></DIV></DIV> Sample - Response Parameter :: 'Output_JSON'

{
  "mapFrameSize": [
    512.2600000000001,
    724.0
  ],
  "maxPages": 6,
  "pages": [
    {
      "scale": 2000,
      "rotation": 39.50291935056474,
      "geometry": [
        [
          2119.2017614856327,
          341925.06566344295
        ],
        [
          2383.143685979735,
          341708.26661825087
        ],
        [
          2075.7969815153433,
          341336.3201360991
        ],
        [
          1811.8495524363811,
          341553.1474263286
        ],
        [
          2119.2017614856327,
          341925.06566344295
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    },
    {
      "scale": 2000,
      "rotation": 39.50291935055379,
      "geometry": [
        [
          2330.386419268252,
          341750.9617667338
        ],
        [
          2594.3444109977686,
          341534.16590215266
        ],
        [
          2287.00207676206,
          341162.1967791179
        ],
        [
          2023.0385802307442,
          341379.0208222866
        ],
        [
          2330.386419268252,
          341750.9617667338
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    },
    {
      "scale": 2000,
      "rotation": 39.502919350564405,
      "geometry": [
        [
          2541.571005671469,
          341576.85779454
        ],
        [
          2805.5450643054105,
          341360.0651765829
        ],
        [
          2498.2070995365634,
          340988.07334652636
        ],
        [
          2234.22753581201,
          341204.89427632093
        ],
        [
          2541.571005671469,
          341576.85779454
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    },
    {
      "scale": 2000,
      "rotation": 111.20620384167084,
      "geometry": [
        [
          2863.1416715587516,
          341139.7365096472
        ],
        [
          2739.5606412091465,
          340821.7661829721
        ],
        [
          2288.817345017453,
          340995.9311334314
        ],
        [
          2412.419616984798,
          341313.8820542367
        ],
        [
          2863.1416715587516,
          341139.7365096472
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    },
    {
      "scale": 2000,
      "rotation": 118.03217480317461,
      "geometry": [
        [
          2755.8702450589203,
          340856.8045100346
        ],
        [
          2595.245714898699,
          340555.7213629186
        ],
        [
          2168.4469679424856,
          340782.083931027
        ],
        [
          2329.087610590105,
          341083.14320602454
        ],
        [
          2755.8702450589203,
          340856.8045100346
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    },
    {
      "scale": 2000,
      "rotation": 118.03217480317512,
      "geometry": [
        [
          2627.2472800478604,
          340615.19739894476
        ],
        [
          2466.609236315519,
          340314.10522094276
        ],
        [
          2039.7975489160867,
          340540.4869255377
        ],
        [
          2200.4517719312107,
          340841.5552311875
        ],
        [
          2627.2472800478604,
          340615.19739894476
        ]
      ],
      "spatialReference": {
        "wkid": 31256
      },
      "spatialReferenceOut": {
        "wkid": 3857
      },
      "transformationName": "MGI_To_WGS_1984_3"
    }
  ]
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Calculated Page Extents for specific SR Projection</SPAN></P></DIV></DIV></DIV> Sample - Response Parameter :: 'Output_JSON'

{
  "mapFrameSize": [
    512.2600000000001,
    724.0
  ],
  "maxPages": 4,
  "pages": [
    {
      "scale": 2000,
      "rotation": 39.50291935055316,
      "centerX": 2097.499999999995,
      "centerY": 341630.7
    },
    {
      "scale": 2000,
      "rotation": 39.50291935056101,
      "centerX": 2413.704645130738,
      "centerY": 341370.01394501864
    },
    {
      "scale": 2000,
      "rotation": 103.80564555625634,
      "centerX": 2522.910901220769,
      "centerY": 341040.6864359742
    },
    {
      "scale": 2000,
      "rotation": 118.03217480317421,
      "centerX": 2377.716652344626,
      "centerY": 340660.83650917915
    }
  ]
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Calculated Page Centerpoint Scales</SPAN></P></DIV></DIV></DIV> Get Index Info Task VertiGIS Printing Index Copyright 2023, VertiGIS GmbH ArcToolbox Tool 20230414