Revision: Lister

From OSF Wiki
Revision as of 22:20, 1 December 2014 by Mike (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Revision: Lister endpoint version:
2.1
3

The overall Revision services within OSF manage various versions of an instance record. The Revision: Lister Web service is used to list all of the revisions that exist for a given record.

Version

This documentation page is used for the version 3 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 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.

Web Service Endpoint Information

This section describes all you 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: True
  • Update: False
  • Delete: False

As shown on the graph URI:

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:

  • GET

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:

URI dynamic parameters description:

Note: All parameters have to be URL-encoded

  • uri. URI of the record for which you want the revisions
  • dataset. Dataset URI where to index the RDF document. Note: this is the Dataset URI, and not the Dataset Revisions URI
  • mode. Verbosity of the records to return with this endpoint. One of:
    • short — Get the list of all the URIs of all the revisions for that record and their date stamp (for ordering purposes)
    • long (default) — Get the list of all the URIs, revision performer, their lifecycle stage and their date stamp (for ordering purposes) for that record
  • interface. 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'
  • version. Version of the source interface that is compatible with this query. If this parameter is omitted, then the latest version of the source interface is used for this query.

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.


Example of Returned XML Document

This is an example of the XML document returned by this Web service endpoint for a given URI. This example returns a list of datasets accessible by a given user IP.

Query:
  • http://[...]/ws/revision/lister/?mode=long&dataset=http://localhost/datasets/hin/documents/local/&uri=http://crud_update_test_2"

"Accept:" HTTP header field value:

  • text/xml

Result: 

 1 <?xml version="1.0" encoding="utf-8"?>
 2 <!DOCTYPE resultset PUBLIC "-//Structured Dynamics LLC//Revision Lister DTD 0.1//EN" "revision/lister/revisionLister.dtd">
 3   <resultset>
 4   <prefix entity="owl" uri="http://www.w3.org/2002/07/owl#" />
 5   <prefix entity="rdf" uri="http://www.w3.org/1999/02/22-rdf-syntax-ns#" />
 6   <prefix entity="rdfs" uri="http://www.w3.org/2000/01/rdf-schema#" />
 7   <prefix entity="iron" uri="http://purl.org/ontology/iron#" />
 8   <prefix entity="xsd" uri="http://www.w3.org/2001/XMLSchema#" />
 9   <prefix entity="wsf" uri="http://purl.org/ontology/wsf#" />
10   <subject type="wsf:Revision" uri="http://localhost/datasets/hin/documents/local/revisions/1369229400.4983">
11     <predicate type="wsf:revisionTime">
12       <object type="xsd:double">1369229400.4983</object>
13     </predicate>
14     <predicate type="wsf:performer">
15       <object uri="127.0.0.1"  />
16     </predicate>
17     <predicate type="wsf:status">
18       <object uri="http://purl.org/ontology/wsf#published"  />
19     </predicate>
20   </subject>
21   <subject type="wsf:Revision" uri="http://localhost/datasets/hin/documents/local/revisions/1369229362.9246">
22     <predicate type="wsf:revisionTime">
23       <object type="xsd:double">1369229362.9246</object>
24     </predicate>
25     <predicate type="wsf:performer">
26       <object uri="127.0.0.1"  />
27     </predicate>
28     <predicate type="wsf:status">
29       <object uri="http://purl.org/ontology/wsf#archive"  />
30     </predicate>
31   </subject>
32 </resultset>

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).


HTTP 200

Message Description
OK


HTTP 400

ID Level Name Description
WS-REVISION-LISTER-200 Warning No Target Dataset URI No target dataset URI defined for this request. A target dataset URI is needed for the mode 'ws' and 'dataset'
WS-REVISION-LISTER-201 Warning No Target Record URI No target record URI defined for this request.
WS-REVISION-LISTER-300 Fatal Requested source interface not existing The source interface you requested is not existing for this web service endpoint.
WS-REVISION-LISTER-301 Fatal Requested incompatible Source Interface version The version of the source interface you requested is not compatible with the version of the source interface currently hosted on the system. Please make sure that your tool get upgraded for using this current version of the endpoint.
WS-REVISION-LISTER-302 Fatal Source Interface's version not compatible with the web service endpoint's The version of the source interface you requested is not compatible with the one of the web service endpoint. Please contact the system administrator such that he updates the source interface to make it compatible with the new endpoint version.
WS-REVISION-LISTER-303 Fatal Requested mode non-existing The mode requested for this query is not existing. Known modes are: 'uri', 'short' and 'full'.
WS-REVISION-LISTER-304 Fatal Couldn't get the list of revisions for this record The query used to get the list of revisions for this record failed.

HTTP 403

ID Level Name Description
WS-AUTH-VALIDATION-100 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-101 Fatal Unauthorized Request Your request cannot be authorized for this web service call
WS-AUTH-VALIDATION-102 Fatal Couldn't authorize request An internal error occured when we tried to authorize this request
WS-AUTH-VALIDATION-103 Fatal Unauthorized Request Your request cannot be authorized for this user: "---", on this dataset: "---", using this web service endpoint: "---"


HTTP 406

Message Description
Not Acceptable Unacceptable mime type requested


HTTP 500

Message Description
Internal Error
Retrieved from "http://wiki.opensemanticframework.org/index.php?title=Revision:_Lister&oldid=8280"