Python đọc nguồn dữ liệu tableau
Quan trọng. Sắp có thêm. Phần này đang được xây dựng tích cực và có thể không phản ánh tất cả các chức năng có sẵn của thư viện TSC Show
Tableau Server Client (TSC) là một thư viện Python dành cho Tableau Server REST API. Sử dụng thư viện TSC, bạn có thể quản lý và thay đổi nhiều tài nguyên Tableau Server và Tableau Cloud theo chương trình. Bạn có thể sử dụng thư viện này để tạo các ứng dụng tùy chỉnh của riêng mình Tham chiếu TSC API được tổ chức theo tài nguyên. Thư viện TSC được mô hình hóa sau API REST. Các phương thức, ví dụ, 97, tương ứng với các điểm cuối cho tài nguyên, chẳng hạn như , , và. Các lớp mô hình (ví dụ: các thuộc tính có đại diện cho các trường ( 98, 99, 00) trong các gói phản hồi và yêu cầu API REST hoặc tải trọngGhi chú. Một số phương thức và tính năng được cung cấp trong API REST hiện có thể không có sẵn trong thư viện TSC (và trong một số trường hợp, điều ngược lại là đúng). Ngoài ra, các hạn chế tương tự áp dụng cho thư viện TSC áp dụng cho API REST đối với các tài nguyên trên Tableau Server và Tableau Clous. Để biết thêm thông tin, hãy xem Tham chiếu API Tableau Server RESTBạn có thể sử dụng thư viện TSC để đăng nhập và đăng xuất khỏi Tableau Server và Tableau Cloud. Thông tin đăng nhập được xác định trong lớp 01 và chúng tương ứng với các thuộc tính bạn chỉ định khi đăng nhập bằng API Tableau Server RESTLớp TableauAuth
Lớp 01 xác định thông tin bạn có thể đặt trong yêu cầu đăng nhập. Các thành viên lớp tương ứng với các thuộc tính của yêu cầu máy chủ hoặc tải trọng phản hồi. Để sử dụng lớp này, hãy tạo một thể hiện mới, cung cấp tên người dùng, mật khẩu và thông tin trang web nếu cần và chuyển đối tượng yêu cầu cho phương thứcGhi chú. Trong tương lai, có thể có hỗ trợ cho các hình thức ủy quyền và xác thực bổ sung (ví dụ: OAuth) Thuộc tính TênMô tả 03Tên của người dùng có thông tin đăng nhập sẽ được sử dụng để đăng nhập. 04Mật khẩu của người dùng. 05Điều này tương ứng với thuộc tính 06 trong Tableau REST API. 05 là phần của URL theo sau 08 trong URL. Ví dụ: “MarketingTeam” là 05 trong URL sau MyServer/#/site/MarketingTeam/projects. Để chỉ định trang web mặc định trên Tableau Server, bạn có thể sử dụng một chuỗi rỗng 10 (dấu nháy đơn, không khoảng trắng). Đối với Tableau Cloud, bạn phải cung cấp giá trị cho 05. 12Chỉ định id (không phải tên) của người dùng để đăng nhập với tư cáchtập tin nguồn. mô hình/tableau_auth. py Ví dụ
Lớp PersonalAccessTokenAuth
Lớp 13 có cùng mục đích và được sử dụng giống như lớp 01, nhưng sử dụng Mã thông báo truy cập cá nhân](https. //Cứu giúp. hoạt cảnh. com/current/server/en-us/security_personal_access_tokens. htm) thay vì tên người dùng và mật khẩuThuộc tính TênMô tả 15Tên mã thông báo truy cập cá nhân. 16Giá trị mã thông báo truy cập cá nhân. 05Điều này tương ứng với thuộc tính 06 trong Tableau REST API. 05 là phần của URL theo sau 08 trong URL. Ví dụ: “MarketingTeam” là 05 trong URL sau MyServer/#/site/MarketingTeam/projects. Để chỉ định trang web mặc định trên Tableau Server, bạn có thể sử dụng một chuỗi rỗng 10 (dấu nháy đơn, không khoảng trắng). Đối với Tableau Cloud, bạn phải cung cấp giá trị cho 05tập tin nguồn. xác thực mô hình/personal_access_token. py Ví dụ 0phương thức xác thựcTableau Server Client cung cấp hai phương thức để tương tác với tài nguyên xác thực. Các phương thức này tương ứng với các điểm cuối đăng nhập và đăng xuất trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/auth_endpoint. py Xem thêm Đăng nhập và Đăng xuất xác thực. đăng nhậpĐăng nhập bạn vào Tableau Server Phương thức đăng nhập vào Tableau Server hoặc Tableau Cloud và quản lý mã thông báo xác thực. Bạn gọi phương thức này từ đối tượng máy chủ mà bạn tạo. Để biết thông tin về đối tượng máy chủ, hãy xem. Mã thông báo xác thực giúp bạn đăng nhập trong 240 phút hoặc cho đến khi bạn gọi phương thức 24. Trước khi bạn sử dụng phương pháp này, trước tiên bạn cần tạo đối tượng yêu cầu đăng nhập ( 25) bằng cách tạo một phiên bản của 01. Để gọi phương thức này, hãy tạo một đối tượng máy chủ cho máy chủ của bạn. Để biết thêm thông tin, hãy xem Đăng nhập và Đăng xuấtAPI REST. Thông số 25. Đối tượng 01 chứa thông tin xác thực đăng nhập cho trang webVí dụ 6xác thực. đăng xuấtĐăng xuất bạn khỏi phiên hiện tại Phương thức 29 xử lý việc vô hiệu hóa mã thông báo xác thực. Để biết thêm thông tin, hãy xem Đăng nhập và Đăng xuấtAPI REST. Ví dụ xác thực. switch_site 8Chuyển sang một trang web khác trên Máy chủ Tableau hiện tại Chuyển đổi tránh nhu cầu xác thực lại cho cùng một máy chủ. (Ghi chú. Phương pháp này không khả dụng trong Tableau Cloud. ) API REST. Thông số 30Trang web mà bạn muốn chuyển sang. Đây phải là một 31 được lấy từ 32, 33 hoặc 34Ví dụ 4Xem thêm kết nốiCác kết nối cho nguồn dữ liệu Tableau Server và sổ làm việc được đại diện bởi một lớp 35. Bạn có thể gọi các phương thức nguồn dữ liệu và sổ làm việc để truy vấn hoặc cập nhật thông tin kết nối. Lớp 36 đại diện cho thông tin kết nối mà bạn có thể cập nhậtLớp kết nốiLớp 35 tương ứng với các kết nối nguồn dữ liệu và sổ làm việcTrong Tableau Server REST API, có các điểm cuối riêng biệt để truy vấn và cập nhật các kết nối nguồn dữ liệu và sổ làm việc Thuộc tính TênMô tả 38Định danh của nguồn dữ liệu. 39Tên của nguồn dữ liệu. 99Số nhận dạng của kết nối. 41Loại kết nối. 03Tên người dùng cho kết nối. 04Mật khẩu được sử dụng để kết nối. 44(Boolean) Xác định có nhúng mật khẩu ( 45) cho sổ làm việc hoặc kết nối nguồn dữ liệu hay không ( 46). 47Địa chỉ máy chủ cho kết nối. 48Cổng được sử dụng để kết nốitập tin nguồn. mô hình/connection_item. py Lớp thông tin kết nối 9Lớp 36 được sử dụng cho các yêu cầu xuất bản sổ làm việc và nguồn dữ liệuThuộc tính AttributeDescription 98Tên người dùng cho kết nối. 51(Boolean) Xác định có nhúng mật khẩu ( 45) cho sổ làm việc hoặc kết nối nguồn dữ liệu hay không ( 46). 04Mật khẩu được sử dụng để kết nối. 55(Boolean) Chỉ định xem OAuth có được sử dụng cho nguồn dữ liệu của kết nối sổ làm việc hay không. Để biết thêm thông tin, hãy xem Kết nối OAuthtập tin nguồn. mô hình/connection_credentials. py Nguồn dữ liệuSử dụng thư viện TSC, bạn có thể lấy tất cả các nguồn dữ liệu trên một trang web hoặc lấy các nguồn dữ liệu cho một dự án cụ thể. Tài nguyên nguồn dữ liệu cho Tableau Server được xác định trong lớp 56. Lớp tương ứng với các tài nguyên nguồn dữ liệu mà bạn có thể truy cập bằng API Tableau Server REST. Ví dụ: bạn có thể thu thập thông tin về tên của nguồn dữ liệu, loại, kết nối và dự án được liên kết với nguồn dữ liệu đó. Các phương thức nguồn dữ liệu dựa trên các điểm cuối cho nguồn dữ liệu trong API REST và hoạt động trên lớp 56Lớp DatasourceItem 9 56 đại diện cho tài nguyên nguồn dữ liệu trên Tableau Server. Đây là thông tin có thể được gửi hoặc trả lại trong phản hồi đối với yêu cầu API REST cho các nguồn dữ liệu. Khi bạn tạo một phiên bản 56 mới, bạn phải chỉ định 60 mà nguồn dữ liệu được liên kết vớiThuộc tính TênMô tả 61Xác định xem nguồn dữ liệu có cho phép sử dụng Dữ liệu Hỏi hay không. Giá trị có thể là 62, 63 hoặc 64. Nếu không có cài đặt nào được chỉ định, nó sẽ mặc định là SiteDefault. Xem để biết thêm thông tin về ask_data_enablement. 65Danh sách kết nối dữ liệu ( 35) cho nguồn dữ liệu được chỉ định. Trước tiên, bạn phải gọi phương thức 67 để truy cập dữ liệu này. xem. 68Tên của nguồn dữ liệu sẽ xuất hiện trong một URL. 69Ngày và giờ khi nguồn dữ liệu được tạo. 70Một giá trị Boolean cho biết liệu nguồn dữ liệu có được chứng nhận hay không. 71Ghi chú tùy chọn mô tả nguồn dữ liệu được chứng nhận. 72Loại nguồn dữ liệu, ví dụ: 73 hoặc 74. 75Mô tả cho nguồn dữ liệu. 76Một giá trị Boolean để xác định xem nguồn dữ liệu có nên được mã hóa hay không. Xem Phương pháp giải nén và mã hóa để biết thêm thông tin. 77Một giá trị Boolean cho biết liệu nguồn dữ liệu có trích xuất hay không. 99Số nhận dạng cho nguồn dữ liệu. Bạn cần giá trị này để truy vấn một nguồn dữ liệu cụ thể hoặc để xóa một nguồn dữ liệu bằng các phương thức 79 và 80. 98Tên của nguồn dữ liệu. Nếu không được chỉ định, tên của tệp nguồn dữ liệu đã xuất bản sẽ được sử dụng. 00Số nhận dạng của chủ sở hữu nguồn dữ liệu. 60Số nhận dạng của dự án được liên kết với nguồn dữ liệu. Bạn phải cung cấp số nhận dạng này khi bạn tạo một phiên bản của 56. 85Tên của dự án được liên kết với nguồn dữ liệu. 86Các thẻ (danh sách các chuỗi) đã được thêm vào nguồn dữ liệu. 87Ngày và giờ khi nguồn dữ liệu được cập nhật lần cuối. 88Một giá trị Boolean cho biết có cho phép hay không cho phép trang web Tableau Cloud của bạn sử dụng ứng dụng khách Tableau Bridge. Bridge cho phép bạn duy trì các nguồn dữ liệu có kết nối trực tiếp với các nguồn dữ liệu tại chỗ được hỗ trợ. Xem Định cấu hình và quản lý Nhóm khách hàng cầu nối để biết thêm thông tin. 89Url của nguồn dữ liệu như được hiển thị trong trình duyệtVí dụ 02tập tin nguồn. mô hình/datasource_item. py phương pháp nguồn dữ liệuTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên nguồn dữ liệu hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/điểm cuối nguồn dữ liệu. py nguồn dữ liệu. xóa bỏ 0Xóa nguồn dữ liệu đã chỉ định khỏi Tableau Server Thông số TênMô tả 38Số nhận dạng ( 99) cho 56 mà bạn muốn xóa khỏi máy chủngoại lệ ErrorDescription 93Raise một ngoại lệ nếu một 38 hợp lệ không được cung cấpAPI REST. nguồn dữ liệu. Tải xuống 1Tải xuống nguồn dữ liệu được chỉ định ở định dạng 95 hoặc 96API REST. Thông số TênMô tả 38Số nhận dạng ( 99) cho 56 mà bạn muốn tải xuống từ máy chủ. 000(Tùy chọn) Tải tệp xuống vị trí bạn chỉ định. Nếu không có vị trí nào được chỉ định (mặc định là 001), tệp sẽ được tải xuống thư mục làm việc hiện tại. 002(Tùy chọn) Chỉ định có tải xuống tệp có giải nén hay không. Mặc định là bao gồm phần trích xuất, nếu có (______3003). Khi nguồn dữ liệu có phần trích xuất, nếu bạn đặt tham số 004, phần trích xuất sẽ không được bao gồm. Bạn có thể sử dụng tham số này để cải thiện hiệu suất nếu bạn đang tải xuống các nguồn dữ liệu có trích xuất lớn. Có sẵn bắt đầu với Tableau Server REST API phiên bản 2. 5. 005(Không dùng nữa) Thay vào đó, hãy sử dụng 002. Giá trị mặc định là bỏ qua tham số này (______3007). Nếu bạn đặt tham số thành 008, quá trình tải xuống sẽ không bao gồm phần trích xuất (nếu có). Nếu được đặt thành 009, quá trình tải xuống sẽ bao gồm phần trích xuất (nếu có). Có sẵn bắt đầu với Tableau Server REST API phiên bản 2. 5ngoại lệ ErrorDescription 93Raise một ngoại lệ nếu một 38 hợp lệ không được cung cấptrả lại Đường dẫn tệp đến nguồn dữ liệu đã tải xuống. Nguồn dữ liệu được tải xuống ở định dạng 95 hoặc 96Ví dụ 2nguồn dữ liệu. được 3Trả về tất cả các nguồn dữ liệu cho trang web Để có được thông tin kết nối cho từng nguồn dữ liệu, trước tiên bạn phải điền vào 56 thông tin kết nối bằng phương pháp. Để biết thêm thông tin, xemAPI REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một nguồn dữ liệu cụ thể, bạn có thể chỉ định tên của dự án hoặc id của dự ántrả lại Trả về danh sách đối tượng 56 và đối tượng 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 4nguồn dữ liệu. get_by_id 5Trả về mục nguồn dữ liệu đã chỉ định API REST. Thông số TênMô tả 38The 38 chỉ định nguồn dữ liệu để truy vấnngoại lệ ErrorDescription 93Raise một ngoại lệ nếu một 38 hợp lệ không được cung cấptrả lại 56. Nhìn thấyVí dụ 6nguồn dữ liệu. popated_connections 7Điền các kết nối cho nguồn dữ liệu được chỉ định Phương pháp này lấy thông tin kết nối cho nguồn dữ liệu được chỉ định. API REST được thiết kế để chỉ trả lại thông tin bạn yêu cầu một cách rõ ràng. Khi bạn truy vấn tất cả các nguồn dữ liệu, thông tin kết nối sẽ không được đưa vào. Sử dụng phương pháp này để truy xuất các kết nối. Phương thức thêm danh sách các kết nối dữ liệu vào mục nguồn dữ liệu (______3023). Đây là danh sách các đối tượng 35API REST. Thông số TênMô tả 025The 025 chỉ định nguồn dữ liệu để điền thông tin kết nốingoại lệ ErrorDescription 027Phát sinh lỗi nếu datasource_item không được chỉ địnhtrả lại Không có. Một danh sách các đối tượng 35 được thêm vào nguồn dữ liệu ( 023)Ví dụ 8nguồn dữ liệu. công bố 9Xuất bản nguồn dữ liệu lên máy chủ hoặc nối thêm dữ liệu vào nguồn dữ liệu hiện có Phương pháp này kiểm tra kích thước của nguồn dữ liệu và tự động xác định xem xuất bản nguồn dữ liệu thành nhiều phần hay trong một thao tác API REST. Thông số TênMô tả 025_______3025 chỉ định nguồn dữ liệu mới mà bạn đang thêm hoặc nguồn dữ liệu bạn đang thêm vào. Nếu bạn đang thêm một nguồn dữ liệu mới, bạn cần tạo một 025 mới với một 60 của một dự án hiện có. Tên của nguồn dữ liệu sẽ là tên của tệp, trừ khi bạn cũng chỉ định tên cho nguồn dữ liệu mới khi tạo phiên bản. Nhìn thấy. 034Đường dẫn tệp hoặc đối tượng tệp của nguồn dữ liệu để xuất bản. 035Chỉ định xem bạn có đang xuất bản nguồn dữ liệu mới ( 036), ghi đè lên nguồn dữ liệu hiện có ( 037) hay nối thêm dữ liệu vào nguồn dữ liệu ( 038). Nếu bạn đang nối thêm vào một nguồn dữ liệu, thì nguồn dữ liệu trên máy chủ và nguồn dữ liệu bạn đang xuất bản phải được trích xuất (. tde) và chúng phải chia sẻ cùng một lược đồ. Bạn cũng có thể sử dụng các thuộc tính chế độ xuất bản, chẳng hạn. 039. 040(Tùy chọn) Thông tin đăng nhập cần thiết để kết nối với nguồn dữ liệu. Đối tượng 36 chứa thông tin xác thực cho nguồn dữ liệu (tên người dùng và mật khẩu cũng như liệu thông tin đăng nhập có được nhúng hay OAuth được sử dụng hay không). 042(Tùy chọn) Nếu giá trị này được đặt thành 45, hoạt động xuất bản sẽ không đồng bộ và trả về một Mục công việcngoại lệ ErrorDescription 044Raise lỗi đường dẫn tệp không chính xác hoặc nếu tệp bị thiếu. 045Phát sinh lỗi nếu chế độ xuất bản không phải là một trong các tùy chọn được xác định. 046Xảy ra lỗi nếu loại tệp được chỉ định không được hỗ trợtrả lại 56 cho nguồn dữ liệu đã được thêm hoặc nối vàoVí dụ 0nguồn dữ liệu. Làm tươi 1Làm mới dữ liệu của trích xuất được chỉ định API REST. Thông số TênMô tả 025The 025 chỉ định nguồn dữ liệu để cập nhậtngoại lệ ErrorDescription 027Phát sinh lỗi nếu datasource_item không được chỉ định. Sử dụng phương pháp 051 để truy xuất thông tin nhận dạng cho các nguồn dữ liệu trên máy chủtrả lại Một 052 được làm mớiVí dụ 2 3Cập nhật nguồn dữ liệu được chỉ định API REST. Thông số TênMô tả 025The 025 chỉ định nguồn dữ liệu để cập nhậtngoại lệ ErrorDescription 027Phát sinh lỗi nếu datasource_item không được chỉ định. Sử dụng phương pháp 051 để truy xuất thông tin nhận dạng cho các nguồn dữ liệu trên máy chủtrả lại Một 56 được cập nhậtVí dụ 4 5Cập nhật địa chỉ máy chủ, cổng, tên người dùng hoặc mật khẩu cho kết nối nguồn dữ liệu được chỉ định API REST. Thông số TênMô tả 025The 025 chỉ định nguồn dữ liệu để cập nhật. 060The 060 có thông tin bạn muốn cập nhậttrả lại Một 35 được cập nhật cho nguồn dữ liệuVí dụ Xem mẫu 063 trong thư mục Mẫu 6Cập nhật dữ liệu có trong nguồn dữ liệu trực tiếp đến Hyper đã xuất bản API REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 3. 13 trở lên Thông số TênMô tả 064Hoặc là 065 hoặc 35. Nếu nguồn dữ liệu chỉ chứa một kết nối duy nhất, thì 065 là đủ để xác định dữ liệu nào sẽ được cập nhật. Mặt khác, đối với các nguồn dữ liệu có nhiều kết nối, phải cung cấp một 35. 069Người dùng cung cấp chuỗi tùy ý để xác định yêu cầu. Một yêu cầu được xác định bằng cùng một khóa sẽ chỉ được thực hiện một lần, ngay cả khi các yêu cầu bổ sung sử dụng khóa được thực hiện, chẳng hạn như do thử lại khi gặp sự cố mạng. 070a danh sách các hành động (chèn, cập nhật, xóa,…) chỉ định cách sửa đổi dữ liệu trong nguồn dữ liệu đã xuất bản 071an (tùy chọn) Siêu tệp chứa các bộ sẽ được chèn/xóa hoặc dữ liệu tải trọng khác được sử dụng bởi 070Để biết thêm thông tin về 070, xem. Để tạo tệp Hyper 071, bạn có thể sử dụng Hyper API hoặc pantabtrả lại Một 052 cho công việc cập nhật trên máy chủ. Sau khi hoàn thành công việc này, dữ liệu đã được cập nhậtVí dụ Xem mẫu 076 trong thư mục Mẫubộ lọcThư viện TSC cung cấp một lớp 077 mà bạn có thể sử dụng để lọc kết quả trả về từ máy chủBạn có thể sử dụng các lớp 077 và 079 để lọc và sắp xếp các điểm cuối sau
Để biết thêm thông tin, hãy xem Lọc và Sắp xếp lớp lọc 7Lớp 077 tương ứng với các biểu thức lọc trong Tableau REST APIThuộc tính TênMô tả 081Được xác định trong lớp 082. 083Được định nghĩa trong lớp 084 085Giá trị để so sánh với trường và toán tử được chỉ địnhCác nhómSử dụng thư viện TSC, bạn có thể lấy thông tin về tất cả các nhóm trên một trang web, bạn có thể thêm hoặc xóa nhóm hoặc thêm hoặc xóa người dùng trong một nhóm Các tài nguyên nhóm cho Tableau Server được xác định trong lớp 086. Lớp tương ứng với các tài nguyên nhóm mà bạn có thể truy cập bằng API REST của Tableau Server. Các phương thức nhóm dựa trên các điểm cuối cho các nhóm trong API REST và hoạt động trên lớp 086Lớp GroupItemLớp 086 chứa các thuộc tính cho tài nguyên nhóm trên Tableau Server. Lớp 086 xác định thông tin bạn có thể yêu cầu hoặc truy vấn từ Tableau Server. Các thành viên lớp tương ứng với các thuộc tính của yêu cầu máy chủ hoặc tải trọng phản hồitập tin nguồn. mô hình/nhóm_item. py Thuộc tính TênMô tả 090Tên của miền Active Directory ( 091 nếu sử dụng xác thực cục bộ). 99Id của nhóm. _______ 3093 Danh sách người dùng (_______ 3094). 98Tên nhóm. 98 là bắt buộc khi bạn tạo một thể hiện của một nhóm. 097Vai trò cấp quyền cho người dùng được thêm vào nhóm. 098Chế độ xác định thời điểm áp dụng giấy phép cho thành viên nhóm. Khi chế độ là 099, giấy phép được cấp cho mỗi thành viên nhóm khi họ đăng nhập vào một trang web. Khi chế độ là 600, giấy phép sẽ được cấp cho các thành viên nhóm mỗi khi miền được đồng bộ hóaVí dụ 8phương pháp nhómTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên nhóm hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/điểm cuối nhóm. py các nhóm. thêm người dùng 9Thêm người dùng vào nhóm được chỉ định API REST Thông số TênMô tả 601The 601 chỉ định nhóm để cập nhật. 603Id của người dùngtrả lại Không có Ví dụ 00các nhóm. tạo raTạo một nhóm cục bộ mới trong Tableau Server API REST. Thông số TênMô tả 601The 601 chỉ định nhóm để thêm. Trước tiên, bạn tạo một phiên bản mới của 086 và chuyển phiên bản đó cho phương thức nàyTrả lại Thêm mới 086Ví dụ 01các nhóm. tạo_AD_group 02Tạo một nhóm thư mục hoạt động trong Tableau Server API REST. Thông số TênMô tả 601The 601 chỉ định nhóm để thêm. Trước tiên, bạn tạo một phiên bản mới của 086 và chuyển phiên bản đó cho phương thức này. 611Cờ Boolean được sử dụng để chỉ định hoạt động không đồng bộ. Nếu set là 45 thì giá trị trả về sẽ là JobItem chứa trạng thái của queued job. Nhìn thấyTrả về Trả về 086 hoặc 052 đã tạo nếu cờ asJob được đặt thành TrueVí dụ 03các nhóm. xóa bỏXóa nhóm trên trang web API REST. Thông số TênMô tả 615Số nhận dạng ( 99) cho nhóm mà bạn muốn xóa khỏi máy chủngoại lệ ErrorDescription 617Raise một ngoại lệ nếu một 615 hợp lệ không được cung cấpVí dụ 04các nhóm. được 05Trả về thông tin về các nhóm trên trang web Để có được thông tin về người dùng trong một nhóm, trước tiên bạn phải điền vào 086 thông tin người dùng bằng phương phápAPI REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một nhóm cụ thể, bạn có thể chỉ định tên của nhóm hoặc id nhómtrả lại Trả về một danh sách các đối tượng 086 và một đối tượng 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 06các nhóm. popated_users 07Điền vào 601 với danh sách người dùngAPI REST. Thông số TênMô tả 601The 601 chỉ định nhóm để điền thông tin người dùng. 015(Tùy chọn) Tùy chọn yêu cầu bổ sung để gửi đến điểm cuốingoại lệ 627. Phát sinh lỗi nếu 601 không được chỉ địnhtrả lại Không có. Một danh sách các đối tượng 094 được thêm vào nhóm ( 630)Ví dụ 08các nhóm. remove_user 09Xóa người dùng khỏi nhóm API REST. Thông số TênMô tả 601The 601 chỉ định nhóm để xóa người dùng khỏi. 603Id cho người dùngngoại lệ ErrorDescription 634Xảy ra lỗi nếu 601 không được điềntrả lại Không có. Người dùng bị xóa khỏi nhóm Ví dụ 60 61Cập nhật một nhóm trong Tableau Server API REST. Thông số TênMô tả 601The 601 chỉ định nhóm để cập nhật. 042(Tùy chọn) Nếu giá trị này được đặt thành 45, thao tác cập nhật sẽ không đồng bộ và trả về một JobItem. Điều này chỉ được hỗ trợ cho các nhóm Active Directory. Theo mặc định, giá trị này được đặt thành 46ngoại lệ ErrorDescription 641Raise error nếu 601 thiếu thuộc tính 99. 644Thuộc tính 042 được đặt thành 45 cho một nhóm cục bộtrả lại Đối tượng 086 được cập nhật. Nếu 042 được đặt thành 45, thay vào đó, một 052 sẽ được trả vềVí dụ 62công việcSử dụng thư viện TSC, bạn có thể lấy thông tin về quy trình (hoặc công việc) không đồng bộ trên máy chủ. Những công việc này có thể được tạo khi Tableau chạy một số tác vụ có thể chạy lâu, chẳng hạn như nhập hoặc đồng bộ hóa người dùng từ Active Directory hoặc chạy làm mới giải nén. Ví dụ: các phương thức API REST để tạo hoặc cập nhật nhóm, để chạy tác vụ làm mới trích xuất hoặc để xuất bản sổ làm việc có thể nhận tham số 611 ( 652) để tạo quy trình nền (công việc) để hoàn thành lệnh gọi. Thông tin về công việc không đồng bộ được trả về từ phương thứcNếu bạn có mã định danh của công việc, bạn có thể sử dụng thư viện TSC để tìm hiểu trạng thái của công việc không đồng bộ Các thuộc tính công việc được định nghĩa trong lớp 052. Lớp tương ứng với các thuộc tính cho các công việc mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức công việc dựa trên các điểm cuối cho các công việc trong API REST và hoạt động trên lớp 052Lớp hạng mục công việc 63Lớp 052 chứa thông tin về công việc được chỉ định đang chạy trên Tableau Server. Lớp 052 xác định thông tin bạn có thể truy vấn từ Tableau Server. Các thành viên lớp tương ứng với các thuộc tính của tải trọng phản hồi của máy chủtập tin nguồn. mô hình/job_item. py Thuộc tính TênMô tả 99The 99 của công việc. 659Loại nhiệm vụ. Các loại tương ứng với các danh mục loại công việc được liệt kê cho API REST. 69Thời gian công việc được tạo. 661Thời gian bắt đầu công việc. 662Thời gian hoàn thành công việc. 663Mã trả về từ công việc. 664Tiến độ công việc. 665Các ghi chú của công việc. 035Chế độ làm việcphương pháp công việcCác phương thức Công việc dựa trên các điểm cuối cho các công việc trong API REST và hoạt động trên lớp 052tập tin nguồn. máy chủ/điểm cuối/jobs_endpoint. py việc làm. get_by_idNhận thông tin về công việc được chỉ định API REST. Thông số TênMô tả 668_______3668 chỉ định id của công việc được trả về từ một tác vụ không đồng bộ, chẳng hạn như làm mới giải nén hoặc nhập hoặc cập nhật cho các nhóm bằng Active Directoryngoại lệ ErrorDescription 670Raise error nếu không tìm thấy 668trả lại Trả về 052 được yêu cầuVí dụ 64việc làm. wait_for_job 65Đợi cho đến khi một công việc nhất định kết thúc thành công. Liên tục thăm dò máy chủ bằng cách sử dụng 673 cho đến khi hoàn thành công việc. Nó sử dụng thời gian ngủ tăng theo cấp số nhân giữa các cuộc thăm dò để đảm bảo thời gian phản hồi nhanh chóng cho các công việc chạy nhanh trong khi không đặt tải quá lớn lên máy chủ cho các công việc chạy dàiTrong trường hợp công việc thất bại hoặc bị hủy bỏ, 674 sẽ đưa ra một ngoại lệThông số TênMô tả 668The 668 chỉ định id của công việc mà chúng tôi muốn đợi cho 677Khoảng thời gian chờ tùy chọn tính bằng giây. 674 sẽ tăng 679 nếu công việc chưa hoàn thành sau khi đợi 677 giâytrả lại Trả về 052 cuối cùngThông thường, bạn chỉ có thể loại bỏ giá trị trả về mà không cần kiểm tra trạng thái công việc. Trong trường hợp công việc không thành công, _______ 3674 đã đưa ra một ngoại lệ. Đối với các tình huống nâng cao, anh ấy đã trả lại 052 vẫn có thể thú vị khi truy cập e. g. thời gian bắt đầu và kết thúc hoặc 665Ví dụ Xem mẫu 076 hoặc 686 trong thư mục MẫuSử dụng điểm cuối 687, người ta có thể sử dụng GraphQL để truy vấn siêu dữ liệu trên, e. g. , sổ làm việc, nguồn dữ liệu, các trường có trong chúng và mối quan hệ giữa chúngCác phương thức Siêu dữ liệu gọi API Siêu dữ liệu là giao diện GraphQL cho phép truy vấn siêu dữ liệu về các đối tượng trên máy chủ (sổ làm việc, nguồn dữ liệu,…) và mối quan hệ giữa chúng tập tin nguồn. máy chủ/điểm cuối/điểm cuối siêu dữ liệu. py metadata. truy vấn 66Thực hiện truy vấn siêu dữ liệu và trả về kết quả Thông số TênMô tả 688Truy vấn GraphQL 689Các biến cho truy vấn GraphQL 690Có nên đưa ra ngoại lệ do lỗi khôngtrả lại Phương thức này trả về kết quả truy vấn dưới dạng cấu trúc của 691 và 692 như được trả về bởi gói 693Ví dụ Xem mẫu 694 trong thư mục Mẫusố liệuSử dụng thư viện TSC, bạn có thể nhận thông tin về tất cả các chỉ số trên một trang web, cập nhật hoặc xóa các chỉ số Lớp MetricItem 67Tài nguyên số liệu cho Tableau được xác định trong lớp 695. Lớp tương ứng với tài nguyên số liệu mà bạn có thể truy cập bằng API REST của Tableau ServerTên thuộc tính. Sự miêu tả. —. . — 98. Tên của số liệu 99. Id API REST cho số liệu 75. Mô tả của số liệu 89. URL cho chỉ số 69. Đối tượng ngày giờ khi số liệu được tạo 87. Đối tượng ngày giờ khi số liệu được cập nhật 802. Boolean cho nếu số liệu ở trạng thái tạm ngưng 60. Id API REST cho dự án có chứa số liệu 85. Tên của dự án chứa số liệu 00. Id API REST cho người dùng sở hữu số liệu 806. Id API REST cho chế độ xem từ đó số liệu được tạotập tin nguồn. mô hình/metric_item. py phương pháp số liệuCác phương pháp số liệu dựa trên các điểm cuối cho số liệu trong API REST và hoạt động trên lớp 695. Điểm cuối số liệu cũng hỗ trợ lọc kiểu django. Xem Lọc và Sắp xếp để biết thêm thông tintập tin nguồn. máy chủ/điểm cuối/điểm cuối số liệu. py chỉ số. xóa bỏ 68Xóa một mục chỉ số khỏi một trang web Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 810Id của chỉ số cần xóatrả lại Không có Ví dụ 69chỉ số. đượcTrả về danh sách các mục số liệu cho một trang web Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số Không có trả lại Trả về một Tuple chứa danh sách tất cả các đối tượng 695 và một 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 80chỉ số. get_by_id 81Trả lại một mục chỉ số cụ thể từ trang web Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 810Id của chỉ số mong muốntrả lại Trả về một đối tượng 695 tương ứng với ID được yêu cầuVí dụ 82Cập nhật một mục số liệu trên Tableau Server Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 821_______3695 đã thay đổi sẽ được cập nhật trên Máy chủ Tableautrả lại Trả về một đối tượng 695 phản ánh những thay đổi được áp dụng cho Tableau ServerVí dụ 83dự ánSử dụng thư viện TSC, bạn có thể lấy thông tin về tất cả các dự án trên một trang hoặc bạn có thể tạo, cập nhật dự án hoặc xóa dự án Tài nguyên dự án cho Tableau được xác định trong lớp 824. Lớp tương ứng với các tài nguyên dự án mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức của dự án dựa trên các điểm cuối cho các dự án trong API REST và hoạt động trên lớp 824lớp ProjectItem 84Tài nguyên dự án cho Tableau được xác định trong lớp 824. Lớp tương ứng với các tài nguyên dự án mà bạn có thể truy cập bằng API Tableau Server RESTThuộc tính TênMô tả 827Đặt hoặc hiển thị các quyền đối với nội dung trong dự án. Các tùy chọn là 828 hoặc 829. 98Tên dự án. 75Mô tả dự án. 99ID dự án. 833Id của dự án mẹ. Sử dụng tùy chọn này để tạo phân cấp dự án. Để biết thông tin về quản lý dự án, phân cấp dự án và quyền, hãy xem Sử dụng dự án để quản lý quyền truy cập nội dungtập tin nguồn. mô hình/dự án_item. py Dự ánItem. Nội dungQuyềnLớp 824 có một lớp con định nghĩa các quyền cho dự án ( 835). Các tùy chọn là 828 và 829. Để biết thông tin về các quyền nội dung này, hãy xemTênMô tả 838Khóa tất cả các quyền đối với nội dung đối với dự án. 839Người dùng có thể quản lý quyền đối với nội dung mà họ sở hữu. Đây là mặc địnhVí dụ 85phương pháp dự ánCác phương thức của dự án dựa trên các điểm cuối cho các dự án trong API REST và hoạt động trên lớp 824tập tin nguồn. máy chủ/điểm cuối/dự án_endpoint. py dự án. tạo ra 86Tạo một dự án trên trang web được chỉ định Để tạo một dự án, trước tiên bạn tạo một phiên bản mới của 824 và chuyển nó vào phương thức tạo. Để chỉ định trang web để tạo dự án mới, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 844Chỉ định các thuộc tính cho dự án. 844 là gói yêu cầu. Để tạo gói yêu cầu, hãy tạo một phiên bản mới của 824Trả về Trả về mục dự án mới Ví dụ 87dự án. đượcTrả về danh sách các mục dự án cho một trang web Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số Không có trả lại Trả về một danh sách tất cả các đối tượng 824 và một 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 88 89Sửa đổi cài đặt dự án Bạn có thể sử dụng phương pháp này để cập nhật tên dự án, mô tả dự án hoặc quyền của dự án. Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 844Đối tượng mục dự án phải bao gồm ID dự án. Các giá trị trong mục dự án sẽ ghi đè cài đặt dự án hiện tạingoại lệ ErrorDescription 854Raise một ngoại lệ nếu mục dự án không có ID. ID dự án được gửi đến máy chủ như một phần của URItrả lại Trả về thông tin dự án được cập nhật Nhìn thấy Ví dụ 40dự án. xóa bỏ 41Xóa một dự án theo ID Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 60ID của dự án cần xóangoại lệ ErrorDescription 858Raise một ngoại lệ nếu mục dự án không có ID. ID dự án được gửi đến máy chủ như một phần của URIVí dụ 42dự án. popated_permissions 43Truy vấn các quyền của dự án, phân tích cú pháp và lưu trữ các quyền được trả lại API REST. Thông số TênMô tả 859Một đối tượng dự ánVí dụ 44 45Thêm quyền dự án cho người dùng hoặc nhóm API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 46dự án. xóa_permission 47Xóa quyền dự án API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRule hoặc một đối tượng PermissionsRule đơn lẻVí dụ 48dự án. populate_workbook_default_permissions 49Truy vấn các quyền mặc định của sổ làm việc, phân tích cú pháp và lưu trữ các quyền được trả về API REST. Thông số TênMô tả 859Một đối tượng dự ánVí dụ 90dự án. populate_datasource_default_permissions 91Truy vấn các quyền nguồn dữ liệu mặc định, phân tích cú pháp và lưu trữ các quyền được trả về API REST. Thông số TênMô tả 859Một đối tượng dự ánVí dụ 92dự án. populate_flow_default_permissions 93Truy vấn các quyền luồng mặc định, phân tích cú pháp và lưu trữ các quyền được trả về API REST. Thông số TênMô tả 859Một đối tượng dự ánVí dụ 94 95Thêm hoặc cập nhật quyền sổ làm việc mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 96 97Thêm hoặc cập nhật quyền nguồn dữ liệu mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 98 99Thêm hoặc cập nhật quyền dòng mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 90dự án. xóa_workbook_default_permissions 91Xóa quyền sổ làm việc mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 92dự án. xóa_datasource_default_permissions 93Xóa quyền truy cập nguồn dữ liệu mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 94dự án. xóa_flow_default_permissions 95Xóa quyền lưu lượng mặc định API REST. Thông số TênMô tả 859Một đối tượng dự án. 861Một danh sách các đối tượng PermissionsRuleVí dụ 96yêu cầuThư viện TSC cung cấp một lớp 079 mà bạn có thể sử dụng để lọc kết quả trả về từ máy chủBạn có thể sử dụng các lớp 880 và 079 để lọc và sắp xếp các điểm cuối sau
Bạn có thể sử dụng 882 và 883 để đặt tùy chọn cho các chế độ xem được trả về dưới dạng hình ảnh và tệp PDFĐể biết thêm thông tin về lọc và sắp xếp, hãy xem Lọc và sắp xếp lớp RequestOptions 97Thuộc tính TênMô tả 884Số trang của kết quả trả về. Giá trị mặc định là 1. 885Số lượng mục sẽ trả về với mỗi trang (giá trị mặc định là 100). 886Trả về một tập hợp các đối tượng 880 có thể lặp lại. 888Trả về một tập hợp các đối tượng 077 có thể lặp lạiYêu cầuTùy chọn. lớp lĩnh vựcLớp 082 tương ứng với các trường được sử dụng trong các biểu thức lọc trong Tableau REST API. Để biết thêm thông tin, hãy xem Lọc và sắp xếp trong Tableau REST APIThuộc tính Thuộc tính FieldDescription 891Giống như ‘createdAt’ trong API REST. TSC. 892 893Giống như ‘lastLogin’ trong API REST. 894 895Giống như 'tên' trong API REST. 896 897Giống như ‘tên chủ sở hữu’ trong API REST. 898 899Giống như 'siteRole' trong API REST. 400 401Giống như 'thẻ' trong API REST. 402 403Giống như 'updatedAt' trong API REST. 404Yêu cầuTùy chọn. lớp toán tửChỉ định các toán tử bạn có thể sử dụng để lọc các yêu cầu Thuộc tính OperatorDescription 405Đặt toán tử bằng (giống như 406 trong API REST). 407 408Đặt toán tử lớn hơn (giống như 409 trong API REST). 410 411Đặt toán tử lớn hơn hoặc bằng (giống như 412 trong API REST). 413 414Đặt toán tử nhỏ hơn (giống như 415 trong API REST). 416 417Đặt toán tử nhỏ hơn hoặc bằng (giống như 418 trong API REST). 419 420Đặt toán tử vào (giống như 421 trong API REST). 422Yêu cầuTùy chọn. lớp hướngChỉ định hướng sắp xếp các trường được trả về Thuộc tính TênMô tả 423Đặt hướng sắp xếp thành tăng dần ( 424) 425Đặt hướng sắp xếp thành giảm dần ( 426)Lớp CSVRequestOptions 98Sử dụng lớp này để chỉ định các bộ lọc chế độ xem sẽ được áp dụng khi dữ liệu CSV được tạo. Theo tùy chọn, bạn có thể chỉ định tuổi tối đa của dữ liệu CSV được lưu trong bộ nhớ cache trên máy chủ bằng cách cung cấp giá trị 427. Xem 428Thuộc tính TênMô tả 427Tùy chọn. Số phút tối đa mà dữ liệu CSV sẽ được lưu vào bộ nhớ cache trên máy chủ trước khi được làm mới. Giá trị phải là số nguyên trong khoảng từ 430 đến 431 phút. 432 sẽ được hiểu là 1 phút trên máy chủ, vì đó là khoảng thời gian ngắn nhất được phép. Theo mặc định, 427 được đặt thành 434, cho biết hành vi mặc định được định cấu hình trong cài đặt máy chủVí dụ 99lớp ImageRequestOptions 020Sử dụng lớp này để chỉ định độ phân giải của chế độ xem và tùy chọn tuổi tối đa của hình ảnh được lưu trong bộ nhớ cache trên máy chủ. Bạn cũng có thể sử dụng lớp này để chỉ định các bộ lọc chế độ xem sẽ được áp dụng khi hình ảnh được tạo. Xem 435Thuộc tính TênMô tả 436Độ phân giải của chế độ xem được trả về dưới dạng hình ảnh. Nếu không được chỉ định, phương thức 435 sẽ trả về một hình ảnh có độ phân giải tiêu chuẩn (chiều rộng của hình ảnh được trả về là 784 pixel). Nếu bạn đặt giá trị tham số này cao (______4438), chiều rộng của ảnh được trả về là 1568 pixel. Đối với cả hai độ phân giải, chiều cao thay đổi để duy trì tỷ lệ khung hình của chế độ xem. 427Tùy chọn. Số phút tối đa hình ảnh sẽ được lưu vào bộ nhớ cache trên máy chủ trước khi được làm mới. Giá trị phải là số nguyên trong khoảng từ 430 đến 431 phút. 432 sẽ được hiểu là 1 phút trên máy chủ, vì đó là khoảng thời gian ngắn nhất được phép. Theo mặc định, 427 được đặt thành 434, cho biết hành vi mặc định được định cấu hình trong cài đặt máy chủXem bộ lọc Bạn có thể sử dụng phương pháp 445 để thêm bộ lọc chế độ xem. Khi hình ảnh được tạo, các bộ lọc được chỉ định sẽ được áp dụng cho chế độ xemVí dụ 021lớp PDFRequestOptions 022Sử dụng lớp này để chỉ định định dạng của PDF được trả về cho chế độ xem. Theo tùy chọn, bạn có thể chỉ định tuổi tối đa của tệp PDF được hiển thị được lưu vào bộ nhớ đệm trên máy chủ bằng cách cung cấp giá trị 427. Xem 447Thuộc tính NameDescription 448Loại trang được trả về ở định dạng PDF cho chế độ xem. page_type được đặt bằng lớp 449. ______4450 451 452 453 454 . Các tùy chọn là dọc và ngang. Các tùy chọn được đặt bằng lớp 463. 455 456 457 458 459 460 461 462The orientation of the page. The options are portrait and landscape. The options are set using the 463 class:______4464 465 427Tùy chọn. Số phút tối đa mà tệp PDF kết xuất sẽ được lưu vào bộ nhớ cache trên máy chủ trước khi được làm mới. Giá trị phải là số nguyên trong khoảng từ 430 đến 431 phút. 432 sẽ được hiểu là 1 phút trên máy chủ, vì đó là khoảng thời gian ngắn nhất được phép. Theo mặc định, 427 được đặt thành 434, cho biết hành vi mặc định được định cấu hình trong cài đặt máy chủ. Xem bộ lọc Bạn có thể sử dụng phương pháp 445 để thêm bộ lọc xem. Khi PDF được tạo, các bộ lọc được chỉ định sẽ được áp dụng cho chế độ xemVí dụ 023lịch trìnhSử dụng thư viện TSC, bạn có thể lên lịch giải nén các tác vụ làm mới hoặc đăng ký trên Tableau Server. Bạn cũng có thể nhận và cập nhật thông tin về các tác vụ đã lên lịch hoặc xóa các tác vụ đã lên lịch Nếu bạn có mã định danh của công việc, bạn có thể sử dụng thư viện TSC để tìm hiểu trạng thái của công việc không đồng bộ Các thuộc tính lịch biểu được định nghĩa trong lớp 473. Lớp tương ứng với các thuộc tính cho lịch biểu mà bạn có thể truy cập trong Tableau Server hoặc bằng cách sử dụng API REST của Tableau Server. Các phương thức Lịch trình dựa trên các điểm cuối cho các công việc trong API REST và hoạt động trên lớp 052Lịch trình Hạng mục 024Lớp 473 chứa thông tin về lịch trình được chỉ định chạy trên Tableau Server. Lớp 473 xác định thông tin bạn có thể truy vấn và đặt. Các thành viên lớp tương ứng với các thuộc tính của tải trọng phản hồi của máy chủtập tin nguồn. mô hình/schedule_item. py Thuộc tính TênMô tả 98The 98 của lịch trình. 479Mức độ ưu tiên của lịch trình (số nguyên). Giá trị thấp hơn thể hiện mức độ ưu tiên cao hơn, với 432 cho biết mức độ ưu tiên cao nhất. 481Loại nhiệm vụ. Các loại là 482 cho tác vụ làm mới trích xuất hoặc 483 cho đăng ký theo lịch trình. 484Chỉ định cách chạy tác vụ theo lịch trình. Các lựa chọn là 485 sử dụng tất cả các quy trình nền có sẵn cho tác vụ đã lên lịch này hoặc 486 giới hạn lịch trình này cho một quy trình nền. 487Chỉ định tần suất mà tác vụ đã lên lịch sẽ chạy. 487 là một thể hiện của lớp 489. 487 có các thuộc tính về tần suất (hàng giờ, hàng ngày, hàng tuần, hàng tháng) cũng như ngày giờ mà mục đã lên lịch chạy. Bạn đặt giá trị này bằng cách khai báo một đối tượng 489 là một trong những đối tượng sau. 492, 493, 494 hoặc 495Lớp IntervalItemLớp này đặt tần suất và thời gian bắt đầu của mục đã lên lịch. Lớp này chứa các lớp cho khoảng thời gian hàng giờ, hàng ngày, hàng tuần và hàng tháng. Lớp này phản ánh các tùy chọn bạn có thể đặt bằng API REST và giao diện Máy chủ Tableau Thuộc tính TênMô tả 492Chạy mục đã lên lịch hàng giờ. Để đặt khoảng thời gian hàng giờ, bạn tạo một phiên bản của lớp 492 và gán các giá trị sau. 498, 499 và 900. Để đặt 498 và 499, hãy gán giá trị thời gian bằng cú pháp này. 903giờ 904 phút 905 và 906giờ 904 phút 905. Giờ được chỉ định trong thời gian 24 giờ. 900 chỉ định tần suất chạy tác vụ trong khoảng thời gian bắt đầu và kết thúc. Các tùy chọn được thể hiện bằng giờ. Ví dụ: 910 cứ sau 15 phút. Các giá trị là 911, 912, 430, 914, 915, 916, 917, 918. Lịch trình hàng giờ chạy thường xuyên hơn 60 phút một lần phải có thời gian bắt đầu và kết thúc vào giờ đó. 493Chạy mục đã lên lịch hàng ngày. Để đặt khoảng thời gian hàng ngày, bạn tạo một phiên bản của 493 và chỉ định 498. Thời gian bắt đầu sử dụng cú pháp 903giờ____5904 phút 905. 494Chạy mục đã lên lịch mỗi tuần một lần. Để đặt khoảng thời gian hàng tuần, bạn tạo một phiên bản của 494 và chỉ định thời gian bắt đầu cũng như nhiều phiên bản cho 900 (các ngày trong tuần và thời gian bắt đầu). Thời gian bắt đầu sử dụng cú pháp 928giờ 904 phút 905. 900 là ngày trong tuần, được thể hiện dưới dạng 489. Ví dụ: 933 cho Thứ Hai. 495Chạy mục đã lên lịch mỗi tháng một lần. Để đặt khoảng thời gian hàng tháng, bạn tạo một phiên bản của 495 và chỉ định ngày và giờ bắt đầu. Cácphương pháp lịch trìnhCác phương thức lịch trình dựa trên các điểm cuối cho lịch trình trong API REST và hoạt động trên lớp 473tập tin nguồn. máy chủ/điểm cuối/schedules_endpoint. py lịch trình. add_to_schedule 025Thêm một 56, 938, hoặc 939 vào một lịch biểuAPI REST. Thông số TênMô tả 940Số nhận dạng (id) của lịch trình để thêm nguồn dữ liệu hoặc sổ làm việc vào. Có thể được lấy từ một 473, e. g. , bằng cách thực hiện 942. 943(Tùy chọn) Một 939 nên được thêm vào lịch trình. Chỉ cung cấp 943 hoặc 946, việc chuyển nhiều mục sẽ không được chấp nhận. 946(Tùy chọn) Một 56 nên được thêm vào lịch trình. Chỉ cung cấp 943 hoặc 946, việc chuyển nhiều mục sẽ không được chấp nhận. 951(Tùy chọn) Một 938 nên được thêm vào lịch trình. Chỉ áp dụng nếu 953 và 954. 955(Tùy chọn) Xác định loại nhiệm vụ. Một trong số 956. 957, 958, 959Returns Trả về một danh sách của 960Ví dụ 026lịch trình. tạo ra 027Tạo một lịch trình mới để làm mới trích xuất hoặc đăng ký API REST. Thông số TênMô tả 961Các cài đặt cho lịch biểu mà bạn muốn tạo. Bạn cần tạo một thể hiện của 473 và truyền nó cho phương thức 963. 473 bao gồm 489 chỉ định tần suất hoặc khoảng thời gian mà lịch trình sẽ chạytrả lại Trả về một thể hiện mới của 961ngoại lệ ErrorDescription 967Raise một ngoại lệ nếu 968 không được chỉ định. Mục khoảng thời gian chỉ định xem khoảng thời gian là hàng giờ, hàng ngày, hàng tuần hay hàng thángVí dụ 028lịch trình. xóa bỏ 029Xóa lịch biểu hiện có để làm mới trích xuất hoặc đăng ký API REST. Thông số 940Số nhận dạng ( 970) của lịch biểu cần xóa. Sử dụng phương pháp 971 để lấy mã định danh của lịch trình trên máy chủtrả lại Không có ngoại lệ ErrorDescription 972Số nhận dạng không phải là số nhận dạng hợp lệ cho lịch biểu trên máy chủlịch trình. đượcTrả về tất cả các mục lịch trình từ máy chủ API REST. lịch trình. get_by_id 00Trả về lịch trình đã chỉ định API REST. Thông số TênMô tả 015(Tùy chọn) Các tùy chọn yêu cầu bổ sung để gửi đến điểm cuối 01Thông số TênMô tả 961Cài đặt cho lịch biểu mà bạn muốn cập nhật. Bạn cần tìm nạp một phiên bản hiện có của 473 từ phương thức 976, thực hiện các thay đổi của bạn, sau đó chuyển nó sang phương thức 977 để cập nhật lịch biểu trên máy chủ. 473 bao gồm 489 chỉ định tần suất hoặc khoảng thời gian mà lịch trình sẽ chạyAPI REST. Ví dụ lịch trình hàng giờ 02Ví dụ lịch trình hàng ngày 03Ví dụ về lịch trình hàng tuần 04Ví dụ về lịch biểu hàng tháng 05Người phục vụTrong Tableau REST API, máy chủ ( 980) là cơ sở hoặc lõi của URI tạo nên các điểm cuối hoặc phương thức khác nhau để truy cập tài nguyên trên máy chủ (chế độ xem, sổ làm việc, trang web, người dùng, nguồn dữ liệu, v.v. ) Thư viện TSC cung cấp một lớp 981 đại diện cho máy chủ. Bạn tạo một phiên bản máy chủ để đăng nhập vào máy chủ và gọi các phương thức khác nhau để truy cập tài nguyênlớp máy chủLớp 981 chứa các thuộc tính đại diện cho máy chủ trên Tableau Server. Sau khi bạn tạo một thể hiện của lớp 981, bạn có thể đăng nhập vào máy chủ và gọi các phương thức để truy cập tất cả các tài nguyên trên máy chủThuộc tính AttributeDescription_______347Chỉ định địa chỉ của Tableau Server hoặc Tableau Cloud (ví dụ: 980). 986Chỉ định phiên bản API REST sẽ sử dụng (ví dụ: 987). Khi bạn sử dụng thư viện TSC để gọi các phương thức truy cập Tableau Server, 986 được chuyển đến điểm cuối như một phần của URI ( 989). Mỗi bản phát hành của Tableau Server đều hỗ trợ các phiên bản cụ thể của API REST. Các phiên bản mới của API REST được phát hành với Tableau Server. Theo mặc định, giá trị của 986 được đặt thành 991, tương ứng với Tableau Server 10. 0. Bạn có thể xem hoặc đặt giá trị này. Bạn có thể cần đặt giá trị này thành một giá trị khác, ví dụ: nếu bạn muốn truy cập các tính năng được máy chủ hỗ trợ và phiên bản mới hơn của API REST. Để biết thêm thông tin, hãy xem Phiên bản API RESTVí dụ 06Người phục vụ. Tài nguyênKhi bạn tạo một phiên bản của lớp 981, bạn có quyền truy cập vào các tài nguyên trên máy chủ sau khi đăng nhập. Bạn có thể chọn các tài nguyên này và các phương thức của chúng làm thành viên của lớp, chẳng hạn. 993Tài nguyênMô tảmáy chủ. xác thực authSets để đăng nhập và đăng xuất. Xem máy chủ. lượt xemTruy cập các lượt xem và phương thức của máy chủ. Xem máy chủ. người dùngTruy cập tài nguyên và phương pháp người dùng. Xem máy chủ. các trang webTruy cập các trang web. Xem máy chủ. nhómTruy cập các tài nguyên và phương thức của nhóm. Xem máy chủ. công việcTruy cập các tài nguyên và phương pháp công việc. Xem máy chủ. workbooksTruy cập tài nguyên và phương pháp cho workbooks. Xem máy chủ. nguồn dữ liệuTruy cập tài nguyên và phương pháp cho nguồn dữ liệu. Xem máy chủ. dự ánTruy cập tài nguyên và phương pháp cho dự án. Xem máy chủ. lịch trìnhTruy cập tài nguyên và phương pháp cho lịch trình. Xem máy chủ. đăng kýTruy cập tài nguyên và phương pháp đăng ký. Xem máy chủ. server_infoTruy cập tài nguyên và phương pháp cho thông tin máy chủ. Nhìn thấyNgười phục vụ. Chế độ xuất bảnLớp 981 có lớp 995 liệt kê các tùy chọn xác định điều gì sẽ xảy ra khi bạn phát hành sổ làm việc hoặc nguồn dữ liệu. Các tùy chọn là 037, 038 hoặc 036Tính chất ResourceDescription 999Ghi đè sổ làm việc hoặc nguồn dữ liệu. 900Nối thêm vào sổ làm việc hoặc nguồn dữ liệu. 901Tạo một sổ làm việc hoặc nguồn dữ liệu mớiVí dụ 07lớp ServerInfoItem 08Lớp 902 chứa thông tin phiên bản và bản dựng cho Tableau Server. Thông tin máy chủ được truy cập bằng phương thức 903, phương thức này trả về một thể hiện của lớp 904Thuộc tính TênMô tả 905Hiển thị phiên bản của Tableau Server hoặc Tableau Cloud (ví dụ: 10. 2. 0). 906Hiển thị số bản dựng cụ thể (ví dụ: 10200. 17. 0329. 1446). 907Hiển thị số phiên bản API REST được hỗ trợ. Lưu ý rằng giá trị này có thể khác với giá trị mặc định được chỉ định cho máy chủ, với thuộc tính 908. Để tận dụng các tính năng mới, bạn nên truy vấn máy chủ và đặt 908 khớp với số phiên bản API REST được hỗ trợPhương thức ServerInfoThư viện TSC cung cấp một phương thức để truy cập thông tin phiên bản và bản dựng từ Tableau Server server_info. đượcTruy xuất thông tin phiên bản và bản dựng cho máy chủ Phương pháp này thực hiện một cuộc gọi chưa được xác thực, vì vậy không cần đăng nhập hoặc mã thông báo xác thực API REST. Thông số Không có ngoại lệ ErrorDescription 910Raise một ngoại lệ nếu không tìm thấy điểm cuối thông tin máy chủVí dụ 09trang webSử dụng thư viện TSC, bạn có thể truy vấn một trang hoặc nhiều trang trên máy chủ hoặc tạo hoặc xóa một trang trên máy chủ Tài nguyên trang web cho Tableau Server và Tableau Cloud được xác định trong lớp 31. Lớp tương ứng với các tài nguyên trang web mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức trang web dựa trên các điểm cuối cho các trang web trong API REST và hoạt động trên lớp 31lớp SiteItem 10Lớp 31 chứa các thành viên hoặc thuộc tính cho tài nguyên trang trên Tableau Server hoặc Tableau Cloud. Lớp 31 xác định thông tin bạn có thể yêu cầu hoặc truy vấn từ Tableau Server hoặc Tableau Cloud. Các thành viên lớp tương ứng với các thuộc tính của yêu cầu máy chủ hoặc tải trọng phản hồiThuộc tính Thuộc tínhMô tả____098Tên của trang web. Tên của trang web mặc định là “”. 68Đường dẫn đến trang web. 917(Tùy chọn) Chỉ dành cho Máy chủ Tableau. Chỉ định 918 để cho phép quản trị viên trang sử dụng giao diện máy chủ và các lệnh tabcmd để thêm và xóa người dùng. (Việc chỉ định tùy chọn này không cấp cho quản trị viên trang quyền quản lý người dùng bằng API REST. ) Chỉ định 919 để ngăn quản trị viên trang thêm hoặc xóa người dùng. (Quản trị viên máy chủ luôn có thể thêm hoặc xóa người dùng. )______6920(Tùy chọn) Chỉ định số lượng người dùng tối đa cho trang web. Nếu bạn không chỉ định giá trị này, giới hạn sẽ phụ thuộc vào loại giấy phép được định cấu hình cho máy chủ. Đối với giấy phép dựa trên người dùng, số lượng người dùng tối đa được đặt theo giấy phép. Đối với cấp phép dựa trên lõi, không có giới hạn về số lượng người dùng. Nếu bạn chỉ định giá trị tối đa, thì chỉ những người dùng được cấp phép mới được tính và quản trị viên máy chủ bị loại trừ. Loại trừ lẫn nhau với cài đặt cấp giấy phép theo tầng. 921(Tùy chọn) Chỉ định dung lượng tối đa cho trang web mới, tính bằng megabyte. Nếu bạn đặt hạn ngạch và trang web vượt quá hạn ngạch đó, nhà xuất bản sẽ không được tải nội dung mới lên cho đến khi trang web lại nằm dưới hạn mức. 922(Tùy chọn) Chỉ định 923 để ngăn người dùng không thể đăng ký sổ làm việc trên trang được chỉ định. Mặc định là 924. 925(Tùy chọn) Chỉ định 924 để ngăn người quản trị máy chủ, người quản trị trang và chủ sở hữu nội dung hoặc dự án không thể đăng ký người dùng khác vào sổ làm việc trên trang được chỉ định. Mặc định là 923. 928(Tùy chọn) Chỉ định 923 để bật lịch sử sửa đổi cho tài nguyên nội dung (sổ làm việc và nguồn dữ liệu). Mặc định là 924. 931(Tùy chọn) Chỉ định số lần sửa đổi nguồn nội dung (sổ làm việc hoặc nguồn dữ liệu) để cho phép. Trên Tableau Server, mặc định là 25. 932Hiển thị trạng thái hiện tại của trang web ( 933 hoặc 934)Ví dụ 11tập tin nguồn. mô hình/site_item. py phương pháp trang webThư viện TSC cung cấp các phương thức hoạt động trên các site cho Tableau Server và Tableau Cloud. Các phương thức này tương ứng với các điểm cuối hoặc phương thức cho các trang trong Tableau REST API tập tin nguồn. máy chủ/điểm cuối/sites_endpoint. py trang web. tạo raTạo một trang web mới trên máy chủ cho đối tượng mục trang web đã chỉ định Chỉ máy chủ Tableau API REST. Thông số TênMô tả 30Cài đặt cho trang mà bạn muốn tạo. Bạn cần tạo một thể hiện của 31 và truyền nó cho phương thức 963trả lại Trả về một thể hiện mới của 31Ví dụ 12trang web. đượcTruy vấn tất cả các trang web trên máy chủ API REST. Thông số Không có trả lại Trả về một danh sách tất cả các đối tượng 31 và một 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 13trang web. get_by_idTruy vấn trang web với ID đã cho API REST. Thông số TênMô tả 05Id của trang web bạn muốn truy vấnngoại lệ ErrorDescription 942Raise error nếu id không được chỉ địnhtrả lại Trả về 31Ví dụ 14trang web. get_by_name 15Truy vấn trang web với tên được chỉ định API REST. Thông số TênMô tả 944Tên của trang web bạn muốn truy vấnngoại lệ ErrorDescription ________ 6945 Phát sinh lỗi nếu tên không được chỉ địnhtrả lại Trả về 31Ví dụ 16Sửa đổi cài đặt cho trang web Đối tượng mục trang web phải bao gồm ID trang web và ghi đè tất cả các cài đặt khác API REST. Thông số TênMô tả 30Mục trang web mà bạn muốn cập nhật. Cài đặt được chỉ định trong mục trang sẽ ghi đè cài đặt trang hiện tạingoại lệ ErrorDescription 948Id trang web phải có và phải khớp với id của trang web bạn đang cập nhật. 949Để đặt 920, 951 phải được đặt thành 918trả lại Trả về 30 đã cập nhậtVí dụ 17trang web. xóa bỏXóa trang web được chỉ định API REST. Thông số TênMô tả 05Id của trang web mà bạn muốn xóangoại lệ ErrorDescription 955Phải có id trang web và phải khớp với id của trang web bạn đang xóaVí dụ 18LoạiLớp 880 được sử dụng với các tùy chọn yêu cầu ( 079) nơi bạn có thể lọc và sắp xếp các kết quả được trả về từ máy chủBạn có thể sử dụng các tùy chọn sắp xếp và yêu cầu để lọc và sắp xếp các điểm cuối sau
Sắp xếp lớpThuộc tính TênMô tả 958Đặt trường để sắp xếp. Các trường được định nghĩa trong lớp 959. 960Hướng sắp xếp, tăng dần ( 423) hoặc giảm dần ( 425). Các tùy chọn được định nghĩa trong lớp 963Ví dụ 19Để biết thông tin về cách sử dụng lớp 880, hãy xem Lọc và Sắp xếpđăng kýSử dụng thư viện TSC, bạn có thể quản lý các đăng ký cho các dạng xem hoặc sổ làm việc trên một site. Bạn có thể nhận thông tin về tất cả các đăng ký trên một trang hoặc thông tin về một đăng ký cụ thể trên một trang và bạn có thể tạo, cập nhật hoặc xóa các đăng ký Lớp mục đăng kýTài nguyên đăng ký cho Tableau Server được xác định trong lớp 965. Lớp tương ứng với các tài nguyên đăng ký mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức đăng ký dựa trên các điểm cuối cho đăng ký trong API REST và hoạt động trên lớp 965 20Thuộc tính TênMô tả 99Id của đăng ký trên trang web. 968Đặt giá trị này thành 45 sẽ khiến người đăng ký nhận được thư có. hình ảnh png của sổ làm việc hoặc dạng xem được đính kèm với nó. Theo mặc định, giá trị này được đặt thành 45. Nếu 971 được đặt thành 46, thì giá trị này không thể được đặt thành 46. 971Đặt giá trị này thành 45 sẽ khiến người đăng ký nhận thư có. tệp pdf chứa hình ảnh của sổ làm việc hoặc dạng xem được đính kèm với nó. Theo mặc định, giá trị này được đặt thành 46. 977Nội dung văn bản của email đăng ký. 978Hướng của các trang được tạo ra khi 971 là 45. Nếu không có tham số này, hướng trang sẽ mặc định là 981. Xem biểu đồ bên dưới để biết danh sách đầy đủ các giá trị. 982Loại trang được tạo, xác định kích thước trang khi 971 là 45. Nếu không có tham số này, loại trang sẽ mặc định là 985. Xem biểu đồ bên dưới để biết danh sách đầy đủ các giá trị. 940Id của lịch trình được liên kết với đăng ký cụ thể. 987Chỉ áp dụng cho chế độ xem (xem thuộc tính 988). Nếu 45, một hình ảnh được gửi ngay cả khi chế độ xem được chỉ định trong đăng ký trống. Nếu 46, không có gì được gửi nếu chế độ xem trống. Giá trị mặc định là 45. 992Chủ đề đăng ký. Đây là mô tả mà bạn cung cấp để xác định đăng ký. 802Đặt giá trị này thành 45 sẽ ngừng gửi email cho đăng ký đã chỉ định. Đặt nó thành 46 sẽ tiếp tục gửi email cho đăng ký. 988Mục tiêu của đăng ký, tức là nội dung được đăng ký (xem, sổ làm việc). Mục tiêu là một thể hiện của lớp 988. 988 có hai thuộc tính, 99 của sổ làm việc hoặc dạng xem ( 0200) và 659 ( 0202), có thể là 0203 hoặc 943. Thuộc tính 987 chỉ có thể được đặt thành 45 nếu 0202 được đặt thành 0208. 603Số nhận dạng của người dùng (người) nhận đăng ký
971 được đặt thành 45)AttributeValid options 978 0213 0214 982 0216 0217 0218 0219 0220 0221 0222 0223 0224 0225 0226 0227tập tin nguồn. máy chủ/điểm cuối/subscription_item. máy chủ py/request_options. py phương thức đăng kýTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên đăng ký hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/đăng ký_endpoint. py đăng ký. tạo ra 21Tạo đăng ký cho một dạng xem hoặc sổ làm việc cho một người dùng cụ thể theo một lịch biểu cụ thể. Khi người dùng đăng ký nội dung, Tableau Server sẽ gửi nội dung cho người dùng qua email theo lịch trình được xác định trên Tableau Server và được chỉ định trong 0228Để tạo đăng ký mới, trước tiên bạn cần tạo một 0228 mới (từ lớp 965)API REST. Thông số TênMô tả 0228Chỉ định người dùng đăng ký, nội dung đăng ký, lịch trình liên kết đăng ký và siêu dữ liệu khác cho đăng kýtrả lại Trả về đối tượng 965 mớiVí dụ 22đăng ký. xóa bỏ 23Xóa đăng ký được chỉ định khỏi trang web API REST. Thông số TênMô tả 0233Số nhận dạng ( 99) cho đăng ký mà bạn muốn xóa khỏi trang webngoại lệ ErrorDescription 0235Raise một ngoại lệ nếu một 0233 hợp lệ không được cung cấpVí dụ 24đăng ký. được 25Trả về thông tin về đăng ký trên trang web được chỉ định API REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một đăng ký cụ thể, bạn có thể chỉ định chủ đề của đăng ký hoặc id của đăng kýTrả về Trả về một danh sách các đối tượng 965 và một đối tượng 017. Sử dụng các giá trị này để lặp qua các kết quảđăng ký. get_by_id 26Trả về thông tin về đăng ký được chỉ định API REST. Thông số Tên Mô tả 0233The 0233 chỉ định đăng ký để truy vấnngoại lệ ErrorDescription 0242Raise một ngoại lệ nếu một 0233 hợp lệ không được cung cấptrả lại 965. Nhìn thấyVí dụ 27 28Cập nhật một thuê bao cụ thể. Để cập nhật đăng ký, trước tiên bạn phải truy vấn đăng ký đó từ máy chủ bằng phương pháp 0245 hoặc 0246API REST. Thông số TênMô tả 0228Chỉ định người dùng đăng ký, nội dung đăng ký, lịch trình liên kết đăng ký và siêu dữ liệu khác cho đăng kýtrả lại Trả về đối tượng 965 đã cập nhậtVí dụ 29nhiệm vụSử dụng thư viện TSC, bạn có thể nhận thông tin về tất cả các tác vụ trên một trang web và bạn có thể xóa các tác vụ. Để tạo nhiệm vụ mới, hãy xem Tài nguyên tác vụ cho Tableau Server được xác định trong lớp 0249. Lớp tương ứng với các tài nguyên tác vụ mà bạn có thể truy cập bằng API REST của Tableau Server. Các phương thức tác vụ dựa trên các điểm cuối cho các tác vụ trong API REST và hoạt động trên lớp 0249Lớp nhiệm vụ 30Thuộc tính TênMô tả 99Id của nhiệm vụ trên trang web. 955Loại tác vụ trích xuất - làm mới toàn bộ hoặc gia tăng. 479Mức độ ưu tiên của nhiệm vụ trên máy chủ. 0254Số lần thực hiện liên tiếp không thành công. 940Id của lịch trình trên trang web. 988Một đối tượng, 946 hoặc 943, được liên kết với tác vụ. tập tin nguồn. mô hình/mục tiêu. pyVí dụ 31tập tin nguồn. mô hình/task_item. py phương pháp nhiệm vụTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên tác vụ hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/tác vụ_endpoint. py nhiệm vụ. được 32Trả về thông tin về các tác vụ trên trang được chỉ định API REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầutrả lại Trả về một danh sách các đối tượng 0249 và một đối tượng 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 33nhiệm vụ. get_by_idTrả về thông tin về tác vụ được chỉ định API REST. Thông số TênMô tả 0262The 0262 chỉ định tác vụ cần truy vấnngoại lệ ErrorDescription 0264Raise một ngoại lệ nếu một 0262 hợp lệ không được cung cấptrả lại 0249. Nhìn thấyVí dụ 34nhiệm vụ. chạyChạy tác vụ làm mới giải nén được chỉ định Để chạy một tác vụ làm mới trích xuất, trước tiên bạn cần tra cứu tác vụ 0267 (lớp ______10249)API REST. Thông số TênMô tả 0267Bạn có thể truyền phương thức cho đối tượng tác vụtrả lại Trả về phản hồi API REST Ví dụ 35nhiệm vụ. xóa bỏXóa tác vụ làm mới trích xuất API REST. Thông số TênMô tả________ 10262 ________ 10262 chỉ định tác vụ cần xóangoại lệ ErrorDescription 0264Raise một ngoại lệ nếu một 0262 hợp lệ không được cung cấpVí dụ 36người dùngSử dụng thư viện TSC, bạn có thể lấy thông tin về tất cả người dùng trên một trang và bạn có thể thêm hoặc xóa người dùng hoặc cập nhật thông tin người dùng Tài nguyên người dùng cho Tableau Server được xác định trong lớp 094. Lớp tương ứng với tài nguyên người dùng mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức người dùng dựa trên các điểm cuối dành cho người dùng trong API REST và hoạt động trên lớp 094Lớp người dùng 37Lớp 094 chứa các thành viên hoặc thuộc tính cho tài nguyên xem trên Tableau Server. Lớp 094 xác định thông tin bạn có thể yêu cầu hoặc truy vấn từ Tableau Server. Các thành viên lớp tương ứng với các thuộc tính của yêu cầu máy chủ hoặc tải trọng phản hồiThuộc tính NameDescription 0278(Tùy chọn) Thuộc tính này chỉ dành cho Tableau Cloud. Loại xác thực mới cho người dùng. Bạn có thể gán các giá trị sau cho thuộc tính này. 0279 (người dùng đăng nhập bằng SAML) hoặc 0280 (người dùng đăng nhập bằng phương thức xác thực được đặt cho máy chủ). Các giá trị này xuất hiện trong tab Xác thực trên trang Cài đặt trong Tableau Cloud – giá trị thuộc tính 0279 tương ứng với Đăng nhập một lần và giá trị 0280 tương ứng với TableauID. 090Tên của trang web. 0284ID đại diện được lưu trữ trong hệ thống đăng nhập một lần (SSO) của Tableau. Giá trị 0285 được trả về cho Tableau Cloud. Đối với các cấu hình máy chủ khác, trường này chứa null. 99Id của người dùng trên trang web. 0287Ngày và giờ người dùng đăng nhập lần cuối. 0288Các sổ làm việc mà người dùng sở hữu. Bạn phải chạy phương thức popated_workbooks để thêm sổ làm việc vào 094. 0290Địa chỉ email của người dùng. 0291Tên đầy đủ của người dùng. 98Tên người dùng. Thuộc tính này là bắt buộc khi bạn đang tạo phiên bản 094. 0294Vai trò của người dùng trên trang web. Thuộc tính này là bắt buộc nếu bạn đang tạo phiên bản 094. Xem Vai trò người dùng bên dưới để biết chi tiết. 0296Các nhóm mà người dùng thuộc về. Bạn phải chạy phương thức popated_groups để thêm các nhóm vào 094Vai trò người dùng Vai trò người dùng có thể có cho thuộc tính 0294 như sau
Ghi chú. Nếu bất kỳ thao tác nào liên quan đến 0294 của người dùng gây ra phản hồi lỗi 400 (ví dụ:. 009), đảm bảo bạnVí dụ 38tập tin nguồn. mô hình/user_item. py phương pháp người dùngTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên người dùng hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/điểm cuối người dùng. py người dùng. cộngThêm người dùng vào trang web Để thêm người dùng mới vào trang web, trước tiên bạn cần tạo một 010 mới (từ lớp 094). Khi bạn tạo người dùng mới, bạn chỉ định tên của người dùng và vai trò trang web của họ. Đối với Tableau Cloud, bạn cũng chỉ định thuộc tính 0278 trong yêu cầu của mình. Khi bạn thêm người dùng vào Tableau Cloud, tên của người dùng phải là địa chỉ email được sử dụng để đăng nhập vào Tableau Cloud. Sau khi bạn thêm người dùng, Tableau Cloud sẽ gửi cho người dùng lời mời qua email. Người dùng có thể nhấp vào liên kết trong lời mời để đăng nhập và cập nhật tên đầy đủ và mật khẩu của họAPI REST. Thông số NameDescription 010Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một người dùng cụ thể, bạn có thể chỉ định tên của người dùng hoặc id của người dùngtrả lại Trả về đối tượng 094 mớiVí dụ 39người dùng. được 40Trả về thông tin về người dùng trên trang web được chỉ định Để lấy thông tin về sổ làm việc mà người dùng sở hữu hoặc có quyền xem, trước tiên bạn phải điền vào 094 thông tin sổ làm việc bằng phương phápAPI REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một người dùng cụ thể, bạn có thể chỉ định tên của người dùng hoặc id của người dùngtrả lại Trả về một danh sách các đối tượng 094 và một đối tượng 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 41người dùng. get_by_idTrả về thông tin về người dùng được chỉ định API REST. Thông số NameDescription 603The 603 chỉ định người dùng để truy vấnngoại lệ ErrorDescription 021Raise một ngoại lệ nếu một 603 hợp lệ không được cung cấptrả lại 094. Nhìn thấyVí dụ 42người dùng. populate_favorites 43Trả về danh sách yêu thích (dạng xem, sổ làm việc và nguồn dữ liệu) cho người dùng Hiện chưa triển khai người dùng. popated_groups 44Trả về các nhóm mà người dùng thuộc về API REST. Thông số TênMô tả 010The 010 chỉ định người dùng cư trú với tư cách thành viên nhómngoại lệ ErrorDescription 026Raise error nếu 010 không được chỉ địnhtrả lại Danh sách 086Một 017 điểm ( 030). Nhìn thấyVí dụ 45người dùng. popated_workbooks 46Trả về thông tin về sổ làm việc mà người dùng được chỉ định sở hữu và có quyền Đọc (xem) đối với Phương pháp này lấy thông tin sổ làm việc cho người dùng được chỉ định. API REST được thiết kế để chỉ trả lại thông tin bạn yêu cầu một cách rõ ràng. Khi bạn truy vấn tất cả người dùng, thông tin sổ làm việc cho từng người dùng sẽ không được đưa vào. Sử dụng phương pháp này để truy xuất thông tin về sổ làm việc mà người dùng sở hữu hoặc có quyền Đọc (xem). Phương thức thêm danh sách sổ làm việc vào đối tượng mục người dùng ( 031)API REST. Thông số TênMô tả 010The 010 chỉ định người dùng điền thông tin sổ làm việcngoại lệ ErrorDescription 026Raise error nếu 010 không được chỉ địnhtrả lại Danh sách 939Một 017 điểm ( 031). Nhìn thấyVí dụ 47người dùng. gỡ bỏXóa người dùng được chỉ định khỏi trang web API REST. Thông số TênMô tả 603Số nhận dạng ( 99) cho người dùng mà bạn muốn xóa khỏi máy chủngoại lệ ErrorDescription 041Raise một ngoại lệ nếu một 603 hợp lệ không được cung cấpVí dụ 48 49Cập nhật thông tin về người dùng được chỉ định Thông tin bạn có thể sửa đổi tùy thuộc vào việc bạn đang sử dụng Tableau Server hay Tableau Cloud và liệu bạn đã định cấu hình Tableau Server để sử dụng xác thực cục bộ hay Active Directory. Để biết thêm thông tin, xem API REST. Thông số Tên Mô tả 010The 010 chỉ định người dùng cập nhật. 04(Tùy chọn) Mật khẩu mới cho người dùngngoại lệ ErrorDescription 026Raise error nếu 010 không được chỉ địnhtrả lại Một 094 được cập nhật. Nhìn thấyVí dụ 50Lượt xemSử dụng thư viện TSC, bạn có thể lấy thông tin về các dạng xem trong một trang hoặc sổ làm việc View resource cho Tableau Server được định nghĩa trong lớp 049. Lớp tương ứng với các tài nguyên chế độ xem mà bạn có thể truy cập bằng API Tableau Server REST. Các phương thức xem dựa trên các điểm cuối cho các chế độ xem trong API REST và hoạt động trên lớp 049lớp ViewItemLớp 049 chứa các thành viên hoặc thuộc tính cho tài nguyên xem trên Tableau Server. Lớp 049 xác định thông tin bạn có thể yêu cầu hoặc truy vấn từ Tableau Server. Các thành viên lớp tương ứng với các thuộc tính của yêu cầu máy chủ hoặc tải trọng phản hồitập tin nguồn. mô hình/view_item. py Thuộc tính TênMô tả 68Tên của chế độ xem sẽ xuất hiện trong URL. 054Dữ liệu CSV của chế độ xem. Trước tiên, bạn phải gọi phương thức 428 để truy cập dữ liệu CSV. 99Số nhận dạng của mục xem. 057Hình ảnh của chế độ xem. Trước tiên, bạn phải gọi phương thức ________ 4435 để truy cập hình ảnh. 98Tên của chế độ xem. 00ID của chủ sở hữu chế độ xem. 061Bản PDF của chế độ xem. Trước tiên, bạn phải gọi phương thức 447 để truy cập nội dung PDF. 063Hình ảnh thu nhỏ cho chế độ xem. Trước tiên, bạn phải gọi phương thức 064 để truy cập hình ảnh xem trước. 60ID của dự án chứa chế độ xem. 066Số liệu thống kê sử dụng cho chế độ xem. Cho biết tổng số lần xem đã được xem. 067ID của sổ làm việc được liên kết với dạng xemPhương thức xemTableau Server Client cung cấp các phương thức để tương tác với tài nguyên xem hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối cho các chế độ xem trong Tableau Server REST API tập tin nguồn. máy chủ/điểm cuối/lượt xem_endpoint. py lượt xem. được 51Trả về danh sách các mục dạng xem cho một trang web API REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 2. 0 trở lên Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một chế độ xem cụ thể, bạn có thể chỉ định tên của chế độ xem hoặc ID của chế độ xem đó. 069(Tùy chọn) Nếu đúng ( 070) trả về số liệu thống kê sử dụng cho các lượt xem. Mặc định là 071trả lại Trả về một danh sách tất cả các đối tượng 049 và một 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 52Ví dụ sử dụng Máy nhắn tin Bạn cũng có thể sử dụng trình tạo Pager được cung cấp để có được tất cả các lượt xem trên trang web mà không cần phải xem qua các kết quả 53Nhìn thấy lượt xem. get_by_idTrả về chi tiết của một chế độ xem cụ thể API REST. Phiên bản Điểm cuối này có sẵn REST API phiên bản 3. 1 trở lên Thông số TênMô tả 806ID của chế độ xem cần truy xuấttrả lại Trả về một đối tượng 049 duy nhấtVí dụ 54Nhìn thấy lượt xem. populate_preview_image 55Tạo hình ảnh xem trước cho chế độ xem đã chỉ định Phương pháp này lấy hình ảnh xem trước (hình thu nhỏ) cho mục xem được chỉ định. Phương pháp này sử dụng các trường 99 và 067 để truy vấn hình ảnh xem trước. Phương thức điền vào 063 cho chế độ xemAPI REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 2. 0 trở lên Thông số TênMô tả 079Chỉ định chế độ xem để điềnngoại lệ ErrorDescription 080Phát sinh lỗi nếu ID của dạng xem hoặc sổ làm việc bị thiếutrả lại Không có. Hình ảnh xem trước được thêm vào 079 và có thể được truy cập bằng trường 063 của nóVí dụ 56Nhìn thấy lượt xem. cư_image 57Điền hình ảnh của chế độ xem đã chỉ định Phương pháp này sử dụng trường 99 để truy vấn hình ảnh và điền nội dung hình ảnh dưới dạng trường 057API REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 2. 5 trở lên Thông số Tênmô tả 079Chỉ định chế độ xem để điền. 015(Tùy chọn) Bạn có thể chuyển các tùy chọn yêu cầu để chỉ định độ phân giải hình ảnh ( 436) và tuổi tối đa của hình ảnh xem được lưu trong bộ nhớ cache trên máy chủ ( 427). Xem để biết thêm chi tiếtngoại lệ ErrorDescription 089Lỗi nếu ID của chế độ xem bị thiếutrả lại Không có. Hình ảnh được thêm vào 079 và có thể được truy cập bằng trường 057 của nóVí dụ 58Nhìn thấy lượt xem. popated_csv 59Điền dữ liệu CSV của chế độ xem đã chỉ định Phương pháp này sử dụng trường 99 để truy vấn dữ liệu CSV và điền dữ liệu dưới dạng trường 054API REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 2. 7 trở lên Thông số Tênmô tả 079Chỉ định chế độ xem để điền. 015(Tùy chọn) Bạn có thể chuyển các tùy chọn yêu cầu để chỉ định tuổi tối đa của CSV được lưu trong bộ nhớ cache trên máy chủ. Xem để biết thêm chi tiếtngoại lệ ErrorDescription 089Lỗi nếu ID của chế độ xem bị thiếutrả lại Không có. Dữ liệu CSV được thêm vào 079 và có thể được truy cập bằng trường 054 của nóVí dụ 60Nhìn thấy lượt xem. cư trú_pdf 61Điền vào nội dung PDF của chế độ xem được chỉ định Phương pháp này điền vào một tệp PDF với (các) hình ảnh của chế độ xem bạn chỉ định API REST. Phiên bản Điểm cuối này khả dụng với API REST phiên bản 2. 7 trở lên Thông số Tênmô tả 079Chỉ định chế độ xem để điền. 015(Tùy chọn) Bạn có thể chuyển các tùy chọn yêu cầu để chỉ định loại trang và hướng của nội dung PDF, cũng như tuổi tối đa của tệp PDF được hiển thị trên máy chủ. Xem để biết thêm chi tiếtngoại lệ ErrorDescription 089Lỗi nếu ID của chế độ xem bị thiếutrả lại Không có. Nội dung PDF được thêm vào 079 và có thể được truy cập bằng trường 061 của nóVí dụ 62Nhìn thấy webhookSử dụng Tableau Server Client (TSC), bạn có thể tạo một webhook mới, lấy danh sách tất cả các webhook, nhận thông tin chi tiết về một webhook cụ thể hoặc xóa một webhook Tài nguyên webhook cho Tableau Server và Tableau Cloud được xác định trong lớp 104. Lớp tương ứng với các tài nguyên webhook mà bạn có thể truy cập bằng API Tableau REST. Ví dụ: sử dụng API REST, bạn có thể thu thập thông tin về sổ làm việc, chẳng hạn như tên của Webbook, sự kiện được liên kết với sổ làm việc và URL đích, đồng thời bạn cũng có thể nhận được thông tin tương tự bằng cách sử dụng TSCTableau webhook REST API endpoint có sẵn trong REST API phiên bản 3. 16 trở về sau Lớp WebhookItem 104 đại diện cho các tài nguyên webhook trên Tableau Server hoặc Tableau Cloud. Đây là thông tin có thể được gửi hoặc trả lại để phản hồi yêu cầu API REST dành cho webhookThuộc tính NameDescription 99Số nhận dạng (luid) cho webhook. Bạn cần giá trị này để truy vấn một webhook cụ thể bằng phương thức 79 hoặc để xóa một webhook bằng phương thức 80. 98Tên của webhook. Bạn phải chỉ định điều này khi bạn tạo một phiên bản của 104. 111URL đích cho webhook. URL đích của webhook phải là https và có chứng chỉ hợp lệ. Bạn phải chỉ định điều này khi bạn tạo một phiên bản của 104. 113Tên của sự kiện Tableau kích hoạt webhook của bạn. Đây là 114 hoặc 115. một trong số này được yêu cầu để tạo một phiên bản của 104. Chúng tôi khuyên bạn nên sử dụng 114. Tên sự kiện phải là một trong những sự kiện được hỗ trợ được liệt kê trong bảng Sự kiện kích hoạt. 00Số nhận dạng của chủ sở hữu webhook. Ví dụ 63tập tin nguồn. mô hình/webhook_item. py phương pháp webhookTableau Server Client cung cấp một số phương thức để tương tác với tài nguyên webhook hoặc điểm cuối. Các phương thức này tương ứng với các điểm cuối trong Tableau REST API tập tin nguồn. máy chủ/điểm cuối/điểm cuối webhook. py webhook. tạo ra 64Tạo một webhook mới trên một trang web cụ thể Để tạo một webhook, trước tiên bạn phải tạo một phiên bản mới của 104 và chuyển nó vào phương thức tạoĐể chỉ định trang web sẽ tạo webhook mới, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web 121 và đăng nhập vào trang web đó. Để biết thêm thông tin về cách chỉ định một trang web, hãy xem phầnAPI REST. Thông sốNameDescriptionwebhook_itemChỉ định các thuộc tính cho webhook. webhook_item là gói yêu cầu. Để tạo gói yêu cầu, hãy tạo phiên bản mới của 122. 104 bao gồm 98, đích đến 111 và 113 hoặc 127. 113 hoặc 127 chỉ định sự kiện Tableau sẽ được liên kết với webhookReturns Trả về mục webhook mới Ví dụ 65webhook. xóa bỏ 66Xóa webhook theo ID Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web 121 và đăng nhập vào trang web. Để biết thêm thông tin về cách chỉ định một trang web, hãy xem phầnAPI REST. Thông số TênMô tả 132ID của webhook cần xóangoại lệ ErrorDescription 133Raise một ngoại lệ nếu một 132 không được cung cấpVí dụ 67webhook. được()Trả về danh sách tất cả các webhook cho một trang web. 01 bằng cách sử dụng URL nội dung cho trang web 121 và đăng nhập vào trang web đó. Để biết thêm thông tin về cách chỉ định một trang web, hãy xem phần. API REST. Thông số NameDescription 137(Tùy chọn) Bạn có thể truyền đối tượng yêu cầu thod oa có chứa tham số bổ sung để lọc yêu cầu. Ví dụ: bạn có thể chỉ định tên của webhook hoặc tên của chủ sở hữu. Để biết thêm thông tin, hãy xem Lọc và Sắp xếptrả lại Trả về một danh sách tất cả các đối tượng 824 và một 139. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 68webhook. get_by_id 69Trả về thông tin về sổ làm việc được chỉ định cho một trang web Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web 121 và đăng nhập vào trang web đó. Để biết thêm thông tin về cách chỉ định một trang web, hãy xem phầnThông số TênMô tả 132ID của webhook. ID là dịchngoại lệ ErrorDescription 133Raise một ngoại lệ nếu một 132 không được cung cấpVí dụ 70Tài nguyên bổ sungsách bài tậpSử dụng thư viện TSC, bạn có thể lấy thông tin về một sổ làm việc cụ thể hoặc tất cả các sổ làm việc trên một site và bạn có thể phát hành, cập nhật hoặc xóa sổ làm việc Tài nguyên dự án cho Tableau được xác định trong lớp 939. Lớp tương ứng với các tài nguyên sổ làm việc mà bạn có thể truy cập bằng API Tableau REST. Các phương thức sổ làm việc dựa trên các điểm cuối cho các dự án trong API REST và hoạt động trên lớp 939WorkbookItem lớp 71Tài nguyên sổ làm việc cho Tableau được xác định trong lớp 939. Lớp tương ứng với các tài nguyên sổ làm việc mà bạn có thể truy cập bằng API Tableau REST. Một số phương thức sổ làm việc lấy một thể hiện của lớp 939 làm đối số. Mục sổ làm việc chỉ định dự ánThuộc tính TênMô tả 65Danh sách các kết nối dữ liệu ( 35) cho các nguồn dữ liệu được sổ làm việc sử dụng. Trước tiên bạn phải gọi phương thức để truy cập dữ liệu này. xem. 68Tên của nguồn dữ liệu sẽ xuất hiện trong một URL. 69Ngày và giờ khi nguồn dữ liệu được tạo. 99Số nhận dạng cho sổ làm việc. Bạn cần giá trị này để truy vấn một sổ làm việc cụ thể hoặc để xóa một sổ làm việc bằng các phương thức 79 và 80. 98Tên của sổ làm việc. 00ID của chủ sở hữu. 063Hình ảnh thu nhỏ cho chế độ xem. Trước tiên bạn phải gọi phương thức để truy cập dữ liệu này. 60ID dự án. 85Tên dự án. 161Kích thước của sổ làm việc (tính bằng megabyte). 162(Boolean) Xác định xem sổ làm việc có hiển thị các tab cho dạng xem hay không. 86Các thẻ đã được thêm vào sổ làm việc. 87Ngày và giờ sổ làm việc được cập nhật lần cuối. 165Danh sách dạng xem ( 049) cho sổ làm việc. Trước tiên bạn phải gọi phương thức để truy cập dữ liệu này. xem. 89URL đầy đủ của sổ làm việcVí dụ 72tập tin nguồn. models/workbook_item. py phương pháp sổ làm việcThư viện Tableau Server Client (TSC) cung cấp các phương thức tương tác với workbook. Các phương thức này tương ứng với các điểm cuối trong Tableau Server REST API. Ví dụ: bạn có thể sử dụng thư viện để phát hành, cập nhật, tải xuống hoặc xóa sổ làm việc trên site. Các phương thức hoạt động trên một đối tượng sổ làm việc (______5939) đại diện cho tài nguyên sổ làm việc tập tin nguồn. máy chủ/điểm cuối/điểm cuối sổ làm việc. py sách bài tập. được 73Truy vấn máy chủ và trả về thông tin về sổ làm việc của trang web API REST. Thông số NameDescription 015(Tùy chọn) Bạn có thể truyền vào phương thức một đối tượng yêu cầu có chứa các tham số bổ sung để lọc yêu cầu. Ví dụ: nếu bạn đang tìm kiếm một sổ làm việc cụ thể, bạn có thể chỉ định tên của sổ làm việc hoặc tên của chủ sở hữu. Xem Lọc và Sắp xếptrả lại Trả về một danh sách tất cả các đối tượng 939 và một 017. Sử dụng các giá trị này để lặp qua các kết quảVí dụ 74sách bài tập. get_by_id 75Trả về thông tin về sổ làm việc được chỉ định trên trang web API REST. Thông số NameDescription 067The 067 chỉ định sổ làm việc để truy vấn. ID là LUID (chuỗi thập lục phân 64 bit)ngoại lệ ErrorDescription 174Raise một ngoại lệ nếu một 067 không được cung cấptrả lại 939. Nhìn thấyVí dụ 76sách bài tập. công bố 77Phát hành sổ làm việc lên trang được chỉ định Ghi chú. API REST không thể tự động bao gồm các đoạn trích hoặc các tài nguyên khác mà sổ làm việc sử dụng. Do đó, một. Không thể xuất bản tệp twb sử dụng dữ liệu từ tệp Excel hoặc csv trên máy tính cục bộ, trừ khi bạn đóng gói dữ liệu và sổ làm việc trong một. twbx hoặc xuất bản riêng nguồn dữ liệu Đối với sổ làm việc lớn hơn 64 MB, phương pháp xuất bản sẽ tự động xử lý việc chia nhỏ tệp thành các phần để tải lên. Sử dụng phương pháp này thuận tiện hơn đáng kể so với việc gọi trực tiếp các API REST xuất bản API REST. , , Thông số TênMô tả 177The 177 chỉ định sổ làm việc bạn đang xuất bản. Khi bạn thêm một sổ làm việc, trước tiên bạn cần tạo một phiên bản mới của một 177 bao gồm một 60 của một dự án hiện có. Tên của sổ làm việc sẽ là tên của tệp, trừ khi bạn cũng chỉ định tên cho sổ làm việc mới khi tạo phiên bản. Nhìn thấy. 181Đường dẫn và tên của sổ làm việc sẽ xuất bản. 035Chỉ định xem bạn đang xuất bản sổ làm việc mới ( 036) hay ghi đè lên sổ làm việc hiện có ( 037). Bạn không thể thêm sổ làm việc. Bạn cũng có thể sử dụng các thuộc tính chế độ xuất bản, chẳng hạn. 039. 65Danh sách đối tượng 187 cho các kết nối được tạo trong sổ làm việc. 040(Tùy chọn) Thông tin xác thực (nếu cần) để kết nối với nguồn dữ liệu của sổ làm việc. Đối tượng 36 chứa thông tin xác thực cho nguồn dữ liệu (tên người dùng và mật khẩu cũng như liệu thông tin đăng nhập có được nhúng hay OAuth được sử dụng hay không). Không dùng nữa kể từ máy chủ API phiên bản 2. 3. 190(Tùy chọn) Đặt thành 45 để bỏ qua kiểm tra kết nối tại thời điểm tải lên. Xuất bản sẽ thành công nhưng sự cố kết nối không được kiểm tra có thể dẫn đến sổ làm việc không hoạt động. Mặc định là 46. 042(Tùy chọn) Đặt thành 45 để chạy tác vụ tải lên (tải lên không đồng bộ). Nếu được đặt thành 45, một công việc sẽ bắt đầu thực hiện quy trình xuất bản và một đối tượng 196 được trả về. Mặc định là 46. 198(Tùy chọn) Danh sách tên chuỗi của các dạng xem cần được ẩn khi sổ làm việc được xuất bảnngoại lệ ErrorDescription 044Raise lỗi đường dẫn tệp không chính xác hoặc nếu tệp bị thiếu. 045Phát sinh lỗi nếu chế độ xuất bản không phải là một trong các tùy chọn được xác định. 201 035 phải được đặt thành 037 hoặc 036. 205Xảy ra lỗi nếu loại tệp được chỉ định không được hỗ trợXem API REST để biết thêm mã lỗi trả lại 939 cho sổ làm việc đã được xuất bảnVí dụ 78sách bài tập. Làm tươi 79Làm mới trích xuất của một sổ làm việc hiện có API REST. Thông số TênMô tả 177The 177 chỉ định cài đặt cho sổ làm việc mà bạn đang làm mớingoại lệ ErrorDescription 209Raise error nếu 177 không được chỉ định. Sử dụng các phương pháp 97 hoặc 212 để truy xuất mục sổ làm việc từ máy chủ 80 81Sửa đổi sổ làm việc hiện có. Sử dụng phương pháp này để thay đổi chủ sở hữu hoặc dự án thuộc về sổ làm việc hoặc để thay đổi xem sổ làm việc có hiển thị dạng xem trong tab hay không. Mục sổ làm việc phải bao gồm ID sổ làm việc và ghi đè các cài đặt hiện có API REST. Thông số TênMô tả________ 0177 ________ 0177 chỉ định cài đặt cho sổ làm việc bạn đang cập nhật. Bạn có thể thay đổi các giá trị 00, 60 và 162. Nhìn thấyngoại lệ ErrorDescription 209Raise error nếu 177 không được chỉ định. Sử dụng các phương pháp 97 hoặc 212 để truy xuất mục sổ làm việc từ máy chủ 82sách bài tập. xóa bỏ 83Xóa sổ làm việc có ID đã chỉ định Để chỉ định trang web, hãy tạo phiên bản 01 bằng cách sử dụng URL nội dung cho trang web ( 05) và đăng nhập vào trang web đó. xemAPI REST. Thông số TênMô tả 067ID của sổ làm việc cần xóangoại lệ ErrorDescription 225Raise một ngoại lệ nếu mục dự án không có ID. ID dự án được gửi đến máy chủ như một phần của URIVí dụ 84sách bài tập. Tải xuống 85Tải sổ làm việc xuống thư mục đã chỉ định (tùy chọn) API REST. Thông số TênMô tả 067ID cho 939 mà bạn muốn tải xuống từ máy chủ. 000(Tùy chọn) Tải tệp xuống vị trí bạn chỉ định. Nếu không có vị trí nào được chỉ định, tệp sẽ được tải xuống thư mục làm việc hiện tại. Mặc định là 001. 005(Tùy chọn) Chỉ định có tải xuống tệp mà không cần giải nén hay không. Khi sổ làm việc có phần trích xuất, nếu bạn đặt tham số 008, phần trích xuất sẽ không được đưa vào. Bạn có thể sử dụng tham số này để cải thiện hiệu suất nếu bạn đang tải xuống sổ làm việc có phần trích xuất lớn. Mặc định là bao gồm phần trích xuất, nếu có (______3009). Có sẵn bắt đầu với Tableau Server REST API phiên bản 2. 5ngoại lệ ErrorDescription 174Raise một ngoại lệ nếu một 38 hợp lệ không được cung cấptrả lại Đường dẫn tệp đến sổ làm việc đã tải xuống Ví dụ 86sách bài tập. popated_views 87Điền (hoặc lấy) danh sách dạng xem cho sổ làm việc Trước tiên, bạn phải gọi phương thức này để đưa vào các dạng xem trước khi bạn có thể lặp qua các dạng xem Phương thức này lấy thông tin dạng xem cho sổ làm việc đã chỉ định. API REST được thiết kế để chỉ trả lại thông tin bạn yêu cầu một cách rõ ràng. Khi bạn truy vấn tất cả các nguồn dữ liệu, thông tin dạng xem không được bao gồm. Sử dụng phương pháp này để truy xuất các khung nhìn. Phương thức thêm danh sách các dạng xem vào mục sổ làm việc (______0235). Đây là danh sách của 049API REST. Thông số TênMô tả 177The 177 chỉ định sổ làm việc để điền thông tin dạng xem. Nhìn thấyngoại lệ ErrorDescription 209Raise error nếu 177 không được chỉ định. Bạn có thể truy xuất các mục sổ làm việc bằng phương pháp 97 và 212trả lại Không có. Một danh sách các đối tượng 049 được thêm vào sổ làm việc ( 235)Ví dụ 88sách bài tập. popated_connections 89Tạo danh sách các kết nối nguồn dữ liệu cho sổ làm việc đã chỉ định Bạn phải điền vào các kết nối trước khi có thể lặp qua các kết nối Phương thức này truy xuất thông tin kết nối nguồn dữ liệu cho sổ làm việc đã chỉ định. API REST được thiết kế để chỉ trả lại thông tin bạn yêu cầu một cách rõ ràng. Khi bạn truy vấn tất cả sổ làm việc, thông tin kết nối nguồn dữ liệu không được bao gồm. Sử dụng phương pháp này để truy xuất thông tin kết nối cho bất kỳ nguồn dữ liệu nào được sổ làm việc sử dụng. Phương thức thêm danh sách các kết nối dữ liệu vào mục sổ làm việc (______0245). Đây là danh sách của 35API REST. Thông số TênMô tả 177The 177 chỉ định sổ làm việc sẽ điền thông tin kết nối dữ liệungoại lệ ErrorDescription 209Raise error nếu 177 không được chỉ địnhtrả lại Không có. Một danh sách các đối tượng 35 được thêm vào nguồn dữ liệu ( 245)Ví dụ 90sách bài tập. populate_preview_image 91Phương thức này lấy hình ảnh xem trước (hình thu nhỏ) cho mục sổ làm việc đã chỉ định Phương pháp sử dụng 253 và 254 để xác định hình ảnh xem trước. Phương pháp điền vào 255
Python có thể lấy dữ liệu từ Tableau không?2) Tạo tập lệnh Python của bạn
DataFrame làm đối số. Điều này sẽ lấy dữ liệu từ Tableau Prep Builder . Bạn cũng phải trả lại kết quả bằng pandas, pd. DataFrame với các loại dữ liệu được hỗ trợ.
Python có thể tương tác với Tableau không?Để bao gồm các tập lệnh Python trong quy trình của bạn, bạn cần định cấu hình kết nối giữa Tableau và máy chủ TabPy . Sau đó, bạn có thể sử dụng tập lệnh Python để áp dụng các hàm được hỗ trợ cho dữ liệu từ luồng của mình bằng cách sử dụng khung dữ liệu gấu trúc.
Tableau có thể đọc từ API REST không?API REST không phải là nguồn dữ liệu mà Tableau Desktop có thể truy cập . Bạn phải xuất dữ liệu từ yêu cầu API sang tệp csv hoặc tệp phẳng khác để sử dụng API REST. Sau đó, bạn có thể sử dụng Tableau Desktop để kết nối với tệp đó.
Tôi có thể sử dụng Tableau trong sổ ghi chép Jupyter không?Vì bạn không thể kết nối nó với máy tính xách tay jupyter nên có thể khó lấy mã và EDA hoặc dữ liệu trực quan của bạn ở một nơi. Nếu chúng ta có thể đồng bộ jupyter notebook và tableau, điều đó sẽ rất có lợi. |