Task Request Schema :: Parameter: 'Additional_Settings_as

20200730 08314900 1.0 TRUE 20260119 120505 150000000 5000 ItemDescription withheld <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>When checked, additional Layout Properties will be returned for each Layout (e.g. custom Picture Elements, additional Map Frames, etc.). Default is False.</SPAN></P></DIV></DIV></DIV> <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Additional Settings as JSON. Default is {}. See Task Request Schema.</SPAN></P></DIV></DIV></DIV>

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Fetches the Information for available Layout Templates refered by a registered Layout Folder Datastore or by ArcGIS AGOL / Enterprise Portal Items.</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></DIV></DIV></DIV> Task Request Schema :: Parameter: 'Additional_Settings_as_JSON'

{
  "$schema": "http://json-schema.org/schema",
  "$id": "https://vertigis.com/print-request-param-settings-additional.schema.json",
  "title": "Additional Settings Layout Parameter Schema",
  "description": "Additional Request Parameters Schema for Layout Infos.",
  "type": "object",
  "properties": {
    "version": {
      "description": "(optional) Request Parameter Schema Version.",
      "type": "string",
      "default": "0.1"
    },
    "portal_layout_items": {
      "description": "(optional) Portal Layout Items to fetch Information from.",
      "type": "object",
      "properties": {
        "authentication": {
          "description": "Authentication Information for Access to an ArcGIS Online / ArcGIS Enterprise Organization.",
          "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"
          ]
        },
        "ids": {
          "description": "List of VGS Layout or VGS Layout Package Item IDs.",
          "type": "array",
          "minItems": 0,
          "items": [
            {
              "description": "VGS Layout or VGS Layout Package Item ID.",
              "type": "string"
            }
          ]
        }
      },
      "required": [
        "authentication",
        "ids"
      ]
    }
  }
}

