Service Api

The main interface with the user is provided by this module. It lets them execute any operation on the system.

Some of these operations, usually those related to read details about resources, can be directly processed by this module getting the information from the internal storage.

However, other operations, mainly those related to modify the status of a resource, also imply to publish a new event-message in the event-bus with the uri of the resource and the routing-key associated to the current state of it.

For this reason, this type of requests can not be answered using the HTTP 200 code. Instead, the system will answer with the HTTP 202 code indicating that the instruction was accepted and the resource was marked for that operation.

More details about the functionality of this module, from the user point of view, here

Routing-keys

These are the routing-keys from the event-bus that this module is listening for or publishing to:

Listen for

• domain.{analyzed}

Publish to

• source.{\*}
• domain.{\*}
• document.{\*}
• item.{\*}
• part.{\*}
• relation.{\*}
• word.{\*}
• topic.{\*}
• model.{\*}

Use-Case

Let us start a simple example of use of this module. Imagine an user wants to analyze all the documents published by the UPM Digital Repository during the year 2014.

So, he/she creates a new source doing a POST request on the /sources/ uri and attaching a valid json with the following url: http://oa.upm.es/perl/oai2?in=2014.

The api module will create a new source with that url and the time filter. After that, it will store it in the internal storage and will publish a new event in the channel: source.new with the uri: sources/oa.upm.es.

Also, it will create a new domain associated to this source. It will be stored in the internal storage and will published in the channel: domain.new with the uri: domains/oa.upm.es.