System - Get a job's details

API Url

Used to get details of a job > only used for reccurrence setup.

GET

http://localhost:16010/ProMarkREST/rest/System/jobs/{jobNo}/details

Permissions: user

Path parameters

Field	Type	Description
jobNo	Number	Job number.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
recurrence	Object	The recurrence setup. Only for 'Recurrent' jobs.
daily`optional`	Object	Setup for daily executions.
calendarDays	Boolean	Daily execution should be only in calendar days (true=Calendar days, false=Working days).
every	Number	Repeat every X days.
end	Number	1: No end date, 2: End after X occurences, 3: End on a date.
endAfter`optional`	Number	End after X occurences (only if 'end' = 2).
endOn`optional`	Date	End on a date (only if 'end'=3).
hourly`optional`	Object	Setup for hourly executions.
end	Number	End of activation interval used with Hourly schedule.
every	Number	Repeat every X hours.
hoursList	Number	A list of hours when to run the job (only if 'type'=2). Size range: `5`
start	Number	Start of activation interval used with Hourly schedule.
type	Number	1: Repeat every X hours, 2: Use a list of hours.
weekDays	Boolean	Weekdays when job is to be executed, starting with Sunday. Size range: `7`
monthly`optional`	Object	Setup for monthly executions.
absoluteDay	Number	Day of month to run on. Only when 'onAbsoluteDay'=true. Size range: `1-31`
every	Number	Repeat every X months.
onAbsoluteDay	Boolean	true=Repeat on a specific day, false=Repeat on a relative day.
relativeDay	Number	Relative day of month to run on (1=First, 2=Second, 3=Third, 4=Forth, 5=Last). Only when 'onAbsoluteDay'=false. Size range: `1-5`
relativeWeekday	Number	Relative weekday of month to run on (1=Sun, 2=Mon, 3=Tue, 4=Wed, 5=Thu, 6=Fri, 7=Sat). Used together with 'relativeDay'. Only when 'onAbsoluteDay'=false. Size range: `1-7`
repeatUnit	Number	Repeat execution (1=Daily, 2=Weekly, 3=Monthly, 4=Yearly, 5=Hourly).
start	Date	First day of recurrence.
time	Number	Time of day when job needs to be executed, expressed in seconds from midnight.
weekly`optional`	Object	Setup for weekly executions.
every	Number	Repeat every X weeks.
weekDays	Boolean	Weekdays when report is to be executed, starting with Sunday. Size range: `7`
yearly`optional`	Object	Setup for yearly executions.
absoluteDay	Number	Day of month to run on. Used together with 'month'. Only when 'onAbsoluteDay'=true. Size range: `1-31`
month	Number	Month of year when to run the report (1=Jan, 2=Feb, 3=Mar ...). Only when 'onAbsoluteDay'=true. Size range: `1-12`
onAbsoluteDay	Boolean	true=Repeat on a specific month & day, false=Repeat on a relative month & day.
relativeDay	Number	Relative day of month to run on (1=First, 2=Second, 3=Third, 4=Forth, 5=Last). Only when 'onAbsoluteDay'=false. Size range: `1-5`
relativeWeekday	Number	Relative weekday of month to run on (1=Sun, 2=Mon, 3=Tue, 4=Wed, 5=Thu, 6=Fri, 7=Sat). Used together with 'relativeDay'. Only when 'onAbsoluteDay'=false. Size range: `1-7`
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example with a single shift:

HTTP/1.1 200 OK
 {
    "response": {
       "data": {
           "recurrence": {
               "repeatUnit": 5,
               "time": 57600,
               "start": "2017-04-03",
               "end": 1,
               "hourly": {
                  "every": 0,
                  "type": 2,
                  "hoursList": [
                      72000,
                      57600,
                      28800,
                      0,
                      0
                  ],
                  "weekDays": [
                      false,
                      true,
                      false,
                      true,
                      false,
                      false,
                      false
                   ]
               }
          }
       },
     "errorCode": 0,
     "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.

Error example:

HTTP/1.1 404 Not found
{
   "response": {
      "errorCode": 426,
      "errorMessage": "Job does not exist"
   }
}