suso_mapinfo: Receive maps currently uploaded to the server

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

Receive maps currently uploaded to the server

Description

Allows the user to retrieve filtered or unfiltered map data.

Usage

suso_mapinfo(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  fileName = NULL,
  importDateUtc = NULL,
  size = NULL,
  users = NULL,
  sortby_filename = NULL,
  sortby_importeddateutc = NULL,
  sortby_size = NULL,
  take = NULL,
  skip = NULL
)

Arguments

server	GraphQL endpoint of your server
apiUser	your API username
apiPass	API password
workspace	Server Workspace, if NULL uses default
fileName	name of the map on the server
importDateUtc	Import date
size	Size of the map
users	Users to whom the maps are assigned
sortby_filename	sort maps by file name, either ASC for ascending or DESC for descending
sortby_importeddateutc	sort maps by import date in utc, either ASC for ascending or DESC for descending
sortby_size	sort by map size, either ASC for ascending or DESC for descending
take	take the specified integer numeber of maps
skip	skip the first integer number of maps

Details

Attention: this uses the GraphQL API, not the REST API.

Value

Returns a data.table, with all the maps and additonal information. If multiple users are assigned to a map, the table is expanded, such that there is one user per map.

Examples

## Not run: 
suso_mapinfo(workspace = "myworkspace")

## End(Not run)

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