create_workspace: Create a workspace

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Create a workspace

Description

Create a workspace with name ID name and name displayed in GUI display_name.

Usage

create_workspace(
  name,
  display_name,
  verbose = FALSE,
  server = Sys.getenv("SUSO_SERVER"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

name	Character. Name identifier of workspace.
display_name	Character. Name displayed in GUI to describe workspace.
verbose	Logical. If TRUE, return a Boolean value about whether operation succeeded.
server	Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
user	Character. Admin user name
password	Character. Admin password

Details

Note: this function requires the credentials of an admin user.

Wrapper for ⁠POST ​/api​/v1​/workspaces⁠ endpoint.

Value

Server-side side-effect of creating a workspace.

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