Set the global notice — set_global

Set the global notice for workspaces within 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

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

Arguments

text: Character. Text of the global notice to display.
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

Value

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

Details

Wrapper for the PUT /api/v1/settings/globalnotice endpoint.