Skip to content

mintproject/data-catalog-client

Repository files navigation

datacatalog-api

API Documentation for MINT Data Catalog

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

  • API version: 1.0.0
  • Package version: 0.0.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

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 datacatalog 

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 datacatalog

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import datacatalog
from datacatalog.rest import ApiException
from pprint import pprint


# Defining host is optional and default to https://api.mint-data-catalog.org
configuration.host = "https://api.mint-data-catalog.org"
# Create an instance of the API class
api_instance = datacatalog.DatasetsApi(datacatalog.ApiClient(configuration))
body = datacatalog.InlineObject3() # InlineObject3 | 

try:
    # List all resources for this dataset
    api_response = api_instance.dataset_resources(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DatasetsApi->dataset_resources: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.mint-data-catalog.org

Class Method HTTP request Description
DatasetsApi dataset_resources POST /datasets/dataset_resources List all resources for this dataset
DatasetsApi dataset_standard_variables POST /datasets/dataset_standard_variables List all standard_variables for this dataset
DatasetsApi dataset_variables POST /datasets/dataset_variables List all variables for this dataset
DatasetsApi datasets_search POST /datasets/search Full-text search of datasets
DatasetsApi find_datasets POST /find_datasets Search datasets by name, id, or standard variables
DatasetsApi get_dataset_info POST /datasets/get_dataset_info Detailed information about the dataset
DatasetsApi register_datasets POST /datasets/register_datasets Create dataset record(s)
ResourcesApi get_resource_info POST /resources/get_resource_info Detailed information about the resource
ResourcesApi register_resources POST /datasets/register_resources Create resource record(s)
StandardVariablesApi get_standard_variable_info POST /standard_variables/get_standard_variable_info Detailed information about the standard variable
StandardVariablesApi register_standard_variables POST /knowledge_graph/register_standard_variables Create standard_variable record(s)
VariablesApi get_variable_info POST /variables/get_variable_info Detailed information about the variable
VariablesApi register_variables POST /datasets/register_variables Create variable record(s)

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

danf@usc.edu