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

From Eclipsepedia

Jump to: navigation, search
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
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.
 
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.
  
 
+
* '''<tt>/smila/</tt>''': Main entry page: system state overview and links to the other APIs.
* <tt>/smila/</tt>: Main entry page: system state overview and links to the other APIs.
+
 
** <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|pipeline/]]</tt>: Show, modify and invoke available pipelines.
 
** <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.
Line 11: Line 10:
 
*** <tt>[[SMILA/Documentation/WorkerAndWorkflows#List.2C_create.2C_and_modify_workflows|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>[[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|jobs/]]</tt>: Show and modify available jobs.
 
*** <tt>[[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|jobs/]]</tt>: Show and modify available jobs.
**** <tt>[[SMILA/Documentation/JobRuns#Start_job_run|<jobName>/]]</tt>: start and monitor job runs.
+
**** <tt>[[SMILA/Documentation/JobDefinitions#Specific_job|<jobName>/]]</tt>: show job information and start job run.
***** <tt>[[SMILA/Documentation/JobRuns#Finish_job_run|<jobRunId>/finish/]]</tt>: Finish a job run.
+
***** <tt>[[SMILA/Documentation/JobRuns#Monitor_a_job_run_or_delete_job_run_data|<jobRunId>/]]</tt>: monitor a  job run, delete data of a finished job run.
***** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|<jobRunId>/cancel/]]</tt>: Cancel a job run.
+
****** <tt>[[SMILA/Documentation/JobRuns#Finish_job_run|finish/]]</tt>: Finish a job run.
** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|job/<jobName>/record/]]</tt>: Add a record to a running job for adding or deleting.
+
****** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|cancel/]]</tt>: Cancel a job run.
** <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/Bulkbuilder#Record_push_REST_API|job/<jobName>/]]</tt>: Bulkbuilder Push API
** <tt>[[SMILA/Documentation/TaskManager#External_REST_API|tasks/]}</tt>: Show and inspect worker task queues.
+
*** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|record/]]</tt>: Add a record to a running job for adding or deleting.
** <tt>importing/</tt>: Entry page for service APIs of the asynchronous importing framework.
+
*** <tt>[[SMILA/Documentation/Bulkbuilder#push_a_micro_bulk|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 importing framework, just links to APIs below:
 
*** <tt>[[SMILA/Documentation/Importing/DeltaCheck#DeltaService_ReST_API|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>[[SMILA/Documentation/Importing/VisitedLinks#VisitedLinks_ReST_API|visitedlinks/]]</tt>: Show and cleanup state of datasources in VisitedLinks 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>[[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore#Handlers_in_org.eclipse.smila.objectstore|store/]]</tt>: Show, modify and inspect the ObjectStore service.
 +
** <tt>[[SMILA/Documentation/CrawlerController#HTTP_ReST_JSON_interface|crawlers/]]</tt>: Show and control crawlers in the old ConnectivityFramework ('''deprecated''')
 +
** <tt>[[SMILA/Documentation/AgentController#HTTP_ReST_JSON_interface|agents/]]</tt>: Show and control ageints in the old ConnectivityFramework ('''deprecated''')
 
** <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>[[SMILA/Documentation/TaskManager#Internal_REST_API|/taskmanager/]]</tt>: TaskManager API for workers not running embedded in SMILA.
+
* '''<tt>[[SMILA/Documentation/TaskManager#Internal_REST_API|/taskmanager/]]</tt>''': TaskManager API for workers not running embedded in SMILA. ''Not intended for usage with web browsers''
* <tt>/zookeeper/</tt>: Inspect contents of Zookeeper's z-node tree
+
* '''<tt>/zookeeper/</tt>''': Inspect contents of Zookeeper's z-node tree. For debugging purposes.

Revision as of 09:05, 29 August 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.
    • pipeline/: Show, modify and invoke available pipelines.
    • jobmanager/: JobManager entry page, just links to the APIs below:
    • job/<jobName>/: Bulkbuilder Push API
      • record/: Add a record to a running job for adding or deleting.
      • 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 importing framework, just links to APIs below:
      • 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.
    • crawlers/: Show and control crawlers in the old ConnectivityFramework (deprecated)
    • agents/: Show and control ageints in the old ConnectivityFramework (deprecated)
    • 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. Not intended for usage with web browsers
  • /zookeeper/: Inspect contents of Zookeeper's z-node tree. For debugging purposes.