Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/REST API Reference"

Line 5: Line 5:
 
** <tt>[[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|pipelets/]]</tt>: Show available pipelets.
 
** <tt>[[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|pipelets/]]</tt>: Show available pipelets.
 
** <tt>[[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|pipelines/]]</tt>: Show, modify and invoke available pipelines.
 
** <tt>[[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|pipelines/]]</tt>: Show, modify and invoke available pipelines.
** <tt>jobmanager/</tt>: JobManager entry page.
+
** <tt>jobmanager/</tt>: JobManager entry page, just links to the APIs below:
 
*** <tt>dataobjecttypes/</tt>: show available DOTs.
 
*** <tt>dataobjecttypes/</tt>: show available DOTs.
 
*** <tt>buckets/</tt>: Show and modify availabe persistent buckets.
 
*** <tt>buckets/</tt>: Show and modify availabe persistent buckets.

Revision as of 06:27, 19 January 2012

This page is intended to serve as a cross reference to the SMILA manual based on the SMILA ReST API. It lists all URLs of the ReST API and links them to the manual page that describes it.


  • /smila/: Main entry page: system state overview and links to the other APIs.
    • pipelets/: Show available pipelets.
    • pipelines/: Show, modify and invoke available pipelines.
    • jobmanager/: JobManager entry page, just links to the APIs below:
      • dataobjecttypes/: show available DOTs.
      • buckets/: Show and modify availabe persistent buckets.
      • workers/: Show available workers.
      • workflows/: Show and modify available workflows.
      • jobs/: Show, modify and start available jobs.
        • <jobName>/<jobRunId>/finish/: Finish a running job.
        • <jobName>/<jobRunId>/cancel/: Cancel a running job.
      • job/<jobName>/record/: Add a record to a running job for adding or deleting.
      • job/<jobName>/bulk/:Add a bulk of records to a running job for adding or deleting.
    • tasks/: Show and inspect worker task queues.
    • importing/: Entry page for service APIs of the asynchronous importing framework.
      • delta/: Show and cleanup state of datasources in Delta service.
      • visitedlinks/: Show and cleanup state of datasources in VisitedLinks service.
    • store/: Show, modify and inspect the ObjectStore service.
    • debug/: Internal information for debugging purposes. May change at any time and without notice, therefore intentionally left undocumented.
  • /taskmanager/: TaskManager API for external workers.
  • /zookeeper/: Inspect contents of Zookeeper's z-node tree