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>: | + | * <tt>/smila/</tt>: Main entry page: system state overview and links to the other APIs. |
− | ** <tt>pipelets/</tt> | + | ** <tt>pipelets/</tt>: Show available pipelets. |
− | ** <tt>pipelines/</tt> | + | ** <tt>pipelines/</tt>: Show, modify and invoke available pipelines. |
− | ** <tt>jobmanager/</tt> | + | ** <tt>jobmanager/</tt>: JobManager entry page. |
− | *** <tt>dataobjecttypes/</tt>: show available DOTs | + | *** <tt>dataobjecttypes/</tt>: show available DOTs. |
− | *** <tt>buckets/</tt>: | + | *** <tt>buckets/</tt>: Show and modify availabe persistent buckets. |
− | *** <tt>workers/</tt> | + | *** <tt>workers/</tt>: Show available workers. |
− | *** <tt>workflows/</tt> | + | *** <tt>workflows/</tt>: Show and modify available workflows. |
− | *** <tt>jobs/</tt> | + | *** <tt>jobs/</tt>: Show, modify and start available jobs. |
− | **** <tt><jobName>/<jobRunId>/finish/</tt> | + | **** <tt><jobName>/<jobRunId>/finish/</tt>: Finish a running job. |
− | **** <tt><jobName>/<jobRunId>/cancel/</tt> | + | **** <tt><jobName>/<jobRunId>/cancel/</tt>: Cancel a running job. |
− | ** <tt>job/ | + | *** <tt>job/<jobName>/record/</tt>: Add a record to a running job for adding or deleting. |
− | + | *** <tt>job/<jobName>/bulk/</tt>:Add a bulk of records to a running job for adding or deleting. | |
− | *** <tt><jobName>/bulk/</tt> | + | ** <tt>tasks/</tt>: Show and inspect worker task queues. |
− | ** <tt>tasks/</tt> | + | ** <tt>importing/</tt>: Entry page for service APIs of the asynchronous importing framework. |
− | ** <tt>importing/</tt> | + | *** <tt>delta/</tt>: Show and cleanup state of datasources in Delta service. |
− | *** <tt>delta/</tt> | + | *** <tt>visitedlinks/</tt>: Show and cleanup state of datasources in VisitedLinks service. |
− | *** <tt>visitedlinks/</tt> | + | ** <tt>store/</tt>: Show, modify and inspect the ObjectStore service. |
− | ** <tt>store/</tt> | + | ** <tt>debug/</tt>: Internal information for debugging purposes. May change at any time and without notice, therefore intentionally left undocumented. |
− | ** <tt>debug/</tt> | + | * <tt>/taskmanager/</tt>: TaskManager API for external workers. |
− | * <tt>/taskmanager/</tt> | + | * <tt>/zookeeper/</tt>: Inspect contents of Zookeeper's z-node tree |
− | * <tt>/zookeeper/</tt> | + |
Revision as of 05:58, 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.
- dataobjecttypes/: show available DOTs.
- buckets/: Show and modify availabe persistent buckets.
- workers/: Show available workers.
- workflows/: Show and modify available workflows.
- jobs/: Show, modify and start available jobs.
- <jobName>/<jobRunId>/finish/: Finish a running job.
- <jobName>/<jobRunId>/cancel/: Cancel a running job.
- 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 external workers.
- /zookeeper/: Inspect contents of Zookeeper's z-node tree