Version 1.13.2

Download RAML

Report of JobScheduler Agent tasks

Parameters in the POST body schema

Name Type Description Example Default
jobschedulerId optional, string JobScheduler Master ID scheduler
agents optional, array Filters response by a collection of agents specified by its url [ ]
dateFrom optional, string The value has multiple formats
  • a format for a date in ISO 8601 format where the time offset and milliseconds are optional, e.g.
    • YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
    • YYYY-MM-DDThh:mm:ss[.s][+01:00]
    • YYYY-MM-DDThh:mm:ss[.s][+0100]
    • YYYY-MM-DDThh:mm:ss[.s][+01]
  • a format for a time period in relative to the current time, e.g. 6h, 12h, 1d, 1w can specify in addition with a time offset 0 or digits followed by a letter are expected where the letter has to be:
    • s (seconds)
    • m (minutes)
    • h (hours)
    • d (days)
    • w (weeks)
    • M (months)
    • y (years)
  • a time offset is optional (e.g. 2d+02:00)
    • it can be also specify with the parameter timeZone
    • if timeZone undefined then UTC is used
  • the value 0 means the current time
  • Returns only collection items younger than this date.
dateTo optional, string The value has multiple formats like the dateFrom parameter
  • Return only collection items older than this date.
timeZone optional, string
  • If this parameter is set then it beats the time offset in dateFrom and dateTo
  • See here the list for available time zones.