REST API XML Schema
REST API methods that require data in the body of the request pass the data as an XML block. In addition, many API methods return data in the response using an XML block.
The schema for the XML used in requests and response is available in a schema (.xsd) file. When you construct XML for a request, you must make sure that the XML block is well formed and that it conforms to the schema. For many programming frameworks, you can generate code from the .xsd file that maps XML elements and attributes to objects and properties. You can use this code to help you create XML blocks using typed code, and to deserialize and serialize data from REST API requests and responses.
Getting the schema file
You can download the schema as an .xsd file from the following locations:
-
Version 3.24 (Tableau Cloud September): ts-api_3_24.xsd(Link opens in a new window)
-
Version 3.23 (Tableau Server 2024.2): ts-api_3_23.xsd(Link opens in a new window)
-
Version 3.22 (Tableau Server 2024.1): ts-api_3_22.xsd(Link opens in a new window)
-
Version 3.21 (Tableau Server 2023.3): ts-api_3_21.xsd(Link opens in a new window)
-
Version 3.20 (Tableau Server 2023.2): ts-api_3_20.xsd(Link opens in a new window)
-
Version 3.19 (Tableau Server 2023.1): ts-api_3_19.xsd(Link opens in a new window)
-
Version 3.18 (Tableau Cloud updates only): ts-api_3_18.xsd(Link opens in a new window)
-
Version 3.17 (Tableau Server 2022.3): ts-api_3_17.xsd(Link opens in a new window)
-
Version 3.16 (Tableau Cloud updates only): ts-api_3_16.xsd(Link opens in a new window)
-
Version 3.15 (Tableau Server 2022.1): ts-api_3_15.xsd(Link opens in a new window)
-
Version 3.14 (Tableau Server 2021.4): ts-api_3_14.xsd(Link opens in a new window)
-
Version 3.13 (Tableau Server 2021.3): ts-api_3_13.xsd(Link opens in a new window)
-
Version 3.12 (Tableau Server 2021.2): ts-api_3_12.xsd(Link opens in a new window)
-
Version 3.11 (Tableau Server 2021.1): ts-api_3_11.xsd(Link opens in a new window)
-
Version 3.10 (Tableau Server 2020.4): ts-api_3_10.xsd(Link opens in a new window)
-
Version 3.9 (Tableau Server 2020.3): ts-api_3_9.xsd(Link opens in a new window)
-
Version 3.8 (Tableau Server 2020.2): ts-api_3_8.xsd(Link opens in a new window)
-
Version 3.7 (Tableau Server 2020.1): ts-api_3_7.xsd(Link opens in a new window)
-
Version 3.6 (Tableau Server 2019.4): ts-api_3_6.xsd(Link opens in a new window)
-
Version 3.5 (Tableau Server 2019.3): ts-api_3_5.xsd(Link opens in a new window)
-
Version 3.4 (Tableau Server 2019.2): ts-api_3_4.xsd(Link opens in a new window)
-
Version 3.3 (Tableau Server 2019.1): ts-api_3_3.xsd(Link opens in a new window)
-
Version 3.2 (Tableau Server 2018.3): ts-api_3_2.xsd(Link opens in a new window)
-
Version 3.1 (Tableau Server 2018.2): ts-api_3_1.xsd(Link opens in a new window)
-
Version 3.0 (Tableau Server 2018.1): ts-api_3_0.xsd(Link opens in a new window)
-
Version 2.8 (Tableau Server 10.5): ts-api_2_8.xsd(Link opens in a new window)
-
Version 2.7 (Tableau Server 10.4): ts-api_2_7.xsd(Link opens in a new window)
-
Version 2.6 (Tableau Server 10.3): ts-api_2_6.xsd(Link opens in a new window)
-
Version 2.5 (Tableau Server 10.2): ts-api_2_5.xsd(Link opens in a new window)
-
Version 2.4 (Tableau Server 10.1): ts-api_2_4.xsd(Link opens in a new window)
-
Version 2.3 (Tableau Server 10.0): ts-api_2_3.xsd(Link opens in a new window)
-
Version 2.2 (Tableau Server 9.3): ts-api-2_2.xsd(Link opens in a new window)
-
Version 2.1 (Tableau Server 9.2): ts-api-2_1.xsd(Link opens in a new window)
-
Version 2.0.1 (Tableau Server 9.0.1): ts-api-2_0_1.xsd(Link opens in a new window)
-
Version 2.0 (Tableau Server 9.0): ts-api-2_0.xsd(Link opens in a new window)
For more information about REST API versions and XML schema versions, see REST API and Resource Versions.