get_assignments: Get all assignments

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Get all assignments

Description

Get all assignments for query parameters. Wrapper for GET /api/v1/assignments endpoint.

Usage

get_assignments(
  search_by = "",
  qnr_id = "",
  qnr_version = "",
  responsible = "",
  supervisor_id = "",
  show_archive = FALSE,
  order = "",
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

search_by	Character. Search for matching text in identifying questions.
qnr_id	Questionnaire ID. GUID provided by the server.
qnr_version	Questionnaire version. Version number provided by the server.
responsible	Character. Either user ID (GUID) or user name.
supervisor_id	Character. User ID (GUID) of supervisor.
show_archive	Logical. Include archived assignments.
order	Possible values are Id, ResponsibleName, InterviewsCount, Quantity, UpdatedAtUtc, CreatedAtUtc Followed by ordering direction "ASC" or "DESC"
server	Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose assignments to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	User name
password	Password

Value

Data frame of all assignments that meet search criteria.

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