Jump to: navigation, search

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

m (Add "script" entry)
 
(One intermediate revision by one other user not shown)
Line 11: Line 11:
 
*** <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/JobDefinitions#Specific_job|<jobName>/]]</tt>: show job information and start job run.
 
**** <tt>[[SMILA/Documentation/JobDefinitions#Specific_job|<jobName>/]]</tt>: show job information and start 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#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#Finish_job_run|finish/]]</tt>: Finish a job run.
 
****** <tt>[[SMILA/Documentation/JobRuns#Finish_job_run|finish/]]</tt>: Finish a job run.
 
****** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|cancel/]]</tt>: Cancel a job run.
 
****** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|cancel/]]</tt>: Cancel a job run.
 +
****** <tt>[[SMILA/Documentation/JobRuns#Monitor_a_workflow_run|workflowrun/<workflowRunId>/]]</tt>: monitor a workflow run.
 +
******* <tt>[[SMILA/Documentation/JobRuns#Cancel_workflow_run|cancel/]]</tt>: cancel a workflow run.
 
** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|job/<jobName>/]]</tt>: Bulkbuilder Push API
 
** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|job/<jobName>/]]</tt>: Bulkbuilder Push API
 
*** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|record/]]</tt>: Add a record to a running job for adding or deleting.
 
*** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|record/]]</tt>: Add a record to a running job for adding or deleting.
Line 21: Line 23:
 
*** <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>[[SMILA/Documentation/Importing/VisitedLinks#VisitedLinks_ReST_API|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/Scripting#HTTP_REST_API|script/]]</tt>''': List all exposed scripts.
 
** <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/CrawlerController#HTTP_ReST_JSON_interface|crawlers/]]</tt>: Show and control crawlers in the old ConnectivityFramework ('''deprecated''')  

Latest revision as of 02:49, 31 October 2014

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.
    • script/: List all exposed scripts.
    • 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.