sensormap-client

API for managing SOIL lab data

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.1.2
• Package version: 0.1.0
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import sensormap_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sensormap_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import sensormap_client
from sensormap_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = sensormap_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = sensormap_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sensormap_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensormap_client.DefaultApi(api_client)
    area_create = sensormap_client.AreaCreate() # AreaCreate | 

    try:
        # Create one area
        api_response = api_instance.create_one_area(area_create)
        print("The response of DefaultApi->create_one_area:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->create_one_area: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	create_one_area	POST /api/areas	Create one area
DefaultApi	create_one_assignment__sensor_profile	POST /api/sensor_profile_assignments	Create one assignment (sensor profile)
DefaultApi	create_one_channel__instrument_experiment	POST /api/instrument_channels	Create one channel (instrument experiment)
DefaultApi	create_one_experiment__lab_instrument	POST /api/instruments	Create one experiment (lab instrument)
DefaultApi	create_one_gnss_recording	POST /api/gnss	Create one GNSS recording
DefaultApi	create_one_plot	POST /api/plots	Create one plot
DefaultApi	create_one_profile__sensor	POST /api/sensor_profiles	Create one profile (sensor)
DefaultApi	create_one_project	POST /api/projects	Create one project
DefaultApi	create_one_sample__plot	POST /api/plot_samples	Create one sample (plot)
DefaultApi	create_one_sensor	POST /api/sensors	Create one sensor
DefaultApi	create_one_soil_profile	POST /api/soil_profiles	Create one soil profile
DefaultApi	create_one_soil_type	POST /api/soil_types	Create one soil type
DefaultApi	create_one_transect	POST /api/transects	Create one transect
DefaultApi	delete_many_areas	DELETE /api/areas	Delete many areas
DefaultApi	delete_many_assignments__sensor_profile	DELETE /api/sensor_profile_assignments	Delete many assignments (sensor profile)
DefaultApi	delete_many_channels__instrument_experiment	DELETE /api/instrument_channels	Delete many channels (instrument experiment)
DefaultApi	delete_many_experiments__lab_instrument	DELETE /api/instruments	Delete many experiments (lab instrument)
DefaultApi	delete_many_gnss_recordings	DELETE /api/gnss	Delete many GNSS recordings
DefaultApi	delete_many_plots	DELETE /api/plots	Delete many plots
DefaultApi	delete_many_profiles__sensor	DELETE /api/sensor_profiles	Delete many profiles (sensor)
DefaultApi	delete_many_projects	DELETE /api/projects	Delete many projects
DefaultApi	delete_many_samples__plot	DELETE /api/plot_samples	Delete many samples (plot)
DefaultApi	delete_many_sensors	DELETE /api/sensors	Delete many sensors
DefaultApi	delete_many_soil_profiles	DELETE /api/soil_profiles	Delete many soil profiles
DefaultApi	delete_many_soil_types	DELETE /api/soil_types	Delete many soil types
DefaultApi	delete_many_transects	DELETE /api/transects	Delete many transects
DefaultApi	delete_one_area	DELETE /api/areas/{id}	Delete one area
DefaultApi	delete_one_assignment__sensor_profile	DELETE /api/sensor_profile_assignments/{id}	Delete one assignment (sensor profile)
DefaultApi	delete_one_channel__instrument_experiment	DELETE /api/instrument_channels/{id}	Delete one channel (instrument experiment)
DefaultApi	delete_one_experiment__lab_instrument	DELETE /api/instruments/{id}	Delete one experiment (lab instrument)
DefaultApi	delete_one_gnss_recording	DELETE /api/gnss/{id}	Delete one GNSS recording
DefaultApi	delete_one_plot	DELETE /api/plots/{id}	Delete one plot
DefaultApi	delete_one_profile__sensor	DELETE /api/sensor_profiles/{id}	Delete one profile (sensor)
DefaultApi	delete_one_project	DELETE /api/projects/{id}	Delete one project
DefaultApi	delete_one_sample__plot	DELETE /api/plot_samples/{id}	Delete one sample (plot)
DefaultApi	delete_one_sensor	DELETE /api/sensors/{id}	Delete one sensor
DefaultApi	delete_one_soil_profile	DELETE /api/soil_profiles/{id}	Delete one soil profile
DefaultApi	delete_one_soil_type	DELETE /api/soil_types/{id}	Delete one soil type
DefaultApi	delete_one_transect	DELETE /api/transects/{id}	Delete one transect
DefaultApi	delete_sensor_data	DELETE /api/sensors/{id}/data	Delete sensor data
DefaultApi	get_all_areas	GET /api/areas	Get all areas
DefaultApi	get_all_assignments__sensor_profile	GET /api/sensor_profile_assignments	Get all assignments (sensor profile)
DefaultApi	get_all_channels__instrument_experiment	GET /api/instrument_channels	Get all channels (instrument experiment)
DefaultApi	get_all_experiments__lab_instrument	GET /api/instruments	Get all experiments (lab instrument)
DefaultApi	get_all_gnss_recordings	GET /api/gnss	Get all GNSS recordings
DefaultApi	get_all_plots	GET /api/plots	Get all plots
DefaultApi	get_all_profiles__sensor	GET /api/sensor_profiles	Get all profiles (sensor)
DefaultApi	get_all_projects	GET /api/projects	Get all projects
DefaultApi	get_all_samples__plot	GET /api/plot_samples	Get all samples (plot)
DefaultApi	get_all_sensors	GET /api/sensors	Get all sensors
DefaultApi	get_all_soil_profiles	GET /api/soil_profiles	Get all soil profiles
DefaultApi	get_all_soil_types	GET /api/soil_types	Get all soil types
DefaultApi	get_all_transects	GET /api/transects	Get all transects
DefaultApi	get_filtered_data	GET /api/instruments/{id}/filtered	Get filtered experiment (lab instrument) data
DefaultApi	get_one	GET /api/sensor_profiles/{id}	Get one profile (sensor)
DefaultApi	get_one_area	GET /api/areas/{id}	Get one area
DefaultApi	get_one_assignment__sensor_profile	GET /api/sensor_profile_assignments/{id}	Get one assignment (sensor profile)
DefaultApi	get_one_channel__instrument_experiment	GET /api/instrument_channels/{id}	Get one channel (instrument experiment)
DefaultApi	get_one_experiment__lab_instrument	GET /api/instruments/{id}	Get one experiment (lab instrument)
DefaultApi	get_one_gnss_recording	GET /api/gnss/{id}	Get one GNSS recording
DefaultApi	get_one_plot	GET /api/plots/{id}	Get one plot
DefaultApi	get_one_project	GET /api/projects/{id}	Get one project
DefaultApi	get_one_sample__plot	GET /api/plot_samples/{id}	Get one sample (plot)
DefaultApi	get_one_sensor	GET /api/sensors/{id}	Get one sensor
DefaultApi	get_one_soil_profile	GET /api/soil_profiles/{id}	Get one soil profile
DefaultApi	get_one_soil_type	GET /api/soil_types/{id}	Get one soil type
DefaultApi	get_one_transect	GET /api/transects/{id}	Get one transect
DefaultApi	get_raw_data	GET /api/instruments/{id}/raw	Get raw experiment (lab instrument) data
DefaultApi	get_summary_data	GET /api/instruments/{id}/summary	Get summary data for experiment (lab instrument)
DefaultApi	get_ui_config	GET /api/config
DefaultApi	healthz	GET /healthz
DefaultApi	update_one_area	PUT /api/areas/{id}	Update one area
DefaultApi	update_one_assignment__sensor_profile	PUT /api/sensor_profile_assignments/{id}	Update one assignment (sensor profile)
DefaultApi	update_one_channel__instrument_experiment	PUT /api/instrument_channels/{id}	Update one channel (instrument experiment)
DefaultApi	update_one_experiment__lab_instrument	PUT /api/instruments/{id}	Update one experiment (lab instrument)
DefaultApi	update_one_gnss_recording	PUT /api/gnss/{id}	Update one GNSS recording
DefaultApi	update_one_plot	PUT /api/plots/{id}	Update one plot
DefaultApi	update_one_profile__sensor	PUT /api/sensor_profiles/{id}	Update one profile (sensor)
DefaultApi	update_one_project	PUT /api/projects/{id}	Update one project
DefaultApi	update_one_sample__plot	PUT /api/plot_samples/{id}	Update one sample (plot)
DefaultApi	update_one_sensor	PUT /api/sensors/{id}	Update one sensor
DefaultApi	update_one_soil_profile	PUT /api/soil_profiles/{id}	Update one soil profile
DefaultApi	update_one_soil_type	PUT /api/soil_types/{id}	Update one soil type
DefaultApi	update_one_transect	PUT /api/transects/{id}	Update one transect

Documentation For Models

• Area
• AreaCreate
• AreaUpdate
• ClosestSensorProfile
• Gnss
• GnssCreate
• GnssUpdate
• Gradientchoices
• InstrumentExperiment
• InstrumentExperimentChannel
• InstrumentExperimentChannelCreate
• InstrumentExperimentChannelUpdate
• InstrumentExperimentCreate
• InstrumentExperimentUpdate
• Plot
• PlotCreate
• PlotSample
• PlotSampleCreate
• PlotSampleUpdate
• PlotUpdate
• Project
• ProjectCreate
• ProjectUpdate
• Sensor
• SensorCreate
• SensorData
• SensorProfile
• SensorProfileAssignment
• SensorProfileAssignmentCreate
• SensorProfileAssignmentUpdate
• SensorProfileCreate
• SensorProfileUpdate
• SensorUpdate
• SoilProfile
• SoilProfileCreate
• SoilProfileUpdate
• SoilType
• SoilTypeCreate
• SoilTypeUpdate
• Transect
• TransectCreate
• TransectNode
• TransectUpdate

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author