Skip to content

[Docs] General updates 2012-03 #818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 12, 2021
Merged

[Docs] General updates 2012-03 #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dd90c0b
Add REST API 3.10 for 2020.4
bcantoni Feb 24, 2021
31bba61
Spelling cleanup
bcantoni Feb 24, 2021
149d5ec
Rearrange user roles list to hopefully make it more readable
bcantoni Feb 24, 2021
b851c87
Merge branch 'gh-pages' into doc_updates_202102
bcantoni Apr 23, 2021
80624be
Address review feedback and simplify roles (dropping the legacy list …
bcantoni Apr 23, 2021
970a430
Add REST API 3.11 now that 2021.1 is released
bcantoni Apr 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions docs/api-ref.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ The `ConnectionCredentials` class is used for workbook and data source publish r
Attribute | Description
:--- | :---
`name` | The username for the connection.
`embed_password` | (Boolean) Determines whether to embed the passowrd (`True`) for the workbook or data source connection or not (`False`).
`embed_password` | (Boolean) Determines whether to embed the password (`True`) for the workbook or data source connection or not (`False`).
`password` | The password used for the connection.
`server_address` | The server address for the connection.
`server_port` | The port used by the server.
Expand Down Expand Up @@ -281,7 +281,7 @@ The `DatasourceItem` represents the data source resources on Tableau Server. Thi

Name | Description
:--- | :---
`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specifed, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement.
`ask_data_enablement` | Determines if a data source allows use of Ask Data. The value can be `TSC.DatasourceItem.AskDataEnablement.Enabled`, `TSC.DatasourceItem.AskDataEnablement.Disabled`, or `TSC.DatasourceItem.AskDataEnablement.SiteDefault`. If no setting is specified, it will default to SiteDefault. See [REST API Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_datasources.htm#publish_data_source) for more information about ask_data_enablement.
`connections` | The list of data connections (`ConnectionItem`) for the specified data source. You must first call the `populate_connections` method to access this data. See the [ConnectionItem class](#connectionitem-class).
`content_url` | The name of the data source as it would appear in a URL.
`created_at` | The date and time when the data source was created.
Expand Down Expand Up @@ -559,7 +559,7 @@ datasources.publish(datasource_item, file_path, mode, connection_credentials=Non

Publishes a data source to a server, or appends data to an existing data source.

This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one opeation.
This method checks the size of the data source and automatically determines whether the publish the data source in multiple parts or in one operation.

REST API: [Publish Datasource](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#publish_data_source)

Expand Down Expand Up @@ -1264,7 +1264,7 @@ job = server.groups.update(group, as_job=True)

Using the TSC library, you can get information about an asynchronous process (or *job*) on the server. These jobs can be created when Tableau runs certain tasks that could be long running, such as importing or synchronizing users from Active Directory, or running an extract refresh. For example, the REST API methods to create or update groups, to run an extract refresh task, or to publish workbooks can take an `asJob` parameter (`asJob-true`) that creates a background process (the *job*) to complete the call. Information about the asynchronous job is returned from the method.

If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job.
If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.

The job properties are defined in the `JobItem` class. The class corresponds to the properties for jobs you can access using the Tableau Server REST API. The job methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class.

Expand Down Expand Up @@ -1868,7 +1868,7 @@ server.views.populate_pdf(view_item, pdf_req_option)

Using the TSC library, you can schedule extract refresh or subscription tasks on Tableau Server. You can also get and update information about the scheduled tasks, or delete scheduled tasks.

If you have the identifer of the job, you can use the TSC library to find out the status of the asynchronous job.
If you have the identifier of the job, you can use the TSC library to find out the status of the asynchronous job.

The schedule properties are defined in the `ScheduleItem` class. The class corresponds to the properties for schedules you can access in Tableau Server or by using the Tableau Server REST API. The Schedule methods are based upon the endpoints for jobs in the REST API and operate on the `JobItem` class.

Expand Down Expand Up @@ -3120,9 +3120,23 @@ Name | Description
`email` | The email address of the user.
`fullname` | The full name of the user.
`name` | The name of the user. This attribute is required when you are creating a `UserItem` instance.
`site_role` | The role the user has on the site. This attribute is required with you are creating a `UserItem` instance. The specific roles vary depending upon the version of the REST API. For example, for version 2.8 and earlier, the `site_role` can be one of the following: `Interactor`, `Publisher`, `ServerAdministrator`, `SiteAdministrator`, `Unlicensed`, `UnlicensedWithPublish`, `Viewer`, `ViewerWithPublish`, `Guest`. For REST API 3.0 and later, the `site_role` can be one of the following `Creator`, `Explorer`, `ExplorerCanPublish`, `ReadOnly` *(viewers from previous API versions who do not have v3.0+ viewer permissions)*, `Viewer`, `SiteAdministratorCreator`, `SiteAdministratorExplorer`, `UnlicensedWithPublish`.
`site_role` | The role the user has on the site. This attribute is required if you are creating a `UserItem` instance. See *User Roles* below for details.
`groups` | The groups that the user belongs to. You must run the populate_groups method to add the groups to the `UserItem`.

**User Roles**

The possible user roles for the `site_role` attribute are the following:

* `Creator`
* `Explorer`
* `ExplorerCanPublish`
* `ServerAdministrator`
* `SiteAdministratorExplorer`
* `SiteAdministratorCreator`
* `Unlicensed`
* `ReadOnly`
* `Viewer`


**Example**

Expand Down Expand Up @@ -3921,7 +3935,7 @@ import tableauserverclient as TSC
new_workbook = TSC.WorkbookItem('3a8b6148-493c-11e6-a621-6f3499394a39')


````
```

Source file: models/workbook_item.py

Expand Down Expand Up @@ -4059,7 +4073,7 @@ Name | Description
`workbook_item` | The `workbook_item` specifies the workbook you are publishing. When you are adding a workbook, you need to first create a new instance of a `workbook_item` that includes a `project_id` of an existing project. The name of the workbook will be the name of the file, unless you also specify a name for the new workbook when you create the instance. See [WorkbookItem](#workbookitem-class).
`file_path` | The path and name of the workbook to publish.
`mode` | Specifies whether you are publishing a new workbook (`CreateNew`) or overwriting an existing workbook (`Overwrite`). You cannot appending workbooks. You can also use the publish mode attributes, for example: `TSC.Server.PublishMode.Overwrite`.
`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embeded or OAuth is used).
`connection_credentials` | (Optional) The credentials (if required) to connect to the workbook's data source. The `ConnectionCredentials` object contains the authentication information for the data source (user name and password, and whether the credentials are embedded or OAuth is used).



Expand Down Expand Up @@ -4286,7 +4300,7 @@ The file path to the downloaded workbook.
file_path = server.workbooks.download('1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d')
print("\nDownloaded the file to {0}.".format(file_path))

````
```


<br>
Expand Down
4 changes: 4 additions & 0 deletions docs/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ The current version of TSC only supports the following REST API and Tableau Serv

|REST API version|Tableau Server version|
|---|---|
|3.11|2021.1|
|3.10|2020.4|
|3.9|2020.3|
|3.8|2020.2|
|3.7|2020.1|
Expand All @@ -80,3 +82,5 @@ The current version of TSC only supports the following REST API and Tableau Serv
|2.5|10.2|
|2.4|10.1|
|2.3|10.0|

Note that Tableau provides support and security updates for each version of the product for thirty (30) months after release. Review the Supported Versions table on the [Technical Support Programs page](https://www.tableau.com/support/services) for details.