Skip to content

Commit c2c05c5

Browse files
committed
docs: add URLs to docs
1 parent bb5d751 commit c2c05c5

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/api-ref.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -727,6 +727,8 @@ datasources.delete(datasource_id)
727727

728728
Removes the specified data source from Tableau Server.
729729

730+
REST API: [Delete Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#delete_data_source)
731+
730732

731733
**Parameters**
732734

@@ -1182,6 +1184,8 @@ datasources.create_extract(datasource_item, encrypt=False)
11821184

11831185
Creates an extract for the specified data source.
11841186

1187+
REST API: [Create an Extract for a Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#create_extract_for_datasource)
1188+
11851189
**Parameters**
11861190

11871191
Name | Description
@@ -1216,6 +1220,8 @@ datasources.delete_extract(datasource_item)
12161220

12171221
Removes the extract from the specified data source.
12181222

1223+
REST API: [Delete the Extract from a Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#delete_extract_from_datasource)
1224+
12191225
**Parameters**
12201226

12211227
Name | Description
@@ -1244,6 +1250,8 @@ datasources.populate_permissions(datasource_item)
12441250

12451251
Populates the permissions for the specified data source.
12461252

1253+
REST API: [List Data Source Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#query_data_source_permissions)
1254+
12471255
**Parameters**
12481256

12491257
Name | Description
@@ -1274,6 +1282,8 @@ datasources.update_permissions(datasource_item, permission_item)
12741282

12751283
Adds or updates permissions for the specified data source.
12761284

1285+
REST API: [Replace Content Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#replace_permissions_for_content)
1286+
12771287
**Parameters**
12781288

12791289
Name | Description
@@ -1296,6 +1306,8 @@ datasources.delete_permission(datasource_item, capability_item)
12961306

12971307
Removes a permission from the specified data source.
12981308

1309+
REST API: [Delete Data Source Permission](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_permissions.htm#delete_data_source_permission)
1310+
12991311
**Parameters**
13001312

13011313
Name | Description
@@ -1318,6 +1330,8 @@ datasources.populate_dqw(datasource_item)
13181330

13191331
Populates the data quality warnings for the specified data source.
13201332

1333+
REST API: [Query Data Quality Warning by Content](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#query_dqws)
1334+
13211335
**Parameters**
13221336

13231337
Name | Description
@@ -1348,6 +1362,8 @@ datasources.add_dqw(datasource_item, warning)
13481362

13491363
Adds a data quality warning to the specified data source.
13501364

1365+
REST API: [Add Data Quality Warning](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#add_dqw)
1366+
13511367
**Parameters**
13521368

13531369
Name | Description
@@ -1370,6 +1386,8 @@ datasources.update_dqw(datasource_item, warning)
13701386

13711387
Updates a data quality warning on the specified data source.
13721388

1389+
REST API: [Update Data Quality Warning](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#update_dqw)
1390+
13731391
**Parameters**
13741392

13751393
Name | Description
@@ -1392,6 +1410,8 @@ datasources.delete_dqw(datasource_item)
13921410

13931411
Removes all data quality warnings from the specified data source.
13941412

1413+
REST API: [Delete Quality Warning Triggers by Content](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#delete_dqw_triggers)
1414+
13951415
**Parameters**
13961416

13971417
Name | Description
@@ -1413,6 +1433,8 @@ datasources.populate_revisions(datasource_item)
14131433

14141434
Populates the revision history for the specified data source.
14151435

1436+
REST API: [Get Data Source Revisions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#get_data_source_revisions)
1437+
14161438
**Parameters**
14171439

14181440
Name | Description
@@ -1449,6 +1471,8 @@ datasources.download_revision(datasource_id, revision_number, filepath=None, inc
14491471

14501472
Downloads a specific revision of the specified data source.
14511473

1474+
REST API: [Download Data Source Revision](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#download_data_source_revision)
1475+
14521476
**Parameters**
14531477

14541478
Name | Description
@@ -1493,6 +1517,8 @@ datasources.delete_revision(datasource_id, revision_number)
14931517

14941518
Removes a specific revision of the specified data source from Tableau Server.
14951519

1520+
REST API: [Remove Data Source Revision](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#remove_data_source_revision)
1521+
14961522
**Parameters**
14971523

14981524
Name | Description
@@ -1521,6 +1547,8 @@ datasources.schedule_extract_refresh(schedule_id, item)
15211547

15221548
Convenience method to add a data source to an existing extract refresh schedule.
15231549

1550+
REST API: [Add Data Source to Server Schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#add_data_source_to_schedule)
1551+
15241552
**Parameters**
15251553

15261554
Name | Description
@@ -1587,6 +1615,8 @@ datasources.update_connections(datasource_item, connection_luids, authentication
15871615

15881616
Bulk updates one or more datasource connections by LUID.
15891617

1618+
REST API: [Update Data Source Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source_connections)
1619+
15901620
**Version**
15911621

15921622
This endpoint is available with REST API version 3.26 and up.
@@ -1726,6 +1756,8 @@ datasources.update_tags(item)
17261756

17271757
Updates the tags on the server to match the tags on the specified datasource item. Changes to tags must be made on the `DatasourceItem.tags` attribute before calling this method.
17281758

1759+
REST API: [Delete Tag from Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#delete_tag_from_data_source) and [Add Tags to Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#add_tags_to_data_source)
1760+
17291761
**Parameters**
17301762

17311763
Name | Description
@@ -1754,6 +1786,8 @@ datasources.filter(**kwargs)
17541786

17551787
Returns a list of datasources that match the specified filters. Fields and operators are passed as keyword arguments in the form `field_name=value` or `field_name__operator=value`.
17561788

1789+
REST API: [Filtering & Sorting Datasources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#datasources)
1790+
17571791
**Supported fields and operators**
17581792

17591793
Field | Operators

0 commit comments

Comments
 (0)