feat: run extract refresh tasks

vusaverse · Mar 4, 2024 · 2bbb5a6 · 2bbb5a6
1 parent 9803f4b
commit 2bbb5a6
Show file tree

Hide file tree

Showing 40 changed files with 140 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -52,6 +52,7 @@ export(make_rootnodes)
 export(query_user_on_site)
 export(remove_user_from_group)
 export(remove_user_from_site)
+export(run_extract_refresh_task)
 export(update_group)
 export(update_user)
 importFrom(magrittr,"%>%")
diff --git a/R/run_extract_refresh_task.R b/R/run_extract_refresh_task.R
@@ -0,0 +1,41 @@
+#' Run Extract Refresh Task
+#'
+#' Runs the specified extract refresh task on Tableau Server.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, and `site_id`.
+#' @param task_id The ID of the extract refresh task to run.
+#' @param api_version The API version to use (default: 3.22).
+#'
+#' @return The response from the API.
+#' @export
+#'
+#' @family Tableau REST API
+run_extract_refresh_task <- function(tableau, task_id, api_version = "3.22") {
+  base_url <- tableau$base_url
+  token <- tableau$token
+  site_id <- tableau$site_id
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/tasks/extractRefreshes/",
+    task_id,
+    "/runNow"
+  )
+
+  # Construct the request body
+  # As per the requirements, the request body can be empty for now
+  request_body <- "<tsRequest></tsRequest>"
+
+  # Make the POST request to the Tableau REST API
+  api_response <- httr::POST(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token),
+    body = request_body
+  )
+
+  return(api_response)
+}
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -45,6 +45,7 @@ reference:
     desc: Extract and encryption methods for Tableau REST API.
     contents:
       - get_server_refresh_tasks
+      - run_extract_refresh_task
 
   - title: Favorites Methods
     desc: Favorites methods for Tableau REST API.

diff --git a/man/add_tags_to_view.Rd b/man/add_tags_to_view.Rd
diff --git a/man/add_tags_to_workbook.Rd b/man/add_tags_to_workbook.Rd
diff --git a/man/add_user_to_group.Rd b/man/add_user_to_group.Rd
diff --git a/man/add_user_to_site.Rd b/man/add_user_to_site.Rd
diff --git a/man/authenticate_PAT.Rd b/man/authenticate_PAT.Rd
diff --git a/man/authenticate_server.Rd b/man/authenticate_server.Rd
diff --git a/man/create_group.Rd b/man/create_group.Rd
diff --git a/man/delete_group.Rd b/man/delete_group.Rd
diff --git a/man/download_datasource.Rd b/man/download_datasource.Rd
diff --git a/man/download_filtered_tableau_image.Rd b/man/download_filtered_tableau_image.Rd
diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd
diff --git a/man/download_tableau_data.Rd b/man/download_tableau_data.Rd
diff --git a/man/download_workbooks_server.Rd b/man/download_workbooks_server.Rd
diff --git a/man/download_workbooks_server_pdf.Rd b/man/download_workbooks_server_pdf.Rd
diff --git a/man/download_workbooks_server_powerpoint.Rd b/man/download_workbooks_server_powerpoint.Rd
diff --git a/man/get_groups_for_user.Rd b/man/get_groups_for_user.Rd
diff --git a/man/get_mobile_security_settings.Rd b/man/get_mobile_security_settings.Rd
diff --git a/man/get_server_connected_apps.Rd b/man/get_server_connected_apps.Rd
diff --git a/man/get_server_datasources.Rd b/man/get_server_datasources.Rd
diff --git a/man/get_server_groups.Rd b/man/get_server_groups.Rd
diff --git a/man/get_server_info.Rd b/man/get_server_info.Rd
diff --git a/man/get_server_jobs.Rd b/man/get_server_jobs.Rd
diff --git a/man/get_server_projects.Rd b/man/get_server_projects.Rd
diff --git a/man/get_server_refresh_tasks.Rd b/man/get_server_refresh_tasks.Rd
diff --git a/man/get_server_schedules.Rd b/man/get_server_schedules.Rd
diff --git a/man/get_server_user_favorites.Rd b/man/get_server_user_favorites.Rd
diff --git a/man/get_server_users.Rd b/man/get_server_users.Rd
diff --git a/man/get_server_views.Rd b/man/get_server_views.Rd
diff --git a/man/get_server_workbooks.Rd b/man/get_server_workbooks.Rd
diff --git a/man/get_table_assets.Rd b/man/get_table_assets.Rd
diff --git a/man/get_users_in_group.Rd b/man/get_users_in_group.Rd
diff --git a/man/query_user_on_site.Rd b/man/query_user_on_site.Rd
diff --git a/man/remove_user_from_group.Rd b/man/remove_user_from_group.Rd
diff --git a/man/remove_user_from_site.Rd b/man/remove_user_from_site.Rd
diff --git a/man/run_extract_refresh_task.Rd b/man/run_extract_refresh_task.Rd
diff --git a/man/update_group.Rd b/man/update_group.Rd