Archive 2.x:Ontology Delete/2

From OSF Wiki
(Redirected from Ontology Delete/2)
Jump to: navigation, search
Ontology: Delete endpoint version:
1.1
2
3

The Ontology Delete service is used to delete an OWL ontology existing in the OSF Web Service instance, or an entity in one of the ontology. An entity can be anything of: a class, an object property, a datatype property, an annotation property or a named individual.

This service is a web service wrapper over the OWLAPI ontology library. It wraps all the needed functionalities related to delete an ontology or an entity in an ontology. Most of the related API has been implemented. So we can say that web service (with the other related services) turns the OWLAPI into a web service API.

Developers communicate with the Ontology Delete Web service using the HTTP POST method. You may request one of the following mime types: (1) text/xml, (2) application/rdf+xml, (3) application/rdf+n3 or (4) application/json. The content returned by the Web service is serialized using the mime type requested and the data returned depends on the parameters selected.

Version

This documentation page is used for the version 2 of this endpoint. Check at the top of this page to see the documentation pages for the other versions of this endpoint.

Usage

This Web service is intended to be used by content management systems, developers or administrators to delete ontologies, or entities within some ontology, that are hosted on a OSF Web Service instance, and that are used to describe the named entities in the system.

This endpoint, along with the other related endpoints: Ontology Read, Ontology Create and Ontology Update; can be seen as the brain of your OSF Web Service instance.

Web Service Endpoint Information

This section describes all the permissions you need in the WSF (Web Service Framework) to send a query to this Web service endpoint, and it describes how to access it.

To access this Web service endpoint you need the proper CRUD (Create, Read, Update and Delete) permissions on a specific graph (dataset) of the WSF. Without the proper permissions on this graph you won't be able to send any queries to the endpoint.

Needed registered CRUD permission:
  • Create: False
  • Read: False
  • Update: False
  • Delete: True

As shown on the graph URI:

  • URI of the dataset being delete

Note: normally, the URI of an Ontology dataset is the URL used to import that ontology in the system. The URL can be the URI of the ontology if it was resolvable on the Web, or the URL where the OWL file, containing the ontology's description, can be resolved by the server (on the web, on the file system, etc) via a URL.

Here is the information needed to communicate with this Web service's endpoint. Descriptions of the parameters are included below.

Note: if a parameter has a default value, the requester can omit it and the default value will be used. Also, some baseline Web services may not offer other values than the default.

HTTP method:
  • POST

Possible "Accept:" HTTP header field value:

  • text/xml (structXML)
  • application/json (structJSON)
  • application/rdf+xml (RDF+XML)
  • application/rdf+n3 (N3/Turtle)
  • application/iron+json (irJSON)
  • application/iron+csv (commON)

URI:

  • http://[...]/ws/ontology/delete/ ?ontology=param1&function=param2&parameters=param3&registered_ip=param4&interface=param5

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • param1. URI of the ontology; the URI of an Ontology dataset is the URL used to import that ontology in the system. The URL can be the URI of the ontology if it was resolvable on the Web, or the URL where the OWL file, containing the ontology's description, can be resolved by the server (on the web, on the file system, etc) via a URL. If you don't know what the URI is, you can always use the getLoadedOntologies function to get the list of all loaded ontologies URI.
  • param2 The function name to use for this query. The complete list of function names and their descriptions is available below.
  • param3. The list of parameters used by the function you are about to use. The parameters are split by a ";" character. The parameter and its value are defined as param-1=value-1. This tuple has to be encoded. So, the parameters should be constructed that way in the URL: &parameters=urlencode("param-1=value-1");urlencode("param-2=value-2"). See the example below.
  • param4. Target IP address registered in the WSF. Needed when param1 = "access_user". Otherwise this parameter as to be omitted.
  • param5. Source interface used for this web service query. The interface is a different way to process a query (different algorithms, different data management system, etc. The default interface is 'default'

Available Sources Interfaces

A source interface is a way to process a web service query. Different sources interfaces can be implemented for the same OSF Web Service endpoint. Each interface will process the query differently, but all the queries to the web service endpoint will be the same, at the exception of the interface parameter. Each interface shares the same API (the one defined by the web service endpoint), but their processing may differ (like using different algorithms, using different data management systems, etc.)

This is a list of the core interfaces for this endpoint. Organizations that hosts a OSF Web Service network could create their own interface and make it available to the users. However such private source interface won't be part of this list, but should be publicized by the organization.


Source Interface Name Description
default Default source interface for this OSF Web Service endpoint. This interface implements the default behavior of this OSF Web Service endpoint.

Functions

This web service endpoint support a series of function that can be queried. All the functions are listed in the section below, along with all their parameters.

All queries are built the same way:


  • http://[...]/ws/ontology/delete/ parameters: ontology=http%3A%2F%2Fsome-ontology-uri&function=deleteOntology&parameters=

Where:

  • ontology is the URI of the ontology to query
  • function is the name of the function to use for that query
  • parameters is a list of encoded parameters/values to give as input to that function


deleteOntology

Delete an ontology from the OSF Web Service instance. Once deleted, an ontology can't be queried anymore via any web service endpoint. It will need to be re-created before being accessible again.

There is no function parameters for this function call. The ontology to delete is determined by the ontology query parameter.

deleteClass

Delete a class in an ontology.

Function Parameters Parameter optional? Values Description
uri No Any URI string The URI of the class to delete in the ontology.


deleteProperty

Delete an object property, a datatype property or an annotation property in an ontology.

Function Parameters Parameter optional? Values Description
uri No Any URI string The URI of the property to delete in the ontology.


deleteNamedIndividual

Delete a named individual in an ontology.

Function Parameters Parameter optional? Values Description
uri No Any URI string The URI of the named individual to delete in the ontology.

HTTP Status Codes

Here are the possible HTTP status (error) codes returned by this Web service endpoint.

On error code and the specific error, a different message description can be issued (meaning a different error has been returned).

  • Code:200
    • Message: OK
  • Code:400
    • Message: Bad Request
    • Message description: No Ontology URI defined for this request
    • Message description: The function call being requested is unknown or unsupported by this Ontology Read web service endpoint
    • Message description: The ontology can't be loaded by the endpoint
    • Message description: No requester IP available
    • Message description: No Web service URI available
    • Message description: Target Web service XYZ not registered to this Web Services Framework
    • Message description: No access defined for this requester IP XYZ, dataset (XYZ) and Web service (XYZ)
    • Message description: The target Web service (XYZ) needs read access and the requested user (XYZ) doesn't have this access for that dataset (XYZ)
  • Code:406
    • Message: Not Acceptable
    • Message description: Unacceptable mime type requested
  • Code:500
    • Message:Internal Error