The Open Anzo Project

Semantic Application Middleware

  • Home
  • Community
  • License
  • About
Sponsors
Cambridge Semantics Inc.

Clients can communicate with the server using a set of webservice calls. Those calls and the contents of those calls are described here.

A lot of calls rely on the base64 encoded gzipped XML transport representation of data.

Reset

This call is used to reset the server's contents,and optionally initialize the server with the provided set of statements. 

 URI of call: http://openanzo.org/reset
 Parameters:  http://openanzo.org/graph : base64 encoded gzipped XML transport representation of data  
 Results:

GetSize

This call returns the size,the number of statements, of a NamedGraph. 

 URI of call: http://openanzo.org/getSize
 Parameters:  http://openanzo.org/namedGraphUri : base64 encoded URI of the NamedGraph of which to find size  
 Results:     http://openanzo.org/size          : Number of statements in the NamedGraph

GetStoredNamedGraphs

This call returns the URIs of the NamedGraphs stored in the server, that the user has permission to read. 

 URI of call: http://openanzo.org/getStoredNamedGraphs
 Parameters:  
 Results:     http://openanzo.org/results : Comma delimited list of URIs

GetMetadataGraphUri

This call retrieves the URI of a NamedGraph's metadata graph. 

 URI of call: http://openanzo.org/getMetadataGraphUri
 Parameters:  http://openanzo.org/namedGraphUri     : base64 encoded URI of the NamedGraph of which to find the metadata graph  
 Results:     http://openanzo.org/metadataGraphUri  : base64 encoded URI of the metadata graph

GetUsersForGraph

This call returns the URIs of the users that have permission to read data within the given NamedGraph 

 URI of call: http://openanzo.org/getUsersForGraph
 Parameters:  http://openanzo.org/namedGraphUri        : base64 encoded URI of the NamedGraph of which to find valid users  
 Results:     http://openanzo.org/usersForGraphResults : base64 encoded Comma delimited list of URIs for the users that can read this graph

GetRolesForGraph

This call returns the URIs of the roles that have permission to read data within the given NamedGraph 

 URI of call:  http://openanzo.org/getRolesForGraph
 Parameters:   http://openanzo.org/namedGraphUri        : base64 encoded URI of the NamedGraph of which to find valid users  
 Results:      http://openanzo.org/rolesForGraphResults : base64 encoded Comma delimited list of URIs of the roles that can read this graph

GetUserUri

This call determines the URI of the user identified by the given user id. 

 URI of call: http://openanzo.org/getUserUri
 Parameters:  http://openanzo.org/userId  : base64 encoded User ID of user for which to find a URI
 Results:     http://openanzo.org/getUserUriResults : base64 encoded URI of user for the given id

AuthenticateUser

This call authenticates the provided userid and password, and if successful returns the URI of the user with the system 

 URI of call: http://openanzo.org/authenticateUser
 Parameters:  http://openanzo.org/userId    : base64 encoded login id of user
              http://openanzo.org/password  : base64 encoded password of the user
 Results:     http://openanzo.org/authenticateUserResults  : base64 encoded URI of user in system, if authentication was successful

GetRolesForUser

This call returns a list of the roles that the user is a member 

 URI of call: http://openanzo.org/getRolesForUser
 Parameters:  http://openanzo.org/userId    : base64 encoded URI of user for which to find roles
 Results:     http://openanzo.org/getRoleForUserResults : base64 encoded Comma delimited list of URIs for the roles the user is a member

FindStatementOperation

This call returns the set of statements that match the provided statement pattern. 

 URI of call: http://openanzo.org/findStatements
 Parameters:  http://openanzo.org/includeInferredTriples  :  boolean parameter that signifies that inferred statements should be included in results
              http://openanzo.org/namedGraphUri   : base64 encoded URI of NamedGraph to match, or http://openanzo.org/types/ANY for wildcard
              http://openanzo.org/subject         : base64 encoded Subject Resource to match, or http://openanzo.org/types/ANY for wildcard
              http://openanzo.org/predicate       : base64 encoded Predicate URI to match, or http://openanzo.org/types/ANY for wildcard 
              http://openanzo.org/object          : base64 encoded Object Value to match, or http://openanzo.org/types/ANY for wildcard
 Results:     http://openanzo.org/findStatementResults  : base64 encoded gzipped XML transport representation of data

