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

Revision as of 09:11, 21 February 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:
    • dataobjecttypes/: show available DOTs.
    • buckets/: Show and modify availabe persistent buckets.
    • workers/: Show available workers.
    • workflows/: Show and modify available workflows.
    • jobs/: Show and modify available jobs.
      • <jobName>/: show job information and start job run.
        • <jobRunId>/: monitor a job run, delete data of a finished job run.
          • finish/: Finish a job run.
          • cancel/: Cancel a job run.
          • workflowrun/<workflowRunId>/: monitor a workflow run.
            • cancel/: cancel a workflow run.
  • 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.