# \OntologiesApi

All URIs are relative to *http://localhost:5000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_ontology**](OntologiesApi.md#add_ontology) | **POST** /v3/streams/ontologies | Add an ontology .
[**delete_ontology**](OntologiesApi.md#delete_ontology) | **DELETE** /v3/streams/ontologies/{onto_id} | Delete an ontology
[**get_ontology**](OntologiesApi.md#get_ontology) | **GET** /v3/streams/ontologies/{onto_id} | Get ontology details.
[**list_ontologies**](OntologiesApi.md#list_ontologies) | **GET** /v3/streams/ontologies | List ontologies.
[**update_ontology**](OntologiesApi.md#update_ontology) | **PUT** /v3/streams/ontologies/{onto_id} | Update an ontology



## add_ontology

> models::ListOntologies200Response add_ontology(new_ontology)
Add an ontology .

Add an ontology .

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_ontology** | [**NewOntology**](NewOntology.md) |  | [required] |

### Return type

[**models::ListOntologies200Response**](list_ontologies_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_ontology

> models::GetOntology200Response delete_ontology(onto_id)
Delete an ontology

Delete an ontology

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**onto_id** | **String** | Unique ID of ontology generated by Tapis | [required] |

### Return type

[**models::GetOntology200Response**](get_ontology_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_ontology

> models::GetOntology200Response get_ontology(onto_id)
Get ontology details.

Get ontology details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**onto_id** | **String** | Unique ID of ontology generated by Tapis | [required] |

### Return type

[**models::GetOntology200Response**](get_ontology_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_ontologies

> models::ListOntologies200Response list_ontologies(query, limit, skip)
List ontologies.

List ontologies.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**query** | Option<**String**> | a formated query string for ontology label. |  |
**limit** | Option<**i32**> | limit the number of records returned. |  |
**skip** | Option<**i32**> | index (skip) to start list. |  |

### Return type

[**models::ListOntologies200Response**](list_ontologies_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_ontology

> models::GetOntology200Response update_ontology(onto_id, new_ontology)
Update an ontology

Update an ontology

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**onto_id** | **String** | Unique ID of ontology generated by Tapis | [required] |
**new_ontology** | [**NewOntology**](NewOntology.md) |  | [required] |

### Return type

[**models::GetOntology200Response**](get_ontology_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

