swagger_client.OntologyApi

All URIs are relative to http://cor.esipfed.org/ont/api/v0

Method	HTTP request	Description
add_ont	POST /ont	Registers a brand new ontology
add_term	POST /ont/term	Adds a term to an existing ORR vocabulary
delete_ont	DELETE /ont	Deletes a particular version or a whole ontology entry
ont_get	GET /ont	Gets information about registered ontologies or terms
update_ont	PUT /ont	Updates a given ontology version or adds a new version
upload_ont	POST /ont/upload	Uploads an ontology file for subsequent registration

add_ont

add_ont(body)

Registers a brand new ontology

Performs the registration of a brand new ontology in the registry by the IRI given in the iri attribute of the object in the body.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OntologyApi(swagger_client.ApiClient(configuration))
body = swagger_client.PostOnt() # PostOnt | Object with information for the ontology to be registered.  To provide the contents of the ontology you have two options:  - Specify a previously uploaded file (via `POST /ont/upload`) by   providing the corresponding reported filename (in the `uploadedFilename`   field) and format (`uploadedFormat`). There's no need to upload the file   itself again. - Embbed the complete contents in the `contents` field, and provide the associated   format in `format`.  See the `PostOnt` object description for more details. 

try:
    # Registers a brand new ontology
    api_instance.add_ont(body)
