INinvoiceninja
task_schedulers

Gets a new blank scheduler object

Changed on

Returns a blank object with default values

get/api/v1/task_schedulers/create

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

A blank scheduler object

pausedboolean

The scheduler paused state

repeat_everystring

Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)

start_frominteger

Timestamp when we should start the scheduler, default is today

jobstring

Job, we can find list of available jobs in Scheduler model

date_rangestring

The string representation of the date range of data to be returned

date_keystring

The date column to search between.

start_datestring

The start date to search between

end_datestring

The end date to search between

report_keysstring[]

Example response

{
  "repeat_every": "DAY",
  "start_from": 1652898504,
  "job": "create_credit_report",
  "date_range": "last7",
  "date_key": "created_at",
  "start_date": "2022-10-31",
  "end_date": "2022-10-31",
  "report_keys": [
    "['name','date']"
  ]
}

Changes

  • 69a36036d334Revision changes
    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status