openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 0.1.0
• Package version: 1.0.0
• Generator version: 7.11.0-SNAPSHOT
• 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 openapi_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 openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_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 = openapi_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DashboardDataApi(api_client)
    user_id = 56 # int | 
    user_type_id = 56 # int | 

    try:
        # Get Dashboard Data
        api_response = api_instance.get_dashboard_data_dashboard_user_id_user_type_id_get(user_id, user_type_id)
        print("The response of DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DashboardDataApi	get_dashboard_data_dashboard_user_id_user_type_id_get	GET /dashboard/{user_id}/{user_type_id}	Get Dashboard Data
DatasetManagementApi	delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete	DELETE /datasets/datasetEntities/{user_id}/{user_type_id}	Delete Dataset Entities
DatasetManagementApi	delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete	DELETE /datasets/datasetEntities/files/{user_id}/{user_type_id}	Delete Entity Files
DatasetManagementApi	get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get	GET /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}	Get Dataset Entities
DatasetManagementApi	get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get	GET /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id}	Get Dataset Item
DatasetManagementApi	get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get	GET /datasets/datasetEntities/files/{user_id}/{user_type_id}/{dataset_id}/{file_id}	Get Entity File
DatasetManagementApi	get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get	GET /datasets/datasetEntities/thumbnail/{user_id}/{user_type_id}/{dataset_id}/{file_id}	Get Thumbnail
DatasetManagementApi	get_user_datasets_datasets_user_id_user_type_id_get	GET /datasets/{user_id}/{user_type_id}	Get User Datasets
DatasetManagementApi	new_dataset_datasets_user_id_user_type_id_post	POST /datasets/{user_id}/{user_type_id}	New Dataset
DatasetManagementApi	new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post	POST /datasets/datasetEntities/{user_id}/{user_type_id}	New Dataset Entity
DatasetManagementApi	recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post	POST /datasets/datasetEntities/recover/{user_id}/{user_type_id}	Recover Dataset Entities
DatasetManagementApi	update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put	PUT /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id}	Update Dataset Entity
LocationManagementApi	delete_location_locations_user_id_user_type_id_location_id_delete	DELETE /locations/{user_id}/{user_type_id}/{location_id}	Delete Location
LocationManagementApi	get_user_locations_locations_user_id_user_type_id_get	GET /locations/{user_id}/{user_type_id}	Get User Locations
LocationManagementApi	new_location_locations_user_id_user_type_id_post	POST /locations/{user_id}/{user_type_id}	New Location
LocationManagementApi	recover_location_locations_user_id_user_type_id_location_id_put	PUT /locations/{user_id}/{user_type_id}/{location_id}	Recover Location
LocationManagementApi	update_location_locations_user_id_user_type_id_put	PUT /locations/{user_id}/{user_type_id}	Update Location
SessionManagementApi	delete_session_session_logout_user_id_user_type_id_delete	DELETE /session/logout/{user_id}/{user_type_id}	Delete Session
SessionManagementApi	new_session_session_login_post	POST /session/login	New Session
UsersManagementApi	forgot_password_users_forgot_password_post	POST /users/forgotPassword	Forgot Password
UsersManagementApi	get_profile_picture_users_profile_pic_user_id_user_type_id_get	GET /users/profilePic/{user_id}/{user_type_id}	Get Profile Picture
UsersManagementApi	get_user_locations_users_students_user_id_user_type_id_get	GET /users/students/{user_id}/{user_type_id}	Get User Locations
UsersManagementApi	new_student_users_students_user_id_user_type_id_post	POST /users/students/{user_id}/{user_type_id}	New Student
UsersManagementApi	reset_password_users_reset_password_post	POST /users/resetPassword	Reset Password
UsersManagementApi	update_profile_picture_users_profile_pic_user_id_user_type_id_post	POST /users/profilePic/{user_id}/{user_type_id}	Update Profile Picture
UsersManagementApi	update_user_profile_users_user_id_user_type_id_put	PUT /users/{user_id}/{user_type_id}	Update User Profile
UsersManagementApi	validate_user_sign_up_users_validate_user_id_user_type_id_post	POST /users/validate/{user_id}/{user_type_id}	Validate User Sign Up

Documentation For Models

• DatasetDetails
• DatasetEntityDetails
• DeleteDatasetEntities
• EntityFileDetails
• ForgotPassword
• HTTPValidationError
• LocationDetails
• NewDataset
• NewDatasetEntity
• NewLocation
• NewSession
• NewStudent
• ResetPassword
• StudentDetails
• UpdateDatasetEntity
• UpdateLocation
• UpdateUser
• UserDetails
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author