Clj-osf 0.1.1

Clojure API for Open Semantic Framework web services queries

clj-osf.auth.lister

Send a Auth Lister Query to a OSF Auth Lister web service endpoint

The Auth: Lister Web service is used to list all of the datasets accessible to a given user, list all of the datasets accessible to a given user with all of its CRUD permissions, to list all of the Web services registered to the WSF (Web Services Framework) and to list all of the CRUD permissions, for all users, for a given dataset created on a WSF.

This Web service is used to list all the things that are registered / authenticated in a Web Service Framework network.

clj-osf.auth.registrar.access

Send a Auth Registrar Access Query to a OSF Auth Registrar Access web service endpoint

The Auth Registrar: Access Web service is used to register (create, update and delete) an access for a given IP address, to a specific dataset and all the registered Web services endpoints registered to the WSF (Web Services Framework) with given CRUD (Create, Read, Update and Delete) permissions in the WSF.

This Web service is intended to be used by content management systems, developers or administrators to manage access to WSF (Web Service Framework) resources (users, datasets, Web services endpoints).

This web service endpoint is used to create what we refer to as an access permissions record. This record describe the CRUD permissions, for a certain IP address, to use a set of web service endpoints, to query a target dataset.

To use the Auth: Registrar Access code, you have to:

clj-osf.auth.registrar.group

Send a Auth Registrar Group Query to a OSF Auth Registrar Group web service endpoint

The Auth Registrar: Group Web service is used to register a new Group to the OSF instance. This group will be used to give access to the group’s users to certain datasets.

To use the Auth: Registrar Group code, you have to:

Public variables and functions:

clj-osf.auth.registrar.user

Send a Auth Registrar User Query to a OSF Auth Registrar User web service endpoint

The Auth Registrar: User Web service is used to register a user to an existing Group. This means that the user will have access to all the datasets accessible to that group of users.

To use the Auth: Registrar User code, you have to:

Public variables and functions:

clj-osf.auth.registrar.ws

Send a

To use the Auth: Registrar WS code, you have to:

clj-osf.cognonto.classify

Public variables and functions:

clj-osf.cognonto.tag.concepts

Public variables and functions:

clj-osf.core

If the application/json mime type is specified for a OSF query (it is the default format used by all the endpoints) then the JSON resultset returned by the endpoints will be transformed in a native EDN format.

Public variables and functions:

clj-osf.crud.create

Send a Create Query to a OSF Crud Create web service endpoint

clj-osf.crud.delete

Send a CRUD Delete Query to a OSF Crud Delete web service endpoint

The CRUD: Delete Web service is used to delete an existing instance record indexed in some target dataset of a WSF. When the instance record gets deleted, all of the information archived in the dataset is deleted as well.

Public variables and functions:

clj-osf.crud.read

Send a CRUD Read query to a OSF Crud Read web service endpoint

The CRUD: Read Web service is used to get the description of a target instance record indexed in a dataset belonging to an Open Semantic Framework instance.

clj-osf.crud.update

Send a Crud Update Query to a OSF Crud Update web service endpoint

The CRUD: Update Web service is used to update an existing instance record indexed in a target dataset part of a WSF (Web Services Framework).

clj-osf.dataset.create

Send a Dataset Create Query to a OSF Dataset Create web service endpoint

Public variables and functions:

clj-osf.dataset.delete

Send a Dataset Delete Query to a OSF Dataset Delete web service endpoint

The Dataset: Delete Web service is used to delete an existing dataset in a WSF (Web Services Framework). When a dataset gets deleted, all of the information archived in it is deleted as well. There is no way to recover any data once this query is issued.

Public variables and functions:

clj-osf.dataset.read

Send a Dataset Read Query to a OSF Dataset Read web service endpoint

The Dataset: Read Web service is used to get information (title, description, creator, contributor(s), creation date and last modification date) for a dataset belonging to the WSF (Web Services Framework).

Public variables and functions:

clj-osf.dataset.update

Send a Dataset Update Query to a OSF Dataset Update web service endpoint

The Dataset: Update Web service is used to update the description of an existing dataset in a WSF (Web Services Framework).

Public variables and functions:

clj-osf.ontology.create

Send a Ontology Create service is used to create/import a new OWL ontology into the OSF instance.

clj-osf.ontology.delete

Send an Ontology Delete service is used to delete an OWL ontology existing in the OSF 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.

To use the Ontology: Delete code, you have to:

