suso_mapupload: Upload map to server

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

Upload map to server

Description

Allows the user to upload a zip file of background maps and boundary files

Usage

suso_mapupload(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL,
  path_to_zip = NULL
)

Arguments

server	Survey Solutions server address
apiUser	Survey Solutions API user
apiPass	Survey Solutions API password
workspace	server workspace, if nothing provided, defaults to primary
token	If Survey Solutions server token is provided apiUser and apiPass will be ignored
path_to_zip	either path to zip file or directory of files which will automatically be zipped as required

Details

Resources for upload must meet the requirements specified under: https://docs.mysurvey.solutions/headquarters/mapsmanage/map-formats/, Attention: this uses the GraphQL API, not the REST API.

Value

Returns a data.table, with information about the uploaded maps

Examples

## Not run: 
# either upload the content of a folder
suso_mapupload(workspace = "myworkspace",
              path_to_zip = "./mapfiles/")

# or a zip file with the files included
suso_mapupload(workspace = "myworkspace",
              path_to_zip = "../mapfiles/maps.zip")

## End(Not run)

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