get_workspaces: Get list of workspaces
In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

get_workspaces

R Documentation

Get list of workspaces

Description

Get list of workspaces that meet query criteria. The list is affected by what the user can "see". If the credentials are admin credentials, all workspaces will be returned. If the user is an API user, then only those workspaces where the API user is present, will be included.

Usage

get_workspaces(
  user_id = "",
  include_disabled = FALSE,
  server = Sys.getenv("SUSO_SERVER"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

`user_id`	Character. GUID. Searches for workspaces where user with user ID is assigned.
`include_disabled`	Logical. Determine whether list of workspaces should include those that have been disabled or not.
`server`	Character. Full server web address (e.g., `https://demo.mysurvey.solutions`, `https://my.domain`)
`user`	Character. Admin or API user name
`password`	Character. Admin or API user password

Details

Wrapper for the ⁠GET /api/v1/workspaces⁠ endpoint.

Value

Data frame of workspaces. Contains columns: Name, the name ID; DisplayName, the name in the GUI; and DisabledAtUtc, when the workspace was disabled or NA if not disabled.

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