System - Update job

API Url

Used to update a single scheduled job.

PUT

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

Permissions: user

Path parameters

Field	Type	Description
jobNo	Number	Job number.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
jobs	Object	The job object to be updated.
appServer	String	Name of AppServer responsible with the job.
delay	Number	Max. no. of hours after start time that job must be started.
description	String	The description of the job.
execute	Number	Job execution type (1: date, 2: weekDays, 3: alldays, 4: Recurrence).
restart`optional`	Boolean	true = Restart job on AppServer. Only Administrators can restart a job!
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.
weekDay	Number	Used only for execute type 2 : 1=Sunday, 2=Monday,...7=Saturday

Request example:

HTTP/1.1 200 OK
{
   "request": {
      "data": {
         "job": {
              "startDate": "2016-07-10",
              "startTime": "846644",
              "execute": 1,
              "weekDay": 0,
              "delay": 0,
              "appServer": "",
              "description": "Description",
              "restart": true   
           }              
      },
   }
}

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": 354,
      "errorMessage": "Job does not exist"
   }
}