forked from Esri/arcgis-python-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patharcgis.apps.survey123.html
837 lines (589 loc) · 41.6 KB
/
arcgis.apps.survey123.html
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>arcgis.apps.survey123 module — arcgis 2.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="arcgis.apps.tracker module" href="arcgis.apps.tracker.html" />
<link rel="prev" title="arcgis.apps.storymap module" href="arcgis.apps.storymap.html" />
<!-- This code block is inserted close near the <head> tag. See http://bit.ly/2BHUQzB -->
<!-- The point of this code block is to send us google analytics on website views -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-NJGGV5');</script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> arcgis
<img src="_static/python_api_logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
2.1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">arcgis</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="arcgis.gis.toc.html">arcgis.gis module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.env.html">arcgis.env module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.features.toc.html">arcgis.features module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.raster.toc.html">arcgis.raster module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.network.toc.html">arcgis.network module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.geoanalytics.toc.html">arcgis.geoanalytics module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.geocoding.html">arcgis.geocoding module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.geoenrichment.html">arcgis.geoenrichment module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.geometry.html">arcgis.geometry module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.geoprocessing.html">arcgis.geoprocessing module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.graph.html">arcgis.graph module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.mapping.toc.html">arcgis.mapping module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.realtime.html">arcgis.realtime module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.schematics.html">arcgis.schematics module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.widgets.html">arcgis.widgets module</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="arcgis.apps.html">arcgis.apps module</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-collector-url">build_collector_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-explorer-url">build_explorer_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-field-maps-url">build_field_maps_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-navigator-url">build_navigator_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-survey123-url">build_survey123_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-tracker-url">build_tracker_url</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcgis.apps.html#build-workforce-url">build_workforce_url</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="arcgis.apps.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="arcgis.apps.hub.html">arcgis.apps.hub module</a></li>
<li class="toctree-l3"><a class="reference internal" href="arcgis.apps.dashboard.html">arcgis.apps.dashboard module</a></li>
<li class="toctree-l3"><a class="reference internal" href="arcgis.apps.workforce.html">arcgis.apps.workforce module</a></li>
<li class="toctree-l3"><a class="reference internal" href="arcgis.apps.storymap.html">arcgis.apps.storymap module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">arcgis.apps.survey123 module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#surveymanager">SurveyManager</a></li>
<li class="toctree-l4"><a class="reference internal" href="#survey">Survey</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="arcgis.apps.tracker.html">arcgis.apps.tracker module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.learn.toc.html">arcgis.learn module</a></li>
<li class="toctree-l1"><a class="reference internal" href="arcgis.auth.html">arcgis.auth package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">arcgis</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="arcgis.apps.html">arcgis.apps module</a> »</li>
<li>arcgis.apps.survey123 module</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<!-- This code block is inserted close near the <body> tag. See http://bit.ly/2BHUQzB -->
<!-- The point of this code block is to send us google analytics on website views -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NJGGV5"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<div class="section" id="module-arcgis.apps.survey123">
<span id="arcgis-apps-survey123-module"></span><h1>arcgis.apps.survey123 module<a class="headerlink" href="#module-arcgis.apps.survey123" title="Permalink to this headline">¶</a></h1>
<div class="section" id="surveymanager">
<h2>SurveyManager<a class="headerlink" href="#surveymanager" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="arcgis.apps.survey123.SurveyManager">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">arcgis.apps.survey123.</span></code><code class="sig-name descname"><span class="pre">SurveyManager</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseurl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.SurveyManager" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Survey Manager allows users and administrators of Survey 123 to
analyze, report on, and access the data for various surveys.</p>
<dl class="py method">
<dt id="arcgis.apps.survey123.SurveyManager.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">survey_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.SurveyManager.get" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a single <a class="reference internal" href="#arcgis.apps.survey123.Survey" title="arcgis.apps.survey123.Survey"><code class="xref py py-class docutils literal notranslate"><span class="pre">Survey</span></code></a> object from and Item ID or Item</p>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.SurveyManager.surveys">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">surveys</span></code><a class="headerlink" href="#arcgis.apps.survey123.SurveyManager.surveys" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of existing Survey</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="survey">
<h2>Survey<a class="headerlink" href="#survey" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="arcgis.apps.survey123.Survey">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">arcgis.apps.survey123.</span></code><code class="sig-name descname"><span class="pre">Survey</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sm</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseurl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A <cite>Survey</cite> is a single instance of a survey project. This class contains
the <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> information and properties to access the underlying dataset
that was generated by the <cite>Survey</cite> form.</p>
<p>Data can be exported to <cite>Pandas DataFrames</cite>, <cite>shapefiles</cite>, <cite>CSV</cite>, and
<cite>File Geodatabases</cite>.</p>
<p>In addition to exporting data to various formats, a <cite>Survey’s</cite> data can
be exported as reports.</p>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.check_template_syntax">
<code class="sig-name descname"><span class="pre">check_template_syntax</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.check_template_syntax" title="Permalink to this definition">¶</a></dt>
<dd><p>A sync operation to check any syntax which will lead to a failure
when generating reports in the given feature.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 19%" />
<col style="width: 81%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>template_file</p></td>
<td><p>Required String. The report template file which syntax to be checked.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dictionary {Success or Failure}</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.create_report_template">
<code class="sig-name descname"><span class="pre">create_report_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'individual'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/folders/d6/3klqsbvx0kzd1cd2nbsvwc1nmrf_fz/T'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.create_report_template" title="Permalink to this definition">¶</a></dt>
<dd><p>The <cite>create_report_template</cite> creates a simple default template that
can be downloaded locally, edited and uploaded back up as a report
template.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 84%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>template_type</p></td>
<td><p>Optional String. Specify which sections to include in the template.
Acceptable types are <cite>individual</cite>, <cite>summary</cite>, and <cite>summaryIndividual</cite>.
Default is <cite>individual</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p>template_name</p></td>
<td><p>Optional String. Specify the name of the output template file without file extension.</p></td>
</tr>
<tr class="row-even"><td><p>save_folder</p></td>
<td><p>Optional String. Specify the folder location where the output file should be stored.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>String</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.create_sample_report">
<code class="sig-name descname"><span class="pre">create_sample_report</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report_template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">where</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'1=1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">utc_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'+00:00'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report_title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">survey_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webmap_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">map_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'en'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/folders/d6/3klqsbvx0kzd1cd2nbsvwc1nmrf_fz/T'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.create_sample_report" title="Permalink to this definition">¶</a></dt>
<dd><p>Similar task to generate_report for creating test sample report, and refining
a report template before generating any formal report.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 11%" />
<col style="width: 89%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>report_template</p></td>
<td><p>Required <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . The report template Item.</p></td>
</tr>
<tr class="row-odd"><td><p>where</p></td>
<td><p>Optional String. This is the select statement used to export
part or whole of the dataset. If the record count is > 1, then
the item must be saved to your organization.</p></td>
</tr>
<tr class="row-even"><td><p>utc_offset</p></td>
<td><p>Optional String. This is the time offset from UTC to match the
users timezone. Example: EST - “+04:00”</p></td>
</tr>
<tr class="row-odd"><td><p>report_title</p></td>
<td><p>Optional String. Specify the file name (without extension) of the
result report file. For example, if outputFormat is .pdf, input:
“abc” -> output: “abc.pdf”; input: “abc.docx” -> output: “abc.docx.pdf”.</p>
<p>If packageFiles is true, outputReportName will be used for report files
inside the packaged file. If mergeFiles is either nextPage or continuous,
outputReportName will be used as the merged file name.</p>
</td>
</tr>
<tr class="row-even"><td><p>merge_files</p></td>
<td><p>Optional String. Specify if print multiple records into a single
report file (merged mode) or multiple files (split mode), and if
in merge mode, start the next record on a new page or continue
with the current page. Note: A merged file larger than 500MB
will be split into multiple files.</p>
<ul class="simple">
<li><p><cite>none</cite> - Print multiple records in split mode, each record becomes a separated report file. This is the default value.</p></li>
<li><p><cite>nextPage</cite> - Print multiple records in merge mode, the content of the next record starts on the next new page.</p></li>
<li><p><cite>continuous</cite> - Print multiple records in merge mode, the content of the next record starts on the same page of the previous record.</p></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>save_folder</p></td>
<td><p>Optional String. Specify the folder location where the output file should be stored.</p></td>
</tr>
<tr class="row-even"><td><p>survey_item</p></td>
<td><p>Optional <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . Survey <cite>Item</cite>, to make the operation survey awareness.</p></td>
</tr>
<tr class="row-odd"><td><p>webmap_item</p></td>
<td><p>Optional <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . Specify the base map for printing task when printing
a point/polyline/polygon. This takes precedence over the map set for
each question inside a survey.</p></td>
</tr>
<tr class="row-even"><td><p>map_scale</p></td>
<td><p>Optional Float. Specify the map scale when printing, the map will center on the feature geometry.</p></td>
</tr>
<tr class="row-odd"><td><p>locale</p></td>
<td><p>Optional String. Specify the locale setting to format number and date values.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>String</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.download">
<code class="sig-name descname"><span class="pre">download</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">export_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.download" title="Permalink to this definition">¶</a></dt>
<dd><p>Exports the Survey’s data to other format</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 84%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>export_format</p></td>
<td><p>Required String. This is the acceptable export format that a
user can export the survey data to. The following formats are
acceptable: File Geodatabase, Shapefile, CSV, and DF.</p></td>
</tr>
<tr class="row-odd"><td><p>save_folder</p></td>
<td><p>Optional String. Specify the folder location where the output file should be stored.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>String or DataFrame</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.estimate">
<code class="sig-name descname"><span class="pre">estimate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report_template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">where</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'1=1'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.estimate" title="Permalink to this definition">¶</a></dt>
<dd><p>An operation to estimate how many credits are required for a task
with the given parameters.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 20%" />
<col style="width: 80%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>report_template</p></td>
<td><p>Required <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . The report template Item.</p></td>
</tr>
<tr class="row-odd"><td><p>where</p></td>
<td><p>Optional String. This is the select statement used to export
part or whole of the dataset. If the filtered result has more
than one feature/record, the request will be considered as a
batch printing. Currently, one individual report will be
generated for each feature/record.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>dictionary {totalRecords, cost(in credits)}</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.generate_report">
<code class="sig-name descname"><span class="pre">generate_report</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report_template</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">where</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'1=1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">utc_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'+00:00'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">report_title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">package_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'docx'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">survey_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webmap_item</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">map_scale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locale</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'en'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'/var/folders/d6/3klqsbvx0kzd1cd2nbsvwc1nmrf_fz/T'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.generate_report" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an MS Word Report or PDF. The <cite>generate_report</cite> method allows users to either save the
report to the enterprise or export it directly to disk.</p>
<p>To save to disk, do not specify a <cite>folder_id</cite>.</p>
<p>For additional information on parameters, see <a class="reference external" href="https://developers.arcgis.com/survey123/api-reference/rest/report/#create-report">Create Report</a>.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 11%" />
<col style="width: 89%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>report_template</p></td>
<td><p>Required <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . The report template Item.</p></td>
</tr>
<tr class="row-odd"><td><p>where</p></td>
<td><p>Optional String. This is the select statement used to export
part or whole of the dataset. If the record count is > 1, then
the item must be saved to your organization.</p></td>
</tr>
<tr class="row-even"><td><p>utc_offset</p></td>
<td><p>Optional String. This is the time offset from UTC to match the
users timezone. Example: EST - “+04:00”</p></td>
</tr>
<tr class="row-odd"><td><p>report_title</p></td>
<td><p>Optional String. Specify the file name (without extension) of the
result report file. For example, if outputFormat is .pdf, input:
“abc” -> output: “abc.pdf”; input: “abc.docx” -> output: “abc.docx.pdf”.</p>
<p>If mergeFiles is either nextPage or continuous,
outputReportName will be used as the merged file name. See
<a class="reference external" href="https://developers.arcgis.com/survey123/api-reference/rest/report/#create-report">Create Report</a>
for detailed explanation.</p>
</td>
</tr>
<tr class="row-even"><td><p>package_name</p></td>
<td><p>Optional String. Specify the file name (without extension)of the
packaged file when packageFiles is true, for example, <outputPackageName>.zip.</p></td>
</tr>
<tr class="row-odd"><td><p>save_folder</p></td>
<td><p>Optional String. Specify the folder location where the output file should be stored.
If <cite>folder_id</cite> is specified the save_folder will be ignored.</p></td>
</tr>
<tr class="row-even"><td><p>output_format</p></td>
<td><p>Optional String. Currently only docx and pdf are supported.</p></td>
</tr>
<tr class="row-odd"><td><p>folder_id</p></td>
<td><p>Optional String. The folder ID of the user’s content.</p></td>
</tr>
<tr class="row-even"><td><p>merge_files</p></td>
<td><p>Optional String. Specify if print multiple records into a single
report file (merged mode) or multiple files (split mode), and if
in merge mode, start the next record on a new page or continue
with the current page. Note: A merged file larger than 500MB
will be split into mulitple files.</p>
<ul class="simple">
<li><p><cite>none</cite> - Print multiple records in split mode, each record becomes a separated report file. This is the default value.</p></li>
<li><p><cite>nextPage</cite> - Print multiple records in merge mode, the content of the next record starts on the next new page.</p></li>
<li><p><cite>continuous</cite> - Print multiple records in merge mode, the content of the next record starts on the same page of the previous record.</p></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>survey_item</p></td>
<td><p>Optional <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . Survey <cite>Item</cite>, to make the operation survey awareness.</p></td>
</tr>
<tr class="row-even"><td><p>webmap_item</p></td>
<td><p>Optional <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Item</span></code></a> . Specify the base map for printing task when printing
a point/polyline/polygon. This takes precedence over the map set for
each question inside a survey.</p></td>
</tr>
<tr class="row-odd"><td><p>map_scale</p></td>
<td><p>Optional Float. Specify the map scale when printing, the map will center on the feature geometry.</p></td>
</tr>
<tr class="row-even"><td><p>locale</p></td>
<td><p>Optional String. Specify the locale setting to format number and date values.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Item or string upon completion of <a class="reference external" href="https://developers.arcgis.com/survey123/api-reference/rest/report/#jobs">Job</a>.</p>
</dd>
</dl>
<p>For details on the return value, see <a class="reference external" href="https://developers.arcgis.com/survey123/api-reference/rest/report/#response-parameters">Response Parameters</a>
for <a class="reference internal" href="#arcgis.apps.survey123.Survey.generate_report" title="arcgis.apps.survey123.Survey.generate_report"><code class="xref py py-func docutils literal notranslate"><span class="pre">generate_report()</span></code></a> job.</p>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.properties">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">properties</span></code><a class="headerlink" href="#arcgis.apps.survey123.Survey.properties" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the properties of the survey</p>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.report_templates">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">report_templates</span></code><a class="headerlink" href="#arcgis.apps.survey123.Survey.report_templates" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of saved report items</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>list of <a class="reference internal" href="arcgis.gis.toc.html#arcgis.gis.Item" title="arcgis.gis.Item"><code class="xref py py-class docutils literal notranslate"><span class="pre">Items</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.reports">
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reports</span></code><a class="headerlink" href="#arcgis.apps.survey123.Survey.reports" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of generated reports</p>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.update_report_template">
<code class="sig-name descname"><span class="pre">update_report_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.update_report_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Check report template syntax to identify any syntax which will lead to a failure
when generating reports in the given feature and updates existing Report template Org item.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 84%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>template_file</p></td>
<td><p>Required String. The report template file which syntax to be checked, and uploaded.
The updated template name must match the name of the existing template item.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>item {Success) or string (Failure}</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="arcgis.apps.survey123.Survey.upload_report_template">
<code class="sig-name descname"><span class="pre">upload_report_template</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.apps.survey123.Survey.upload_report_template" title="Permalink to this definition">¶</a></dt>
<dd><p>Check report template syntax to identify any syntax which will lead to a failure
when generating reports in the given feature. Uploads the report to the organization
and associates it with the survey.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 84%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><strong>Argument</strong></p></td>
<td><p><strong>Description</strong></p></td>
</tr>
<tr class="row-even"><td><p>template_file</p></td>
<td><p>Required String. The report template file which syntax to be checked, and uploaded.</p></td>
</tr>
<tr class="row-odd"><td><p>template_name</p></td>
<td><p>Optional String. If provided the resulting item will use the provided name, otherwise
the name of the docx file will be used.</p></td>
</tr>
</tbody>
</table>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>item {Success) or string (Failure}</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="arcgis.apps.tracker.html" class="btn btn-neutral float-right" title="arcgis.apps.tracker module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="arcgis.apps.storymap.html" class="btn btn-neutral float-left" title="arcgis.apps.storymap module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016-2022, Esri.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
Options v: 2.1.0
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Pick an earlier version</span>
v: 2.1.0
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="2.0.1/">2.0.1</a></dd>
<dd><a href="2.0.0/">2.0.0</a></dd>
<dd><a href="1.9.1/">1.9.1</a></dd>
<dd><a href="1.9.0/">1.9.0</a></dd>
<dd><a href="1.8.5/">1.8.5</a></dd>
<dd><a href="1.8.4/">1.8.4</a></dd>
<dd><a href="1.8.3/">1.8.3</a></dd>
<dd><a href="1.8.2/">1.8.2</a></dd>
<dd><a href="1.8.1/">1.8.1</a></dd>
<dd><a href="1.8.0/">1.8.0</a></dd>
<dd><a href="1.7.1/">1.7.1</a></dd>
<dd><a href="1.7.0/">1.7.0</a></dd>
<dd><a href="1.6.2/">1.6.2</a></dd>
<dd><a href="1.6.1/">1.6.1</a></dd>
<dd><a href="1.6.0/">1.6.0</a></dd>
<dd><a href="1.5.2/">1.5.2</a></dd>
<dd><a href="1.5.1/">1.5.1</a></dd>
<dd><a href="1.5.0/">1.5.0</a></dd>
<dd><a href="1.4.2/">1.4.2</a></dd>
<dd><a href="1.4.1/">1.4.1</a></dd>
<dd><a href="1.4.0/">1.4.0</a></dd>
<dd><a href="1.3.0/">1.3.0</a></dd>
<dd><a href="1.2.5/">1.2.5</a></dd>
<dd><a href="1.2.4/">1.2.4</a></dd>
<dd><a href="1.2.3/">1.2.3</a></dd>
<dd><a href="1.2.2/">1.2.2</a></dd>
<dd><a href="1.2.1/">1.2.1</a></dd>
<dd><a href="1.2.0/">1.2.0</a></dd>
<dd><a href="1.1.0/">1.1.0</a></dd>
<dd><a href="1.0.1/">1.0.1</a></dd>
<dd><a href="1.0.0/">1.0.0</a></dd>
<dd><a href="0.3.0/">0.3.0</a></dd>
<dd><a href="0.2.0/">0.2.0</a></dd>
<dd><a href="0.1.0/">0.1.0</a></dd>
</dl>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>