Running a task in the Scheduler
Use this API to run a task in the Scheduler.
Requirement: OpenSearchServer v1.5
Call parameters
URL: /services/rest/index/{index_name}/scheduler/{scheduler_name}/run
Method: PUT
Header:
- Content-Type (required):
application/json - Optional return type:
- Accept:
application/json - Accept:
application/xml
URL parameters:
- index_name (required): The name of the index.
- scheduler_name (required): The name of the scheduler.
Body of request:
Variables can be sent to the Scheduler, which will pass them on to the relevant tasks (like the Database crawler - run task). Variables must be given as a JSON array.
{
"mod_date": "20141205"
}
Empty variables can be given as an empty string:
{
"mod_date": ""
}
Success response
The task in the Scheduler has been started. Its status is returned.
HTTP code:
200
Content (application/json):
{
"successful":true,
"isRunning":false,
"isActive":true,
"lastExecutionDate":"2014-12-29T23:00:00+0000",
"taskInfos":[
{
"name":"Query check",
"startDate":"2014-12-29T23:00:00+0000",
"endDate":"2014-12-29T23:00:00+0000",
"duration":0,
"infos":"JSON Path succeed: 637"
},
{
"name":"Query check",
"startDate":"2014-12-28T23:00:00+0000",
"endDate":"2014-12-28T23:00:00+0000",
"duration":0,
"infos":"JSON Path succeed: 691"
}
]
}
Error response
The crawl failed. The reason is provided in the content.
HTTP code:
500
Sample call
Using CURL:
Simple call:
curl -XPUT -H "Content-Type: application/json" \
http://localhost:8080/services/rest/index/my_index/scheduler/my_job/run
Using jQuery:
$.ajax({
type: "PUT",
dataType: "json",
url: "http://localhost:8080/services/rest/index/my_index/scheduler/my_job/run"
}).done(function (data) {
console.log(data);
});