Skip to content

Commit 30c9be2

Browse files
jorwoodsjorwoods
committed
docs: add REST API links
1 parent 2690492 commit 30c9be2

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

‎tableauserverclient/server/endpoint/projects_endpoint.py‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[Proj
4141
Retrieves all projects on the site. The endpoint is paginated and can
4242
be filtered using the req_options parameter.
4343
44+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#query_projects
45+
4446
Parameters
4547
----------
4648
req_options : RequestOptions | None, default None
@@ -64,6 +66,8 @@ def delete(self, project_id: str) -> None:
6466
"""
6567
Deletes a single project on the site.
6668
69+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#delete_project
70+
6771
Parameters
6872
----------
6973
project_id : str
@@ -95,6 +99,8 @@ def update(self, project_item: ProjectItem, samples: bool = False) -> ProjectIte
9599
TableauAuth instance using the content URL for the site (site_id), and
96100
sign in to that site.
97101
102+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#update_project
103+
98104
Parameters
99105
----------
100106
project_item : ProjectItem
@@ -137,6 +143,8 @@ def create(self, project_item: ProjectItem, samples: bool = False) -> ProjectIte
137143
project, create a TableauAuth instance using the content URL for the
138144
site (site_id), and sign in to that site.
139145
146+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#create_project
147+
140148
Parameters
141149
----------
142150
project_item : ProjectItem
@@ -168,6 +176,8 @@ def populate_permissions(self, item: ProjectItem) -> None:
168176
"""
169177
Queries the project permissions, parses and stores the returned the permissions.
170178
179+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_project_permissions
180+
171181
Parameters
172182
----------
173183
item : ProjectItem
@@ -186,6 +196,8 @@ def update_permissions(self, item: ProjectItem, rules: list[PermissionsRule]) ->
186196
provided are expected to be a complete list of the permissions for the
187197
project.
188198
199+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_permissions_for_content
200+
189201
Parameters
190202
----------
191203
item : ProjectItem
@@ -207,6 +219,8 @@ def delete_permission(self, item: ProjectItem, rules: list[PermissionsRule]) ->
207219
"""
208220
Deletes the specified permissions from the project item.
209221
222+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_project_permission
223+
210224
Parameters
211225
----------
212226
item : ProjectItem
@@ -227,6 +241,8 @@ def populate_workbook_default_permissions(self, item: ProjectItem) -> None:
227241
Queries the default workbook permissions, parses and stores the
228242
returned the permissions.
229243
244+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
245+
230246
Parameters
231247
----------
232248
item : ProjectItem
@@ -244,6 +260,8 @@ def populate_datasource_default_permissions(self, item: ProjectItem) -> None:
244260
Queries the default datasource permissions, parses and stores the
245261
returned the permissions.
246262
263+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
264+
247265
Parameters
248266
----------
249267
item : ProjectItem
@@ -261,6 +279,8 @@ def populate_metric_default_permissions(self, item: ProjectItem) -> None:
261279
Queries the default metric permissions, parses and stores the
262280
returned the permissions.
263281
282+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
283+
264284
Parameters
265285
----------
266286
item : ProjectItem
@@ -278,6 +298,8 @@ def populate_datarole_default_permissions(self, item: ProjectItem) -> None:
278298
Queries the default datarole permissions, parses and stores the
279299
returned the permissions.
280300
301+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
302+
281303
Parameters
282304
----------
283305
item : ProjectItem
@@ -295,6 +317,8 @@ def populate_flow_default_permissions(self, item: ProjectItem) -> None:
295317
Queries the default flow permissions, parses and stores the
296318
returned the permissions.
297319
320+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
321+
298322
Parameters
299323
----------
300324
item : ProjectItem
@@ -312,6 +336,8 @@ def populate_lens_default_permissions(self, item: ProjectItem) -> None:
312336
Queries the default lens permissions, parses and stores the
313337
returned the permissions.
314338
339+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
340+
315341
Parameters
316342
----------
317343
item : ProjectItem
@@ -329,6 +355,8 @@ def populate_virtualconnection_default_permissions(self, item: ProjectItem) -> N
329355
Queries the default virtualconnections permissions, parses and stores
330356
the returned the permissions.
331357
358+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
359+
332360
Parameters
333361
----------
334362
item : ProjectItem
@@ -347,6 +375,8 @@ def populate_database_default_permissions(self, item: ProjectItem) -> None:
347375
Queries the default database permissions, parses and stores the
348376
returned the permissions.
349377
378+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
379+
350380
Parameters
351381
----------
352382
item : ProjectItem
@@ -364,6 +394,8 @@ def populate_table_default_permissions(self, item: ProjectItem) -> None:
364394
Queries the default table permissions, parses and stores the
365395
returned the permissions.
366396
397+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_default_permissions
398+
367399
Parameters
368400
----------
369401
item : ProjectItem
@@ -382,6 +414,8 @@ def update_workbook_default_permissions(
382414
"""
383415
Add or updates the default workbook permissions for the specified.
384416
417+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
418+
385419
Parameters
386420
----------
387421
item : ProjectItem
@@ -404,6 +438,8 @@ def update_datasource_default_permissions(
404438
"""
405439
Add or updates the default datasource permissions for the specified.
406440
441+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
442+
407443
Parameters
408444
----------
409445
item : ProjectItem
@@ -426,6 +462,8 @@ def update_metric_default_permissions(
426462
"""
427463
Add or updates the default metric permissions for the specified.
428464
465+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
466+
429467
Parameters
430468
----------
431469
item : ProjectItem
@@ -448,6 +486,8 @@ def update_datarole_default_permissions(
448486
"""
449487
Add or updates the default datarole permissions for the specified.
450488
489+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
490+
451491
Parameters
452492
----------
453493
item : ProjectItem
@@ -468,6 +508,8 @@ def update_flow_default_permissions(self, item: ProjectItem, rules: list[Permiss
468508
"""
469509
Add or updates the default flow permissions for the specified.
470510
511+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
512+
471513
Parameters
472514
----------
473515
item : ProjectItem
@@ -488,6 +530,8 @@ def update_lens_default_permissions(self, item: ProjectItem, rules: list[Permiss
488530
"""
489531
Add or updates the default lens permissions for the specified.
490532
533+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
534+
491535
Parameters
492536
----------
493537
item : ProjectItem
@@ -510,6 +554,8 @@ def update_virtualconnection_default_permissions(
510554
"""
511555
Add or updates the default virtualconnection permissions for the specified.
512556
557+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
558+
513559
Parameters
514560
----------
515561
item : ProjectItem
@@ -532,6 +578,8 @@ def update_database_default_permissions(
532578
"""
533579
Add or updates the default database permissions for the specified.
534580
581+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
582+
535583
Parameters
536584
----------
537585
item : ProjectItem
@@ -554,6 +602,8 @@ def update_table_default_permissions(
554602
"""
555603
Add or updates the default table permissions for the specified.
556604
605+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_default_permissions_for_content
606+
557607
Parameters
558608
----------
559609
item : ProjectItem
@@ -574,6 +624,8 @@ def delete_workbook_default_permissions(self, item: ProjectItem, rule: Permissio
574624
"""
575625
Deletes the specified default permission rule from the project.
576626
627+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
628+
577629
Parameters
578630
----------
579631
item : ProjectItem
@@ -593,6 +645,8 @@ def delete_datasource_default_permissions(self, item: ProjectItem, rule: Permiss
593645
"""
594646
Deletes the specified default permission rule from the project.
595647
648+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
649+
596650
Parameters
597651
----------
598652
item : ProjectItem
@@ -612,6 +666,8 @@ def delete_metric_default_permissions(self, item: ProjectItem, rule: Permissions
612666
"""
613667
Deletes the specified default permission rule from the project.
614668
669+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
670+
615671
Parameters
616672
----------
617673
item : ProjectItem
@@ -631,6 +687,8 @@ def delete_datarole_default_permissions(self, item: ProjectItem, rule: Permissio
631687
"""
632688
Deletes the specified default permission rule from the project.
633689
690+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
691+
634692
Parameters
635693
----------
636694
item : ProjectItem
@@ -650,6 +708,8 @@ def delete_flow_default_permissions(self, item: ProjectItem, rule: PermissionsRu
650708
"""
651709
Deletes the specified default permission rule from the project.
652710
711+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
712+
653713
Parameters
654714
----------
655715
item : ProjectItem
@@ -669,6 +729,8 @@ def delete_lens_default_permissions(self, item: ProjectItem, rule: PermissionsRu
669729
"""
670730
Deletes the specified default permission rule from the project.
671731
732+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
733+
672734
Parameters
673735
----------
674736
item : ProjectItem
@@ -688,6 +750,8 @@ def delete_virtualconnection_default_permissions(self, item: ProjectItem, rule:
688750
"""
689751
Deletes the specified default permission rule from the project.
690752
753+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
754+
691755
Parameters
692756
----------
693757
item : ProjectItem
@@ -707,6 +771,8 @@ def delete_database_default_permissions(self, item: ProjectItem, rule: Permissio
707771
"""
708772
Deletes the specified default permission rule from the project.
709773
774+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
775+
710776
Parameters
711777
----------
712778
item : ProjectItem
@@ -726,6 +792,8 @@ def delete_table_default_permissions(self, item: ProjectItem, rule: PermissionsR
726792
"""
727793
Deletes the specified default permission rule from the project.
728794
795+
REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_default_permission
796+
729797
Parameters
730798
----------
731799
item : ProjectItem

0 commit comments

Comments
 (0)