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 11: | Line 11: | ||
*** <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/ | + | **** <tt>[[SMILA/Documentation/JobDefinitions#Specific_job|<jobName>/]]</tt>: show job information and start job run. |
| − | ***** <tt>[[SMILA/Documentation/JobRuns# | + | ***** <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| | + | ****** <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/Bulkbuilder#Record_push_REST_API|job/<jobName>/record/]]</tt>: Add a record to a running job for adding or deleting. | ** <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/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#push_a_micro_bulk|job/<jobName>/bulk/]]</tt>:Add a bulk of records to a running job for adding or deleting. | ||
Revision as of 06:55, 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>/: show job information and start job run.
- <jobRunId>/: monitor a job run, delete data of a finished job run.
- <jobName>/: show job information and start job run.
- 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