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
| (18 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
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. | 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. | ||
| − | + | * '''<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| | + | ** <tt>[[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|pipeline/]]</tt>: Show, modify and invoke available pipelines. |
** <tt>jobmanager/</tt>: JobManager entry page, just links to the APIs below: | ** <tt>jobmanager/</tt>: JobManager entry page, just links to the APIs below: | ||
*** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List_data_object_types|dataobjecttypes/]]</tt>: show available DOTs. | *** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List_data_object_types|dataobjecttypes/]]</tt>: show available DOTs. | ||
| − | *** <tt>buckets/</tt>: Show and modify availabe persistent buckets. | + | *** <tt>[[SMILA/Documentation/DataObjectTypesAndBuckets#List.2C_create.2C_and_modify_buckets|buckets/]]</tt>: Show and modify availabe persistent buckets. |
| − | *** <tt>workers/</tt>: Show available workers. | + | *** <tt>[[SMILA/Documentation/WorkerAndWorkflows#List_workers|workers/]]</tt>: Show available workers. |
| − | *** <tt>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>jobs/</tt>: Show | + | *** <tt>[[SMILA/Documentation/JobDefinitions#List.2C_create.2C_modify_jobs|jobs/]]</tt>: Show and modify available jobs. |
| − | **** <tt><jobName>/<jobRunId>/finish/</tt>: Finish a | + | **** <tt>[[SMILA/Documentation/JobDefinitions#Specific_job|<jobName>/]]</tt>: show job information and start job run. |
| − | **** <tt>< | + | ***** <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> | + | ****** <tt>[[SMILA/Documentation/JobRuns#Cancel_job_run|cancel/]]</tt>: Cancel a job run. |
| − | ** <tt>tasks/</tt>: Show and inspect worker task queues. | + | ****** <tt>[[SMILA/Documentation/JobRuns#Monitor_a_workflow_run|workflowrun/<workflowRunId>/]]</tt>: monitor a workflow run. |
| − | ** <tt>importing/</tt>: Entry page for service APIs of the | + | ******* <tt>[[SMILA/Documentation/JobRuns#Cancel_workflow_run|cancel/]]</tt>: cancel a workflow run. |
| − | *** <tt>delta/</tt>: Show and cleanup state of datasources in Delta service. | + | ** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|job/<jobName>/]]</tt>: Bulkbuilder Push API |
| − | *** <tt>visitedlinks/</tt>: Show and cleanup state of datasources in VisitedLinks service. | + | *** <tt>[[SMILA/Documentation/Bulkbuilder#Record_push_REST_API|record/]]</tt>: Add a record to a running job for adding or deleting. |
| − | ** <tt>store/</tt>: Show, modify and inspect the ObjectStore service. | + | *** <tt>[[SMILA/Documentation/Bulkbuilder#push_a_micro_bulk|bulk/]]</tt>: Add a bulk of records to a running job for adding or deleting. |
| + | ** <tt>[[SMILA/Documentation/TaskManager#External_REST_API|tasks/]]</tt>: Show and inspect worker task queues. | ||
| + | ** <tt>importing/</tt>: Entry page for service APIs of the importing framework, just links to APIs below: | ||
| + | *** <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/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/AgentController#HTTP_ReST_JSON_interface|agents/]]</tt>: Show and control ageints in the old ConnectivityFramework ('''deprecated''') | ||
** <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>/taskmanager/</tt>: TaskManager API for | + | * '''<tt>[[SMILA/Documentation/TaskManager#Internal_REST_API|/taskmanager/]]</tt>''': TaskManager API for workers not running embedded in SMILA. ''Not intended for usage with web browsers'' |
| − | * <tt>/zookeeper/</tt>: Inspect contents of Zookeeper's z-node tree | + | * '''<tt>/zookeeper/</tt>''': Inspect contents of Zookeeper's z-node tree. For debugging purposes. |
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.
- <jobRunId>/: monitor a job run, delete data of a finished job run.
- <jobName>/: show job information and start job run.
- job/<jobName>/: Bulkbuilder Push API
- 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.