GetNamedGraphRevision

This call returns the contents of a NamedGraph at a given revision 

 URI of call: http://openanzo.org/getNamedGraphRevision
 Parameters:  http://openanzo.org/namedGraphUri        : base64 encoded URI of the NamedGraph of which to fetch data
              http://openanzo.org/revision             : base64 encoded The revision number to fetch, or -1 for the current revision on the server
 Results:     http://openanzo.org/namedGraphRevisionResults  : base64 encoded gzipped XML transport representation of data

QueryOperation

This call runs a Sparql query on the server, and returns the results 

 URI of call: http://openanzo.org/query
 Parameters:  http://openanzo.org/queryString                        : base64 encoded Sparql query to run
              http://openanzo.org/queryNamedGraphs (multiple)        : Zero or more base64 encoded URIs for the queries named graph set
              http://openanzo.org/queryDefaultNamedGraphs (multiple) : Zero or more base64 encoded URIs for the queries defaultgraph set
 Results:     http://openanzo.org/queryResultsType : Type of results being returned (0=SELECT, 1=CONSTRUCT, 2=ASK, 3=DESCRIBE)
              http://openanzo.org/queryResults     : Format of results depends on type
                                                     SELECT:     Base64 encoded gzipped Sparql XML query results
                                                     CONSTRUCT : Base64 encoded gzipped RDF/XML results
                                                     ASK       : Boolean result value

QueryIndexOperation

This call queries the text indexer for matching statements 

 URI of call: http://openanzo.org/queryIndex
 Parameters:  http://openanzo.org/queryString     : base64 encoded Query for indexer
              http://openanzo.org/queryLanguage   : Type of indexer to query
              http://openanzo.org/queryStartIndex : Offset into the results
              http://openanzo.org/queryNumResults : Number of results to return
 Results:     http://openanzo.org/queryIndexResults : Base64 encoded gzipped RDF/XML results

ReplicateOperation

This call replicates changes between the server and a client. 

 URI of call: http://openanzo.org/replicate
 Parameters:  http://openanzo.org/marker  :  Timestamp of previous replication, or 0 for first time replicating
              http://openanzo.org/newTrackerArray : Array of new trackers since last replication
                    http://openanzo.org/tracker[] : Element within array
                         http://openanzo.org/namedGraphUri   : base64 encoded URI of NamedGraph to match  (optional)
                         http://openanzo.org/subject         : base64 encoded Subject Resource to match   (optional)
                         http://openanzo.org/predicate       : base64 encoded Predicate URI to match      (optional)
                         http://openanzo.org/object          : base64 encoded Object Value to match       (optional)
              http://openanzo.org/trackerArray    : Array of trackers that have already replcated
                    http://openanzo.org/tracker[] : Element within array
                         http://openanzo.org/namedGraphUri   : base64 encoded URI of NamedGraph to match  (optional)
                         http://openanzo.org/subject         : base64 encoded Subject Resource to match   (optional)
                         http://openanzo.org/predicate       : base64 encoded Predicate URI to match      (optional)
                         http://openanzo.org/object          : base64 encoded Object Value to match       (optiona
 Results:    http://openanzo.org/marker  :  Timestamp of completed replication
             http://openanzo.org/results : base64 encoded gzipped XML transport representation of data

UpdateOperation

This call is used for the client to send the server a set of updates. 

 URI of call: http://openanzo.org/update
 Parameters:  http://openanzo.org/includeResults   : Should the results contain the statements added and removed on the server as part of update call
              http://openanzo.org/stream           : base64 encoded gzipped XML transport representation of data
 Results:     http://openanzo.org/results          : base64 encoded gzipped XML transport representation of data

AddInferredPropertyOpertion

This call is not currently used 

 URI of call: 
 Parameters:  
 Results:

AddInferredObjectOpertion

This call is not currently used 

 URI of call: 
 Parameters:  
 Results:
  • Home
  • Community
  • License
  • About
Copyright © 2007 - 2008 OpenAnzo.org