get_global_notice: Get the global notice

View source: R/settings.R

get_global_noticeR Documentation

Get the global notice

Description

Return the global notice, if any, set 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

get_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 ⁠GET ​/api​/v1​/settings​/globalnotice⁠ endpoint.

Value

Character. Global notice.


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