<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/layout-templates-info-response.schema.json",
  "title": "Layout Templates Info Response Schema",
  "type": "object",
  "properties": {
    "results": {
      "description": "Layout Templates 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 according to the ESRI Layout Template Information Specification: https://pro.arcgis.com/en/pro-app/latest/tool-reference/server/get-layout-templates-info.htm.",
              "type": "array",
              "minItems": 0,
              "items": [
                {
                  "description": "Layout Template Information. If Task is requested with Parameter 'Return_Additional_Info' = true, the Layout Information might contain additional Properties, not available in the ESRI Standard. See Print Documentation for more Information.",
                  "type": "object",
                  "properties": {
                    "layoutTemplate": {
                      "description": "Name of the Layout.",
                      "type": "string"
                    },
                    "pageSize": {
                      "description": "Page Size.",
                      "type": "array",
                      "items": [
                        {
                          "description": "Page Width.",
                          "type": "number"
                        },
                        {
                          "description": "Page Height.",
                          "type": "number"
                        }
                      ]
                    },
                    "pageUnits": {
                      "description": "Page Units.",
                      "type": "string"
                    },
                    "webMapFrameSize": {
                      "description": "Size of the Map Frame. If there are multiple Map Frames on the Layout, it returns Information only for the Map Frame that is named 'WEBMAP_MAP_FRAME'.",
                      "type": "array",
                      "items": [
                        {
                          "description": "Map Frame Width.",
                          "type": "number"
                        },
                        {
                          "description": "Map Frame Height.",
                          "type": "number"
                        }
                      ]
                    },
                    "layoutOptions": {
                      "description": "Further Layout Information.",
                      "type": "object",
                      "properties": {
                        "hasTitleText": {
                          "description": "Whether a predefined Title Text is available.",
                          "type": "boolean"
                        },
                        "hasAuthorText": {
                          "description": "Whether a predefined Author Text is available.",
                          "type": "boolean"
                        },
                        "hasCopyrightText": {
                          "description": "Whether a predefined Copyright Text is available.",
                          "type": "boolean"
                        },
                        "hasLegend": {
                          "description": "Whether a Legend Element is available.",
                          "type": "boolean"
                        },
                        "customTextElements": {
                          "description": "List of available Custom Text Elements. See Print Documentation for more Information on Custom Text Elements.",
                          "type": "array",
                          "minItems": 0,
                          "items": [
                            {
                              "description": "Custom Text Element.",
                              "type": "object",
                              "properties": {
                                "<element_name>": {
                                  "description": "Default Value of the Element.",
                                  "type": "string"
                                }
                              },
                              "required": [
                                "<element_name>"
                              ]
                            }
                          ]
                        },
                        "customPictureElements": {
                          "description": "[non-ESRI Property] List of available Custom Picture Elements. See Print Documentation for more Information on Custom Picture Elements.",
                          "type": "array",
                          "minItems": 0,
                          "items": [
                            {
                              "description": "Custom Picture Element.",
                              "type": "object",
                              "properties": {
                                "<element_name>": {
                                  "description": "Value of the Element.",
                                  "type": "object",
                                  "properties": {
                                    "value": {
                                      "description": "Default Value of the Element.",
                                      "type": "string"
                                    },
                                    "elementSize": {
                                      "description": "Width and Height of the Element in Page Units.",
                                      "type": "array",
                                      "minItems": 2,
                                      "maxItems": 2,
                                      "items": [
                                        {
                                          "description": "Value.",
                                          "type": "number"
                                        }
                                      ]
                                    }
                                  },
                                  "required": [
                                    "value",
                                    "elementSize"
                                  ]
                                }
                              },
                              "required": [
                                "<element_name>"
                              ]
                            }
                          ]
                        }
                      },
                      "required": [
                        "hasTitleText",
                        "hasAuthorText",
                        "hasCopyrightText",
                        "hasLegend"
                      ]
                    },
                    "webMapFrameElements": {
                      "description": "[non-ESRI Property] Further Map Frame Information.",
                      "type": "array",
                      "minItems": 0,
                      "items": [
                        {
                          "description": "Map Frame Information.",
                          "type": "object",
                          "properties": {
                            "name": {
                              "description": "Name of the Map Frame.",
                              "type": "string"
                            },
                            "elementSize": {
                              "description": "Width and Height of the Element in Page Units.",
                              "type": "array",
                              "minItems": 2,
                              "maxItems": 2,
                              "items": [
                                {
                                  "description": "Value.",
                                  "type": "number"
                                }
                              ]
                            }
                          },
                          "required": [
                            "name",
                            "elementSize"
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "layoutTemplate",
                    "pageSize",
                    "pageUnits",
                    "layoutOptions"
                  ]
                }
              ]
            }
          },
          "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 :: 'Additional_Settings_as_JSON'

{
  "version": "0.1",
  "portal_layout_items": {
    "authentication": {
      "anonymous": false,
      "portal_url": "https://arcgis.com",
      "token": "11ywROwE4fybvSp-3XagNqqWzASjuFqxKgyi2dwO7P6GMvV7ZGXZzXITV7fYHoU2VJ5okZYvD7W5oEwN1Q76XoCfqdh4UwFQiR2Hl2gLevaL5JTdL6t7vV1wTz4hJ85_HJRKA1R6OIferzH_3qqKj_eBS3Dwcmd6IFIzuCyFRjPUa1ORJ86fKt28mEXRyaOutg7E1zp-PiSgR8wmxoGFVg..",
      "referer": "nbweingartner.int.vertigis.com"
    },
    "ids": [
      "vglay_5d9948fa5a91494c849dcc2c9adcae3b",
      "vglay_ce083eee14b549e0954004800dc33f03",
      "vglay_918e1f1bdeed4fc5994b44d6a1990dcc",
      "vglay_510fa17ab23846b2a40767a8e2364f72"
    ]
  }
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Layout Template Infos for specific ArcGIS Online VGS Layout Portal Items</SPAN></P></DIV></DIV></DIV> Sample - Request Parameter :: 'Additional_Settings_as_JSON'

{
  "version": "0.1",
  "portal_layout_items": {
    "authentication": {
      "anonymous": false,
      "portal_url": "https://arcgis.com",
      "token": "_IguTGHFQiSHfX7GhVtMf01_X5UcQcAf9PlMK-NUgHeHyzBUndwsbVd_WL_qV2exVXroNPjSsEH87DeHrYn3Df-ql7HpJokEPvQnuVXgAOm6kW-bvdp9wb8txzUAAxLFn5YPmjt_gpObNFxGqDtq8-hc8dCLZYD8Fmn57-RH9xA4ux3uBMkNbk-iQXaReSehCDVIPOv4zHpVFEG9qe7opQ..",
      "referer": "nbweingartner.int.vertigis.com"
    },
    "ids": [
      "vglaypk_c144ee9a948a4f6283f6c9cca5ba11e4"
    ]
  }
}

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Layout Template Infos for specific ArcGIS Online VGS Layout Package Portal Item</SPAN></P></DIV></DIV></DIV> Sample - Response Parameter :: 'Output_JSON'

[
{
    "layoutTemplate": "fdbed030b6bc433e8387b91adae7d06a",
    "portalItem": {
      "id": "fdbed030b6bc433e8387b91adae7d06a",
      "home": "https://Latitudegeo.maps.arcgis.com/home/item.html?id=fdbed030b6bc433e8387b91adae7d06a",
      "name": "36482b8e4cd74b8fa1ab213d2ce1e472.pagx",
      "title": "VGS A3 Portrait Default 01",
      "description": "A3 Portrait Layout with metric Units",
      "vgsId": "5d9948fa5a91494c849dcc2c9adcae3b",
      "vgsLayoutPackageRefs": [
        "c144ee9a948a4f6283f6c9cca5ba11e4"
      ],
      "vgsPrintPageType": "DEFAULT",
      "vgsPrintRequestTypes": [
        "DEFAULT",
        "LINE",
        "GRID",
        "TIME_SERIES",
        "RANGE_SERIES"
      ]
    },
    "pageSize": [
      297.0,
      420.0
    ],
    "pageUnits": "MILLIMETER",
    "webMapFrameSize": [
      256.13,
      362.0
    ],
    "layoutOptions": {
      "hasTitleText": false,
      "hasAuthorText": false,
      "hasCopyrightText": false,
      "hasLegend": false,
      "customTextElements": [
        {
          "vglay_id": "<vglay_id>"
        },
        {
          "vglay_default_ref": "<vglay_default_ref>"
        },
        {
          "time_caption": "<time_caption>"
        },
        {
          "time_value": "<time_value>"
        },
        {
          "range_caption": "<range_caption>"
        },
        {
          "range_value": "<range_value>"
        },
        {
          "syn_crs": "<syn_crs>"
        },
        {
          "scale_value": "<scale_value>"
        },
        {
          "scale_caption": "<scale_caption>"
        },
        {
          "scale_value_ov": "<scale_value_ov>"
        },
        {
          "scale_caption_ov": "<scale_caption_ov>"
        },
        {
          "orgadr_value": "Wilhelm-Greil-Straße 17,\nA-6020 Innsbruck"
        },
        {
          "orgname_value": "<orgname_value>"
        },
        {
          "title_value": "<title_value>"
        },
        {
          "syn_index": "<syn_index>"
        },
        {
          "creator_description": "<creator_description>"
        },
        {
          "creator_value": "<creator_value>"
        },
        {
          "creator_caption": "<creator_caption>"
        },
        {
          "createdat_value": "<createdat_value>"
        },
        {
          "createdat_caption": "<createdat_caption>"
        },
        {
          "disclaimer_value": "<disclaimer_value>"
        }
      ],
      "customPictureElements": [
        {
          "company_logo": {
            "value": "C:VertiGIS-Logo-Color.jpg",
 
           "elementSize": [
              30.0,
              15.0
            ]
          }
        }
      ]
    },
    "webMapFrameElements": [
      {
        "name": "OVERVIEW",
        "elementSize": [
          74.0,
          30.52
        ]
      },
      {
        "name": "WEBMAP_MAP_FRAME",
        "elementSize": [
          256.13,
          362.0
        ]
      }
    ]
  },
{
    "layoutTemplate": "728e2ca1e2fb4db6a8012a8c5745b077",
    "portalItem": {
      "id": "728e2ca1e2fb4db6a8012a8c5745b077",
      "home": "https://Latitudegeo.maps.arcgis.com/home/item.html?id=728e2ca1e2fb4db6a8012a8c5745b077",
      "name": "582a77bf872740959b805a57f3234d59.pagx",
      "title": "VGS A3 Portrait Cover 01",
      "description": "A3 Portrait Cover Layout in metric Units",
      "vgsId": "ce083eee14b549e0954004800dc33f03",
      "vgsLayoutPackageRefs": [
        "c144ee9a948a4f6283f6c9cca5ba11e4",
        "6ecf4a0129104b33b00ed12d0e518635",
        "ad90e99a954847f2ad25c1eeaa011756"
      ],
      "vgsPrintPageType": "COVER",
      "vgsPrintRequestTypes": [
        "DEFAULT",
        "LINE",
        "GRID",
        "INFINITE",
        "TIME_SERIES",
        "RANGE_SERIES"
      ]
    },
    "pageSize": [
      297.0,
      420.0
    ],
    "pageUnits": "MILLIMETER",
    "layoutOptions": {
      "hasTitleText": false,
      "hasAuthorText": false,
      "hasCopyrightText": false,
      "hasLegend": false,
      "customTextElements": [
        {
          "vglay_id": "<vglay_id>"
        },
        {
          "vglay_default_ref": "<vglay_id>"
        },
        {
          "title_value": "DEMONSTRATION\nA3 PORTRAIT COVER PAGE"
        },
        {
          "orgadr_value": "Wilhelm-Greil-Straße 17,\nA-6020 Innsbruck"
        },
        {
          "orgname_value": "<orgname_value>"
        },
        {
          "syn_index": "<syn_index>"
        },
        {
          "creator_description": "<creator_description>"
        },
        {
          "creator_value": "<creator_value>"
        },
        {
          "creator_caption": "<creator_caption>"
        },
        {
          "createdat_value": "<createdat_value>"
        },
        {
          "createdat_caption": "<createdat_caption>"
        },
        {
          "disclaimer_value": "<disclaimer_value>"
        }
      ],
      "customPictureElements": [
        {
          "company_logo": {
            "value": "C:VertiGIS-Logo-Color.jpg",
 
           "elementSize": [
              30.0,
              15.0
            ]
          }
        }
      ]
    }
  }
]

<DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN STYLE="font-style:italic;">Extended Layout Templates Infos for Portal Layout Items</SPAN></P></DIV></DIV></DIV> Get Layout Templates Info Task VertiGIS Printing Layout Template Copyright 2023, VertiGIS GmbH ArcToolbox Tool 20230814