System - Get all jobs

API Url

Used to get all scheduled jobs.

GET

http://localhost:16010/ProMarkREST/rest/System/jobs

Permissions: user

Query parameters

Field	Type	Description
jobType`optional`	integer	1: Standard job, 2: ProReport.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
jobs	Object[]	Collection with job data.
active	Boolean	true = Job is currently running.
appServer	String	Name of AppServer responsible with the job.
canEdit	Boolean	True = Logged in user can change the report.
createdBy	String	Job Owner.
delay	Number	Max. seconds after start time that job must be started.
description	String	Description of the job.
execute	Number	Job execution type (1: date, 2: weekDays, 3: alldays, 4: Recurrence).
jobNo	Number	Job number.
nextRun	Date	Time of the next job run as date-time ISO-8601.
parentId	String	ID used to retrieve other connected data.
private	Boolean	Report's security status.
sharedWith`optional`	String	Available only for ownder. A list of users ids of users that have access to the report.
startDate	Date	The start date of the first run as date ISO-8601.
startTime	Number	Time of day when job is executed, expressed in seconds from midnight.
type	Number	1: Standard job, 2: ProReport.
weekDay	Number	Used only for execute type 2 : 1=Sunday, 2=Monday,...7=Saturday.
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:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "jobs": [
           {
              "jobNo": 1878,
              "createdBy": "R",
              "nextRun": "2017-04-04T00:00:00.000",
              "startDate": "2017-03-28",
              "startTime": 0,
              "execute": 2,
              "weekDay": 2,
              "type": 1,
              "parentId": "",
              "active": false,
              "delay": 400000000,
              "appServer": "",
              "description": "Auto clock-in/out for categories 2"  
              "canEdit": true,
              "private": true                 
           }
         ]
      },
      "erorCode": 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.