get_workspace_status: Get detailed workspace status

View source: R/workspaces.R

get_workspace_statusR Documentation

Get detailed workspace status

Description

Obtains a data frame with details about the workspace status and contents

Usage

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

Arguments

name

Character. Name identifier of workspace to delete.

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 password

Details

Wrapper for ⁠GET ​/api​/v1​/workspaces​/status​/{name}⁠ endpoint.

Value

Data frame. Contains columns: CanBeDeleted, WorkspaceName, WorkspaceDisplayName, ExistingQuestionnairesCount, InterviewersCount, SupervisorsCount, MapsCount


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