Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "SMILA/Documentation/REST API Reference"
< SMILA | Documentation
Line 2: | Line 2: | ||
− | * <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|pipelines/]]</tt>: Show, modify and invoke available pipelines. | ||
Line 22: | Line 22: | ||
** <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>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. |
− | * <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 06:52, 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 and modify available jobs.
- <jobName>/: start and monitor job runs.
- <jobRunId>/finish/: Finish a job run.
- <jobRunId>/cancel/: Cancel a job run.
- <jobName>/: start and monitor job runs.
- 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 workers not running embedded in SMILA.
- /zookeeper/: Inspect contents of Zookeeper's z-node tree