Jump to: navigation, search

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

Line 7: Line 7:
 
** <tt>jobmanager/</tt>: JobManager entry page, just links to the APIs below:
 
** <tt>jobmanager/</tt>: JobManager entry page, just links to the APIs below:
 
*** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List_data_object_types|dataobjecttypes/]]</tt>: show available DOTs.
 
*** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List_data_object_types|dataobjecttypes/]]</tt>: show available DOTs.
*** <tt>buckets/</tt>: Show and modify availabe persistent buckets.
+
*** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List.2C_create.2C_and_modify_buckets|buckets/]]</tt>: Show and modify availabe persistent buckets.
*** <tt>workers/</tt>: Show available workers.
+
*** <tt>[[SMILA/Documentation/WorkerAndWorkflows#List_workers|workers/]]</tt>: Show available workers.
*** <tt>workflows/</tt>: Show and modify available workflows.
+
*** <tt>[[SMILA/Documentation/WorkerAndWorkflows#List.2C_create.2C_and_modify_workflows|workflows/]]</tt>: Show and modify available workflows.
*** <tt>jobs/</tt>: Show, modify and start available jobs.
+
*** <tt>[[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|jobs/]]</tt>: Show and modify available jobs.
**** <tt><jobName>/<jobRunId>/finish/</tt>: Finish a running job.
+
**** <tt>[[SMILA/Documentation/JobRuns#Start_job_run|<jobName>/]]</tt>: start and monitor job runs.
**** <tt><jobName>/<jobRunId>/cancel/</tt>: Cancel a running job.
+
***** <tt>[[SMILA/Documentation/JobRuns#Finish_job_run|<jobRunId>/finish/]]</tt>: Finish a job run.
*** <tt>job/<jobName>/record/</tt>: Add a record to a running job for adding or deleting.
+
***** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|<jobRunId>/cancel/]]</tt>: Cancel a job run.
*** <tt>job/<jobName>/bulk/</tt>:Add a bulk of records to a running job for adding or deleting.
+
** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|job/<jobName>/record/]]</tt>: Add a record to a running job for adding or deleting.
** <tt>tasks/</tt>: Show and inspect worker task queues.
+
** <tt>[[SMILA/Documentation/Bulkbuilder#push_a_micro_bulk|job/<jobName>/bulk/]]</tt>:Add a bulk of records to a running job for adding or deleting.
 +
** <tt>[[SMILA/Documentation/TaskManager#External_REST_API|tasks/]}</tt>: Show and inspect worker task queues.
 
** <tt>importing/</tt>: Entry page for service APIs of the asynchronous importing framework.
 
** <tt>importing/</tt>: Entry page for service APIs of the asynchronous importing framework.
*** <tt>delta/</tt>: Show and cleanup state of datasources in Delta service.
+
*** <tt>[[SMILA/Documentation/Importing/DeltaCheck#DeltaService_ReST_API|delta/]]</tt>: Show and cleanup state of datasources in Delta service.
 
*** <tt>visitedlinks/</tt>: Show and cleanup state of datasources in VisitedLinks service.
 
*** <tt>visitedlinks/</tt>: Show and cleanup state of datasources in VisitedLinks service.
** <tt>store/</tt>: Show, modify and inspect the ObjectStore service.
+
** <tt>[[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore#Handlers_in_org.eclipse.smila.objectstore|store/]]</tt>: Show, modify and inspect the ObjectStore service.
 
** <tt>debug/</tt>: Internal information for debugging purposes. May change at any time and without notice, therefore intentionally left undocumented.
 
** <tt>debug/</tt>: Internal information for debugging purposes. May change at any time and without notice, therefore intentionally left undocumented.
* <tt>/taskmanager/</tt>: TaskManager API for external workers.
+
* <tt>[[SMILA/Documentation/TaskManager#Internal_REST_API|/taskmanager/]]</tt>: TaskManager API for workers not running embedded in SMILA.
 
* <tt>/zookeeper/</tt>: Inspect contents of Zookeeper's z-node tree
 
* <tt>/zookeeper/</tt>: Inspect contents of Zookeeper's z-node tree

Revision as of 05:51, 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:
    • 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.
    • [[SMILA/Documentation/TaskManager#External_REST_API|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 workers not running embedded in SMILA.
  • /zookeeper/: Inspect contents of Zookeeper's z-node tree