/custom/savedquery/schedulejob/{jobtitle}/{jobdesc}/{communityIds}/{timeToRun}/{frequencyToRun}/{query}/{inputcollection}/{outputKey}/{outputValue}
| Info |
|---|
Schedules a query job. Returns the output collection id in the data field of the response if successfully queued to run. A simple web-based utility is available for scheduling jobs. |
Authentication
Required, see Auth - Login.
Arguments
jobtitle (required)
A descriptive name of the job being submitted.
...
frequencyToRun (required)
How often the job should be ran, either: NONE, HOURLY, DAILY, WEEKLY, MONTHLY. This will cause the job to get resubmitted after running, use NONE if you only want the job to run once.
query (required)
The mongo query to use to get the jobs data. {} is a blank query or you can submit null. A typical place to get a query is by using the gui at infinite.ikanow.com and going to Advanced -> Save.JSON object to call.
inputcollection (required)
The mongo collection you want to use as input. DOC_METADATA is the only currently available option.
...
outputValue (required)
Currently set to "null" will be used in the future.
Example
Example Response
| Info | ||
|---|---|---|
|
Error Response
| Info | ||
|---|---|---|
|