delete_global_notice: Delete the global notice

View source: R/settings.R

delete_global_noticeR Documentation

Delete the global notice

Description

Delete the global notice for workspaces in the user's scope. For admin, this is all workspaces. For an API user, this is all workspaces to which the user has been added.

Usage

delete_global_notice(
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

server

Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)

workspace

Character. Name of the workspace whose global notice to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.

user

Character. User name

password

Character. Password

Details

Wrapper for the ⁠DELETE ​/api​/v1​/settings​/globalnotice⁠ endpoint

Value

Server-side side-effect of deleting the global notice text.


arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.