Authentication Service
Operations related to authentication and roles.
Java Interface Name: org.openanzo.servicecontainer.services.IAuthorizationService
Authenticate System/Admin User
Authenticate a System/Admin User.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/systemUsers
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/authenticateSystemUser
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: authenticateSystemUser
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| password | The password for the id the user is authenticating against. | String | ||
| userId | The id the user is authenticating against. | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| User's URI. | org.openanzo.servicecontainer.AnzoPrincipal? | text/text application/json text/csv | JMS: text/text Rest: application/json WS: text/text |
Authenticate User
Authenticate a User.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/users
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/authenticateUser
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: authenticateUser
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| password | The password for the id the user is authenticating against. | String | ||
| userId | The id the user is authenticating against. | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| User's URI. | org.openanzo.servicecontainer.AnzoPrincipal? | text/text application/json text/csv | JMS: text/text Rest: application/json WS: text/text |
Get Roles For Graph
Get roles for the given NamedGraph URI
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)/roles
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getRolesForGraph
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: getRolesForGraph
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | The URI for the NamedGraph for which to retrieve roles. | URI | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Set of URIs for the Roles that have permission to read the given NamedGraph. | java.util.Set<org.openrdf.model.URI> | text/text text/csv | JMS: text/text Rest: text/text WS: text/text |
Get Roles For User
Get the URIs for the roles for which the user is a member.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/users(?userUri)/roles
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getRolesForUser
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: getRolesForUser
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| userUri | The URI of the user for which to retrieve roles. | URI | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Set of URIs for the Roles for which a user is a member. | java.util.Set<org.openrdf.model.URI> | text/text text/csv | JMS: text/text Rest: text/text WS: text/text |
Get User Principal
Get a User's URI.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/users(?userId)
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getUser
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: getUserPrincipal
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| userId | The id of the user for which to retrieve a URI. | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| URI. | org.openanzo.servicecontainer.AnzoPrincipal? | text/text application/json text/csv | JMS: text/text Rest: application/json WS: text/text |
Get Users For Graph
Get users that have permission to read the given NamedGraph.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)/users
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getUsersForGraph
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: getUsersForGraph
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | The URI of the NamedGraph for which to retrieve users. | URI | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Set of URIs for the Users which have permission to read the given NamedGraph. | java.util.Set<org.openrdf.model.URI> | text/text text/csv | JMS: text/text Rest: text/text WS: text/text |
Get Users For Graph
Get users that have permission to read the given NamedGraph.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)/users
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getUserPermission
JMS Info
JMS Queue Name: services/authorization
JMS Operation Name: getUserPermission
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | The URI of the namedGraph. | URI | ||
| privilege | Privilege. | null | ||
| userUri | The URI of the user. | URI |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Set of URIs for the Users which have permission to read the given NamedGraph. | boolean |
Index Service
Operations related to quering the index data on the server
Java Interface Name: org.openanzo.servicecontainer.services.IIndexService
Execute Query Index
Run a query against the index on the server and returns the results in a collection of statements.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/statements/index
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/queryIndex
JMS Info
JMS Queue Name: services/index
JMS Operation Name: queryIndex
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| query | Sparql query text. | String | ||
| numberOfResults | Max number of results to return | Integer | ||
| offset | Offset into the number of results to return | Integer | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Collection of statements that match the index query. | java.util.Collection<org.openrdf.model.Statement> | JMS: application/x-trig Rest: application/json WS: application/x-trig |
Model Service
Operations related to updating and quering the data on the server
Java Interface Name: org.openanzo.servicecontainer.services.IModelService
Find Statements
Find the set of statements that match a Statement pattern.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/statements
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/findStatements
JMS Info
JMS Queue Name: services/model
JMS Operation Name: findStatements
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | NamedGraph URI Resource to match, or wildcard if null or equal to Any | Resource | ||
| object | Object Value to match, or wildcard if null or equal to Any | Value | ||
| predicate | Predicate URI to match, or wildcard if null or equal to Any | URI | ||
| subject | Subject Resource to match, or wildcard if null or equal to Any | Resource | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Collection of statements that match the find statements. | java.util.Collection<org.openrdf.model.Statement> | JMS: application/x-trig Rest: application/json WS: application/x-trig |
Get MetadataGraph URI
Get the URI of a NamedGraph's metadata graph.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)/metadataUri
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getMetadataGraphUri
JMS Info
JMS Queue Name: services/model
JMS Operation Name: getMetadataGraphUri
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | URI of NamedGraph to retrieve | URI |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Size of NamedGraph. | org.openrdf.model.URI |
Get NamedGraph Revision
Get an INamedGraphWithMetaData for a specific NamedGraph at the specific revision.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getNamedGraphRevision
JMS Info
JMS Queue Name: services/model
JMS Operation Name: getNamedGraphRevision
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | URI of NamedGraph to retrieve | URI | ||
| revision | Revision of NamedGraph to retrieve, -1 for the current revision | Long | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| INamedGraphWithMetadata conveyed as a collection of statements. | org.openanzo.model.INamedGraphWithMetaData | application/json application/x-trig application/trix | JMS: application/x-trig Rest: application/json WS: application/x-trig |
Get Size
Get the size of a NamedGraph.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs(?namedGraphUri)/size
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getSize
JMS Info
JMS Queue Name: services/model
JMS Operation Name: getSize
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| namedGraphUri | URI of NamedGraph to retrieve | URI |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Size of NamedGraph. | long |
Get Stored NamedGraphs
Get the set of URIs for the NamedGraphs that user can read.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/namedGraphs
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/getStoredNamedGraphs
JMS Info
JMS Queue Name: services/model
JMS Operation Name: getStoredNamedGraphs
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| URIs for the NamedGraphs that user can read. | java.util.Set<org.openrdf.model.URI> | text/text text/csv | JMS: text/text Rest: text/text WS: text/text |
Notification Registration Service
Operations related to managing notification subscribers and their subscriptions.
Register Subscriber
Register a subscriber with the server.
User Must be in sysadmin role: false
JMS Info
JMS Queue Name: services/notification
JMS Operation Name: registerSubscriber
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| replyTo | Reply To destination. | JMS Destination |
Response Body
| Description | Type | Valid Formats | Default Formats |
| True if registration successful . | boolean |
Register Trackers
Register trackers with the notification server.
User Must be in sysadmin role: false
JMS Info
JMS Queue Name: services/notification
JMS Operation Name: registerTrackers
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| replyTo | Reply To destination. | JMS Destination | ||
| trackers | Set of trackers to register. | Set if ITrackers | application/x-trig application/trix application/json | JMS: application/x-trig |
| trackersFormat | Serialization format for trackers | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| True if registration successful . | boolean |
Unregister Subscriber
Unregister a subscriber with the server.
User Must be in sysadmin role: false
JMS Info
JMS Queue Name: services/notification
JMS Operation Name: unregisterSubscriber
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| replyTo | Reply To destination. | JMS Destination |
Response Body
| Description | Type | Valid Formats | Default Formats |
| True if unregistration successful . | boolean |
Unregister Trackers
Unregister trackers with the notification server.
User Must be in sysadmin role: false
JMS Info
JMS Queue Name: services/notification
JMS Operation Name: unregisterTrackers
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| replyTo | Reply To destination. | JMS Destination | ||
| trackers | Set of trackers to register. | Set if ITrackers | application/x-trig application/trix application/json | JMS: application/x-trig |
| trackersFormat | Serialization format for trackers | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| True if registration successful . | boolean |
Query Service
Operations related to quering the server
Java Interface Name: org.openanzo.servicecontainer.services.IQueryService
Ask Query
Run a Sparql Ask query on the server and return the results in a QueryResult object.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/sparql/ask
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/query
JMS Info
JMS Queue Name: services/query
JMS Operation Name: askQuery
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| baseURI | Base URI for query. | URI | ||
| currentData | Run ask against current, uncommitted data. | Boolean | ||
| defaultNamedGraphs | URIS of NamedGraphs to union together as the defaultModel for the dataset the query is run againstShould operation return the additions and deletions within the IModelUpdate object. | Set of URIs | text/csv text/text | JMS: text/text WS: text/text |
| defaultNamedGraphsFormat | Serialization format for defaultNamedGraphs | String | ||
| namedGraphs | URIS of NamedGraphs for the dataset the query is run against. | Set of URIs | text/csv text/text | JMS: text/text WS: text/text |
| namedGraphsFormat | Serialization format for namedGraphs | String | ||
| query | Sparql query text. | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| The results of running the query. Result format is dependent on both the type of query, and the requested format. | boolean |
Query
Run a Sparql query on the server and return the results in a QueryResult object.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/sparql
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/query
JMS Info
JMS Queue Name: services/query
JMS Operation Name: query
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| baseURI | Base URI for query. | URI | ||
| defaultNamedGraphs | URIS of NamedGraphs to union together as the defaultModel for the dataset the query is run againstShould operation return the additions and deletions within the IModelUpdate object. | Set of URIs | text/csv text/text | JMS: text/text WS: text/text |
| defaultNamedGraphsFormat | Serialization format for defaultNamedGraphs | String | ||
| namedGraphs | URIS of NamedGraphs for the dataset the query is run against. | Set of URIs | text/csv text/text | JMS: text/text WS: text/text |
| namedGraphsFormat | Serialization format for namedGraphs | String | ||
| query | Sparql query text. | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| The results of running the query. Result format is dependent on both the type of query, and the requested format. | org.openanzo.model.impl.query.QueryResult? | application/json application/sparql-results+xml | JMS: application/sparql-results+xml Rest: application/sparql-results+xml WS: application/sparql-results+xml |
Replication Service
Operations related to replicating data from the server
Java Interface Name: org.openanzo.servicecontainer.services.IReplicationService
Replicate
Replicates changes between the client and the server.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/statements/replication
Rest Method Type: GET
WebService Info
WebService call name: http://openanzo.org/replicate
JMS Info
JMS Queue Name: services/replication
JMS Operation Name: replicate
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| handler | Callback handler for results | null | ||
| marker | Timestamp of last replication, 0 if first replication | Long | ||
| newTrackers | Set of unreplicated notification trackers. | Set if ITrackers | application/x-trig application/trix application/json | JMS: application/x-trig Rest: application/json WS: application/x-trig |
| newTrackersFormat | Serialization format for newTrackers | String | ||
| trackers | Set of already replicated notification trackers. | Set if ITrackers | application/x-trig application/trix application/json | JMS: application/x-trig Rest: application/json WS: application/x-trig |
| trackersFormat | Serialization format for trackers | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| Results of replication operation. | long | application/anzo-xml application/json | JMS: application/anzo-xml Rest: application/json WS: application/anzo-xml |
Reset Service
Operations related to resetint the data on the server
Java Interface Name: org.openanzo.servicecontainer.services.IResetService
Reset
Utility method that resets all data on the Server and reinitializes server to set of provided statements. This should only be used for testing. Operation can be turned off on the server.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo
Rest Method Type: PUT
WebService Info
WebService call name: http://openanzo.org/reset
JMS Info
JMS Queue Name: services/reset
JMS Operation Name: reset
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| JMS: (body) REST: (body) WS:statements | Set of statements that are used to reinitialize the server. | Collection of Statements | JMS: application/x-trig Rest: application/json WS: application/x-trig | |
| statementsFormat | Serialization format for statements | String |
Rules Service
Operations related to rules data on the server
Java Interface Name: org.openanzo.servicecontainer.services.IRulesService
Add inferred predicate
Add an inferred predicate.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/rules/predicates
Rest Method Type: PUT
WebService Info
WebService call name: http://openanzo.org/addInferredPredicate
JMS Info
JMS Queue Name: services/rules
JMS Operation Name: addInferredPredicate
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| inferredPredicate | The inferredPredicate. | URI | ||
| predicate | The predicate. | URI |
Add inferred predicate
Add an inferred predicate.
User Must be in sysadmin role: true
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/rules/objects
Rest Method Type: PUT
WebService Info
WebService call name: http://openanzo.org/addInferredObject
JMS Info
JMS Queue Name: services/rules
JMS Operation Name: addInferredObject
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| inferredObject | The inferredObject. | URI | ||
| object | The object. | URI | ||
| predicate | The predicate. | URI |
Update Service
Operations related to updating data on the server
Java Interface Name: org.openanzo.servicecontainer.services.IUpdateService
Update Server
Sends a set of transactions to the server to be processed.
User Must be in sysadmin role: false
Rest Info
Rest Endpoint URL: http://host[:port]/anzo/statements
Rest Method Type: POST
WebService Info
WebService call name: http://openanzo.org/update
JMS Info
JMS Queue Name: services/update
JMS Operation Name: update
Request Parameters
| Paremeter Name | Description | Type | Valid Formats | Default Formats |
| returnResults | Should operation return the additions and deletions within the IModelUpdate object. | Boolean | ||
| JMS: (body) REST: (body) WS:transactions | Set of transactions to commit on the server. | Array of transactions | application/json application/anzo-xml | JMS: application/anzo-xml Rest: application/json WS: application/anzo-xml |
| transactionsFormat | Serialization format for transactions | String | ||
| resultFormat | Serialization format for response | String |
Response Body
| Description | Type | Valid Formats | Default Formats |
| If returnResults is true, IModelUpdates will include the changes that occured on the server due to this update or if the transaction failed, the set of errors. If returnResults is false, only errors will be returned. | org.openanzo.services.IModelUpdate | application/json application/anzo-xml | JMS: application/anzo-xml Rest: application/json WS: application/anzo-xml |
