JOC API

Version 1.12.9

http(s)://test.sos-berlin.com:3001/joc/api

Download RAML
JOC API
/jobs/start
POST

Starts jobs

this resource can be used in the GUI for three functions

  • start task immediatly
  • start task at (with at)
  • start task at parametrised (with at and params)
This is only available for standalone jobs.


Parameters in the POST body schema

Name Type Description Example Default
jobschedulerId required, string JobScheduler Master ID scheduler
jobs required, array Specified the jobs which should be modified and the modification. [{
"job":"/sos/reporting/Inventory",
"at":"now+10"
}]
at optional, string
field of each jobs item
start time in ISO format yyyy-mm-dd HH:MM[:SS] or now or now + HH:MM[:SS] or now + SECONDS now+10 now
timeZone optional, string
field of each jobs item
  • This parameter set the time zone for an absolute time stamp in the at parameter.
  • This parameter is ignored for relative times in at such as "now+10"
  • See here the list for available time zones.
Berlin/Europe Time zone of the JobScheduler
params optional, array
field of each jobs item
Parameters params:[{"name":"...","value":"..."}]
environment optional, array
field of each jobs item
Environment variables environment:[{"name":"...","value":"..."}]
auditLog optional, object Object which contains comment, timeSpent and ticketLink. {
"comment":"It was not really necessary!",
"timeSpent":2
}
comment optional, string Field in auditLog to comment this action, e.g. the reason.
timeSpent optional, string Field in auditLog to enter the time spent in minutes. 5
ticketLink optional, string Field in auditLog to enter a link to a corresponding ticket.