except ApiException as e:
    print("Exception when calling OntologyApi->add_ont: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PostOnt	Object with information for the ontology to be registered. To provide the contents of the ontology you have two options: - Specify a previously uploaded file (via `POST /ont/upload`) by providing the corresponding reported filename (in the `uploadedFilename` field) and format (`uploadedFormat`). There's no need to upload the file itself again. - Embbed the complete contents in the `contents` field, and provide the associated format in `format`. See the `PostOnt` object description for more details.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_term

add_term(body)

Adds a term to an existing ORR vocabulary

This operation allows to add a new term to an ORR vocabulary. This addition does not generate a new version of the vocabulary.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OntologyApi(swagger_client.ApiClient(configuration))
body = swagger_client.PostTerm() # PostTerm | Object with information for the term to be added. See the `PostOnt` object description for more details. 

try:
    # Adds a term to an existing ORR vocabulary
    api_instance.add_term(body)
except ApiException as e:
    print("Exception when calling OntologyApi->add_term: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PostTerm	Object with information for the term to be added. See the `PostOnt` object description for more details.

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_ont

delete_ont(iri, user_name, version=version)

Deletes a particular version or a whole ontology entry

This operation allows to unregister a particular version (if the version object attribute is given) or a whole ontoloy entry. Besides admins, only an owner of the ontology can perform this operation.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OntologyApi(swagger_client.ApiClient(configuration))
iri = 'iri_example' # str | Ontology IRI
user_name = 'user_name_example' # str | Registered user making the request. Must be an owner of the ontology. 
version = 'version_example' # str | Particular version to be deleted. If omitted, the whole entry by the given IRI will be unregistered.  (optional)

try:
    # Deletes a particular version or a whole ontology entry
    api_instance.delete_ont(iri, user_name, version=version)
except ApiException as e:
    print("Exception when calling OntologyApi->delete_ont: %s\n" % e)

Parameters

Name	Type	Description	Notes
iri	str	Ontology IRI
user_name	str	Registered user making the request. Must be an owner of the ontology.
version	str	Particular version to be deleted. If omitted, the whole entry by the given IRI will be unregistered.	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ont_get

list[Ont] ont_get(iri=iri, oiri=oiri, version=version, tiri=tiri, format=format)

Gets information about registered ontologies or terms

General ontology or term report according to given parameters, associated ontology visibility, and privilege of the requesting user. All parameters are optional. Any given iri, oiri, or tiri parameter indicates a request for a particular ontology or term. If none of the iri, oiri, and tiri parameters is given, this will indicate a query for a list of ontologies. In this case, only a metadata summary is provided for each reported ontology (in particular, no ontology contents per se is reported). Also, other supplied parameters will be used to query for the desired ontologies. For example, with the query paramenter and value ownerName=acme, all ontologies owned by the acme organization will be considered for reporting.

Example

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

# create an instance of the API class
api_instance = swagger_client.OntologyApi()
iri = 'iri_example' # str | With this parameter the backend will first try an \"ontology request.\" If no ontlogy is registered by the given IRI, then it will try a \"term request.\"  (optional)
oiri = 'oiri_example' # str | Use this parameter to exclusively make a \"ontology request.\"  (optional)
version = 'version_example' # str | Desired version in the case of an \"ontology request.\"  (optional)
tiri = 'tiri_example' # str | Use this parameter to exclusively make a \"term request.\"  (optional)
format = 'format_example' # str | Desired format for the response in the case of a single ontology or term request.  (optional)

try:
    # Gets information about registered ontologies or terms
    api_response = api_instance.ont_get(iri=iri, oiri=oiri, version=version, tiri=tiri, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OntologyApi->ont_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
iri	str	With this parameter the backend will first try an "ontology request." If no ontlogy is registered by the given IRI, then it will try a "term request."	[optional]
oiri	str	Use this parameter to exclusively make a "ontology request."	[optional]
version	str	Desired version in the case of an "ontology request."	[optional]
tiri	str	Use this parameter to exclusively make a "term request."	[optional]
format	str	Desired format for the response in the case of a single ontology or term request.	[optional]

Return type

list[Ont]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_ont

update_ont(body=body)

Updates a given ontology version or adds a new version

Use this operation to create a new version for a registered ontology, or to update an exisiting version.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OntologyApi(swagger_client.ApiClient(configuration))
body = swagger_client.PutOnt() # PutOnt | Ontology object that needs to be registered. Provide the `metadata` attribute to create a new version of an existing ontology solely based on changes on the metadata. For full contents, use `contents`/`format`, or `uploadedFilename`/`uploadedFormat` as described in the `POST /ont` operation.  (optional)

try:
    # Updates a given ontology version or adds a new version
    api_instance.update_ont(body=body)
except ApiException as e:
    print("Exception when calling OntologyApi->update_ont: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PutOnt	Ontology object that needs to be registered. Provide the `metadata` attribute to create a new version of an existing ontology solely based on changes on the metadata. For full contents, use `contents`/`format`, or `uploadedFilename`/`uploadedFormat` as described in the `POST /ont` operation.	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_ont

UploadedFileInfo upload_ont(file, format)

Uploads an ontology file for subsequent registration

This operation allows to upload an ontology file as a preliminary step for subsequent registration via a POST /ont request. Before having to provide other required information for registration, this separated step helps not only in determining that the file corresponds to an ontology in a recognized format, but also in terms of the returned associated information that the user or client application can use for actual registration, for example, regarding possible ontology IRIs found in the file.

Example

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

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.OntologyApi(swagger_client.ApiClient(configuration))
file = '/path/to/file.txt' # file | The file to be uploaded.
format = 'format_example' # str | Format of the file. The supported formats are described in [this section](https://mmisw.org/orrdoc/ontology/new/#supported-ontology-formats) of the documentation. The special value `\"_guess\"` (without quotes) can be given to let the ORR automatically determine the format. (A future version of this API may allow this parameter to be omitted, in such case implying the guess-format behavior.) 

try:
    # Uploads an ontology file for subsequent registration
    api_response = api_instance.upload_ont(file, format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OntologyApi->upload_ont: %s\n" % e)

Parameters

Name	Type	Description	Notes
file	file	The file to be uploaded.
format	str	Format of the file. The supported formats are described in this section of the documentation. The special value `"_guess"` (without quotes) can be given to let the ORR automatically determine the format. (A future version of this API may allow this parameter to be omitted, in such case implying the guess-format behavior.)

Return type

UploadedFileInfo

Authorization

basicAuth

HTTP request headers

Content-Type: application/json, multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OntologyApi.md

Latest commit

History

OntologyApi.md

File metadata and controls

swagger_client.OntologyApi

add_ont

Example

Parameters

Return type

Authorization

HTTP request headers

add_term

Example

Parameters

Return type

Authorization

HTTP request headers

delete_ont

Example

Parameters

Return type

Authorization

HTTP request headers

ont_get

Example

Parameters

Return type

Authorization

HTTP request headers

update_ont

Example

Parameters

Return type

Authorization

HTTP request headers

upload_ont

Example

Parameters

Return type

Authorization

HTTP request headers