clj-osf.ontology.read

Send an Ontology Read Query to a OSF Ontology Read web service endpoint

The Ontology Read service is used to query OWL ontologies. All kinds of information can be read on different ontology entities such as: classes, object properties, datatype properties, annotation properties and individuals. Reasoners can also be used to include inferred facts in the service’s resultset. A full list of actions can be performed that enables you to leverage your ontologies, properly and effectively.

This service is a Web service wrapper over the OWLAPI ontology library. Most of the API has been implemented. So we can say that this Web service (with the other related OSF services) turns the OWLAPI into a Web service API.

To use the Ontology: Read code, you have to:

clj-osf.ontology.update

Send an Ontology Update service is used to update an OWL ontology existing in the OSF instance.

This service is a web service wrapper over the OWLAPI ontology library. It wraps all the needed functionalities related to updating 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.

There is an important semantic distinction to do: this endpoint is about UPDATING an ontology. This means that we may be updating ontologies resources, or creating new ones. The logic is that by creating new resources (such as classes, properties and named individuals) we are updating the ontology.

This is what this web service endpoint is about. To update or create an existing resource, the requester only has to send the RDF description of that resource to update or create. If the resource is existing, it will get updated, if it is not, it will get added.

To use the Ontology: Update code, you have to:

clj-osf.revision.delete

Send a

To use the Revision: Delete code, you have to:

Public variables and functions:

clj-osf.revision.diff

Send a Revision Diff Query to a OSF Revision Diff web service endpoint

The Revision: Diff web service endpoint is used to compare two revisions of the same record. A ChangeSet which contains all the added and removed triples between the two revisions is returned.

To use the Revision: Diff code, you have to:

Public variables and functions:

clj-osf.revision.lister

Send a Revision Lister Query to a OSF Revision Lister web service endpoint

The Revision: Lister web service endpoint is used to list all the revisions existing for a record. All the revision records have a unix timestamp in microseconds. This timestamp is defined as a double. All the revisions records can be sorted using this timestamp. If a user want to see what was the description of a record at a specific time, then he will use the Revision: Read web service endpoint to get all the triple of that record, for that revision.

To use the Revision: Lister code, you have to:

Public variables and functions:

clj-osf.revision.read

Send a Revision Read Query to a OSF Revision Read web service endpoint

The Revision: Read web service endpoint is used to read a specific revision of a record. This endpoint will return all the triples, including reification triples, of a specific revision record. This web service endpoint can be used to get all the triples, which includes the triples that defines the revision itself. But it can also be used to re-create the original state of the record when it got revisioned. This “original” state simple remove the revision specific triples and change the URI to its original one (and not the revision URI).

To use the Revision: Read code, you have to:

Public variables and functions:

clj-osf.revision.update

Send a Revision Update Query to a OSF Revision Update web service endpoint

The Revision: Update web service endpoint is used to change the lifestage status of a revision record. If you change the lifecycle stage of a unpublished revision to published, then this will replace the currently published record by this newly published revision. If you change the status of a currently published record to something else than published, then it will unpublish the record, and this record won’t be accessible anymore in the ‘public’ dataset. This record will always be available via its revisions, however if the CRUD: Read web service endpoint is used with its URI, then it will return an error saying the record is not existing in the dataset. However, you could re-publish this record anytime in the future using this Revision: Update web service endpoint.

clj-osf.search

Send a The Search Web service is used to perform full text searches on the structured data indexed on a OSF instance. A search query can be as simple as querying the data store for a single keyword, or to query it using a series of complex filters. Each search query can be applied to all, or a subset of, datasets accessible by the requester. All of the full text queries comply with the Lucene querying syntax.

Each Search query can be filtered by these different filtering criteria: + Type of the record(s) being requested + Dataset where the record(s) got indexed + Presence of an attribute describing the record(s) + A specific value, for a specific attribute describing the record(s) + A distance from a lat/long coordinate (for geo-enabled OSF instance) + A range of lat/long coordinates (for geo-enabled OSF instance)

To use the Search code, you have to:

clj-osf.sparql

Send a SPARQL Query to a OSF SPARQL web service endpoint

The SPARQL Web service is used to send custom SPARQL queries against the OSF data structure. This is a general purpose querying Web service.

To use the SPARQL code, you have to:

Public variables and functions:

clj-osf.utils

Different utility functions that can be used in conjunction with the DSL to perform some specific tasks.

Public variables and functions: