Sign in

Get Utopia Data

Request and receive the Utopia map corresponding to the decision variables sent.

Args: request (UtopiaRequest): the set of decision variables and problem for which the utopia forest map is requested for. user (Annotated[User, Depend(get_current_user)]) the current user session (Annotated[Session, Depends(get_session)]) the current database session Raises: HTTPException: Returns: UtopiaResponse: the map for the forest, to be rendered in frontend

post/utopia/

Request body

problem_idinteger required

Problem for which the map is generated

Response

Successful Response

is_utopiaboolean required

True if map exists for this problem.

map_namestring required

Name of the map.

map_jsonobject required

MapJSON representation of the geography.

optionsobject required

A dict with given years as keys containing options for each year.

descriptionstring required

Description shown above the map.

yearsstring[] required

A list of years for which the maps have been generated.

Changes

Changed in 2 of the 2 revisions of this API.11