suso_createWorkspace: Survey Solutions API call to create workspace

In michael-cw/SurveySolutionsAPI: Comprehensive API access to your Survey Solutions Server

Survey Solutions API call to create workspace

Description

suso_createWorkspace Allows you to create a workspace with a specific system name and display name. For more details please read https://docs.mysurvey.solutions/headquarters/accounts/workspaces/. To run this command you require admin credentials.

Usage

suso_createWorkspace(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  token = NULL,
  new_workspace = NULL,
  your_workspace = NULL,
  displayName = NULL
)

Arguments

server	Survey Solutions server address
apiUser	Survey Solutions ADMIN user
apiPass	Survey Solutions ADMIN password
token	If Survey Solutions server token is provided apiUser and apiPass will be ignored
new_workspace	The name used by the system for this workspace. Make sure you follow the rules outlined under https://docs.mysurvey.solutions/headquarters/accounts/workspaces/
your_workspace	The workspace the API user has currently access to. To get access to the new workspace, the workspace needs to be assigned
displayName	The name visible to the users

Details

Be aware, that for using this call you require the admin credentials, and not the regular API user credentials.

Examples

## Not run: 
# Use Admin Credentials!
suso_createWorkspace(
          your_workspace = "myworkspace",
          new_workspace = "myworkspace1",
          displayName = "SpecialWorkspace",
          apiUser = "xxxxxx",
          apiPass = "xxxxxx")

## End(Not run)

michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.