Get Layout Templates Info Task

URL:
https://<catalog-url>/Utilities/PrintingTools/GPServer/Get Layout Templates Info Task
Methods:
GET
Version Introduced:
10.4

Description

This operation layout returns information about a print service layout. The response returns the size of the layout page and the size of the active data frame and shows whether the following layout elements are available:

  • Legend
  • Title text
  • Copyright text
  • Author text
  • Custom text elements

The layoutTemplate information returned by this operation can be plugged in to the Layout_Template parameter when using the Export Web Map operation.

New at 11.4

  • Returns dynamicLegends for legend element to indicate if dynamic legends on or off by default in a layout template.

New at 11.3

  • Supports portal items as layout templates. A print service must be federated to an enterprise portal.

New at 11.2

  • Supports returning dynamic text elements available on layout template.

Request parameters

ParameterDetails

f

The response format. The default response format is html .

Values: html | json | kmz

Layout_Item_ID

The portal ID (in JSON format) of the layout item, from the federated enterprise portal, that will be used for templates. Use the format: {"id": "<portal-id>"}.

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
{
  "results": [
    {
      "paramName": "Output_JSON",
      "dataType": "GPString",
      "value": [
        {
          "layoutTemplate": "A3 Landscape",
          "pageSize": [
            42.0,
            29.700000000000003
          ],
          "pageUnits": "CENTIMETER",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            40.0,
            21.17
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "A3 Portrait",
          "pageSize": [
            29.700000000000003,
            42.0
          ],
          "pageUnits": "CENTIMETER",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            27.68,
            33.45
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "A4 Landscape",
          "pageSize": [
            29.700000000000003,
            21.0
          ],
          "pageUnits": "CENTIMETER",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            27.76,
            15.92
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "A4 Portrait",
          "pageSize": [
            21.0,
            29.700000000000003
          ],
          "pageUnits": "CENTIMETER",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            19.02,
            22.28
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "Letter ANSI A Landscape",
          "pageSize": [
            11.0,
            8.5
          ],
          "pageUnits": "INCH",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            10.0,
            6.25
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "Letter ANSI A Portrait",
          "pageSize": [
            8.5,
            11.0
          ],
          "pageUnits": "INCH",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            7.5,
            8.0
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "Tabloid ANSI B Landscape",
          "pageSize": [
            17.0,
            11.0
          ],
          "pageUnits": "INCH",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            16.0,
            7.76
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": true,
            "hasLegend": true,
            "customTextElements": []
          }
        },
        {
          "layoutTemplate": "Tabloid ANSI B Portrait",
          "pageSize": [
            11.0,
            17.0
          ],
          "pageUnits": "INCH",  //introduced at 10.6
          "webMapFrameSize": [  //Previously named activeDataFrameSize
            10.0,
            13.61
          ],
          "layoutOptions": {
            "hasTitleText": true,
            "hasAuthorText": true,
            "hasCopyrightText": false,
            "hasLegend": true,
            "customTextElements": [],
            "mapSurroundInfos": [
              {
                "name": "Legend",
                "type": "CIMLegend",
                "visible": true,
                "defaultLegendItem": {
                    "dynamicLegends": true
                  }
              },
              {
                "name": "North Arrow",
                "type": "CIMMarkerNorthArrow",
                "visible": false
              },
              {
                "name": "Scale bar",
                "type": "CIMGroupElement",
                "visible": true,
                "elements": [
                  {
                    "name": "Scale Line",
                    "type": "CIMScaleLine",
                    "visible": true
                  },
                  {
                    "name": "Scale Line 1",
                    "type": "CIMScaleLine",
                    "visible": true
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "messages": []
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.