Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The list of entities include:

  • Action Procedure to represent publicly available function 
    • Role to check required access
    • An action A procedure contains list of Step as a superclass for three kind of steps:
      • Operational step - execute an operation
        • An operation works in the aspect of data manipulation (read/write). Should be reusable by design. There are three types of operations:

          • SPARQL Query (SPARQL query to get information from triplestore)
          • Template as a superclass for all templates  (to use as an interface)
            • N3 Template
            • Optionally any other type of templates
          • Solr Query (to get data from Solr core)
        • Operations require and provide Parameters which might be linked with set of Validators to validate request parameters and results.  
          • Set of validators, parameter types and models???
      • Conditional step - controlling process flow by defining condition and two branches - true and false (which are executed depending on result of condition). True  and false branches are steps and can be any of three kind of steps.  
      • Iterative step  - repeat set of steps while some condition is not meet. 
  • There is also a set of entities for defining how a dynamic action procedure should be exposed for usage:
    • The ResourceAPI entity is used to represent REST resources with it’s name, supported api versions and set of RPC of dynamic actions executed on access to the resource with different http methods or custom named actions. 
      • Custom action to define a name for custom REST actions and forward requests to an Action. HTTPmethod to provide predefined http methods to choose in RPC.
    • RPC to represent remote procedure call with it’s access name, default http method and assigned api versions. 
      • HTTPmethod to provide predefined http methods to choose in RPC.

The prefix for the ontology is http://vivoweb.org/ontology/vitro-dynamic-api/.

...