get_workspace_details: Get details of a single workspace
In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

get_workspace_details

R Documentation

Get details of a single workspace

Description

Rather than get the details for all workspaces, get them for a single workspace.

Usage

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

Arguments

`name`	Character. Name identifier of workspace.
`server`	Character. Full server web address (e.g., `https://demo.mysurvey.solutions`, `https://my.domain`)
`user`	Character. Admin user name
`password`	Character. Admin password

Details

Wrapper for GET /api/v1/workspaces/{name} endpoint

Value

Data frame containing workspace details: Name, the name ID; DisplayName, the name displayed in the GUI; and DisabledAtUtc, the time the workspace was disabled or NA if not disabled

arthur-shaw/susoapi documentation built on Feb. 10, 2023, 7:47 p.m.