My favorites | Sign in
Project Logo
                
Search
for
Updated Nov 26, 2009 by myriam.l...@gmail.com
Labels: Deprecated
RestApiSpecification  
Specifies the REST API for Linked Service Data

Introduction

The Hackystat LinkedServiceData works on Projects, Users and Issues resources which already exist in the Hackystat SensorBase, but it works better if additional details on them are provided. These additional details are:

Additional functionalities provided:
  • addition or deletion of external LiSeD servers included in your network;
  • deletion of cache data;
  • browsing data. For example viewing the list of users, projects, issues, network servers, or their own single profiles;
  • perform search over the whole network, for users, projects and issues.

Because of these necessities the following Api is provided. NOTE about the table below:

  • It's assumed that every response is represented in the requested RDF serialization language and properly linked to other URIs following the Linked Data principles.
  • A user logged as the specified SensorBase administer he can ask for a response to any of the following specified requests; while if it's not so, the accessibility level is specified in deeper details within the following "Accessibility" column.

API only for Hackystat registered users

Because of structure of the other Hackystat services on which LiSeD relies, only Hackystat registered users are allowed to receive a proper response to the following described requests.

MethodURIDescriptionAccessibility
GET {host}/users List of URIs referred to all the users registered on the specified SensorBase server. Currently the SensorBase allows a response only if you're logged as the SensorBase administer.
GET {host}/users/{user} Description of the specified user's profile. Currently the SensorBase allows a response only if you're logged as the specified user himself.
GET {host}/projects List of URIs referred to all the projects stored on the specified SensorBase server. Currently the SensorBase allows a response only if you're logged as the SensorBase administer.
GET {host}/projects/{user} List of URIs referred to all the projects in which the specified user is involved. Currently the SensorBase allows a response only if you're logged as the specified user himself.
GET {host}/projects/{owner}/{project} Description of the specified project's profile. Currently the SensorBase allows a response only if you're involved in that specified project.
GET {host}/issues List of URIs referred to all the issues stored on the specified SensorBase server. Currently the SensorBase allows a response only if you're logged as the SensorBase administer.
GET {host}/issues/{id} Description of the issue's profile specified by mean of its ID.
GET {host}/users/sparql?query={query} Search for user's URIs whose profile satisfies the specified (UTF-8 encoded) query. Search results are based on data taken from all the external LiSeD network servers, while locally, if you're not logged as the SensorBase administer, only your own profile can be considered.
GET {host}/projects/sparql?query={query} Search for project's URIs whose profile satisfies the specified (UTF-8 encoded) query. Search results are based on data taken from all the external LiSeD network servers, while locally, if you're not logged as the SensorBase administer, only those projects in which you're involved can be considered.
GET {host}/issues/sparql?query={query} Search for issue's URIs whose profile satisfies the specified (UTF-8 encoded) query. Search results are based on data taken from all the external LiSeD network servers, while locally, if you're not logged as the SensorBase administer, only those issues collected by your own sensors can be considered.
GET {host}/command/{user}/{command} Description of the specified command used by the specified user. Depending on the level of details collected by the sensor in use, this can include command arguments, result, operating system and machine in use. Currently the SensorBase allows a response only if you're logged as the specified user himself.
GET {host}/devPhase/{user}/{project}/{phaseId} Description of the specified software development phase (by mean of its ID) defined for the specified project. Depending on what kind of data the user has stored for this phase, its description can include URIs of phases that it preceeds, involved users and potential issues. Currently the SensorBase allows a response only if you're logged as the specified user himself.
DELETE {host}/network/{uri} Removes the specified URI from the list of LiSeD network servers. Administer
DELETE {host}/cache Deletes any cached LiSeD instance associated with the logged user.
DELETE {host}/cache/{user} Deletes any cached LiSeD instance associated with this user.
DELETE {host}/cache/{user}/{project} Deletes any cached LiSeD instance associated with this user and project.
DELETE {host}/cache/others Deletes any cached LiSeD instance not associated with any user.

API for anyone

MethodURIDescriptionAccessibility
GET {host}/programmingLanguage/{name} Description of the specified programming language. Anyone
GET {host}/operatingSystem/{name} Description of the specified operating system. Anyone
GET {host}/machine/{name} Description of the specified machine. Anyone
GET {host}/tool/{name} Description of the specified tool. Anyone
GET {host}/network List of those LiSeD servers included in the local network and their administer e-mails. Anyone
GET {host}/ping Return the "ping representation" of this service, which is the string "LinkedServiceData" Anyone
GET {host}/ping?user={user} &password={password} If {user} and {password} are valid credentials, returns "LinkedServiceData authenticated" Anyone


Sign in to add a comment
Hosted by Google Code