update_workspace: Update workspace

View source: R/workspaces.R

update_workspaceR Documentation

Update workspace

Description

Updates workspace attributes. For the moment, this function/endpoint only updates the display name.

Usage

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

Arguments

name

Character. Name identifier of workspace to update.

display_name

Character. Name displayed in GUI to describe workspace. This value is updated.

server

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

user

Admin or API user name

password

Admin or API password

Details

Wrapper for ⁠PATCH ​/api​/v1​/workspaces​/{name}⁠ endpoint

Value

Server-side side-effect of updating workspace


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