Maps¶
- class MapsApi(client, workspace=None)¶
Set of functions to access and manipulate Maps.
- get_list(filter_user=None, fields=None, order=None, skip=None, take=None, **kwargs)¶
Get list of maps
- Parameters
filter_user (
Optional[str]) – List only maps linked to the userfields (
Optional[List[str]]) – List of fields to return for each map
- Returns
List of Map objects
- delete(file_name)¶
Delete a map file
- Parameters
file_name (
str) – Filename (with extension) to be deleted
- upload(zip_file, fields=None)¶
Upload a zip file with maps. For versions before 22.06 only works for the admin user!
- Parameters
zip_file – Archive with the maps
- Returns
True if successful, otherwise raises GraphQLError or NotAcceptableError
- add_user(file_name, user_name)¶
Add user-to-map link
- Parameters
file_name (
str) – Filename of the mapuser_name (
str) – Interviewer role user name
- Returns
Modified Map object
- delete_user(file_name, user_name)¶
Remove user-to-map link
- Parameters
file_name (
str) – Filename of the mapuser_name (
str) – Interviewer role user name
- Returns
Modified Map object