Catalogue restful service

From Gcube Wiki
Revision as of 11:53, 23 May 2017 by Costantino.perciante (Talk | contribs) (Catalogue Web Service)

Jump to: navigation, search

** THIS PAGE IS UNDER CONSTRUCTION **

Catalogue Web Service

Starting from gCube 4.5 a new RESTFul Web Service has been created to let external services/users interact with the D4Science's catalogues. It exploits the underneath CKAN[1] APIs, but at the same time allows to perform operations on the catalogue using the security gCube token.

You are suggested to read the main catalogue wiki page before continue.

Retrieve your gCube Security Token

A security token is a UUID bind to yourself and a given Infrastructure context. To retrieve it, you just need to go to a VRE for which you are interested in retrieving it, and use the Authorisation Options portlet (see below)

Authorisation option.png

Click on Show button and select the token. We will use it later on.

Retrieve web service endpoint

The service endpoint url depends on the context you are interesting in. You could either access to the Infrastructure Monitor of the Infrastructure and looking for a GCore EndPoint having as name Catalogue-WS and Service Class Data-Catalogue, or perform the same look up operation programmatically with the ICClient library.

For the development environment, it is available at:

http://catalogue-ws-d-d4s.d4science.org/catalogue-ws/rest

Supported operations Overview (gCube 4.5)

The APIs allow to interact with the catalogue and perform the following operations on it.

Licenses

Organizations

Groups

Resources

Items

Items Profiles

  1. An overview about this technology and the APIs it offers can be found here http://docs.ckan.org/en/latest/api/