configure-job-using-id-514f2f6.md

Configure Job (Using ID)

This API configures a job with the updated runtime information using job ID.

You can update one or more attributes of the job using this API. If a parameter is not provided in the request or is undefined, then the existing value for the parameter is retained.

You can also use this API to create a job by providing a job name along with the job in the URI. If you use the API to create a job, the parameters must conform to the same constraints as provided in the create job API. You must also ensure that the job name in the request URI matches with the job name in the request body.

Routes

PUT /scheduler/jobs/ {jobId}

Request Parameters

Path

Parameter	Required	Data Type	Description
jobId	Yes	integer	ID of the job to be updated

Body

Parameter	Data Type	Description
description	string	Sets the description of the job.
active	boolean	Determines if a job must be activated or deactivated.
action	string	Sets the job action url. Note: Relevant for your production scenario: To encrypt data during the communication between the SAP Job Scheduling service and the application, make sure that you use HTTPS in the URL for the action endpoint to be called when the job runs.
httpMethod	string	HTTP method of the job action endpoint URL. Allowed values are “GET”, “POST”, “PUT”, and “DELETE”.
startTime	string/object/null	Start time for the job. The scheduler respects the start time of both the schedule and the job. For more information about supported formats, see Date and Time Format.
endTime	string/object/null	End time for the job. The scheduler respects the end time of both the schedule and the job. For more information about supported formats, see Date and Time Format.
ansConfig	object	The ansConfig object has two boolean keys: onSuccess: On true, a success alert notification is sent to the SAP Alert Notification Service. On false, no notification is sent. onError: On true, an error alert notification is sent to the SAP Alert Notification Service. On false, no notification is sent. Restriction: This feature is only available in the Cloud Foundry environment.

Example

PUT /scheduler /jobs/3

{
	"active": true,
	"httpMethod": "GET"
}

 

Responses

Status Code: 200

The call was successful.

Example

{
  "success": true
}

Status Code: 400

The API was unable to process the request because of invalid data provided.

Related Information

Create Job

Configure Job (Using Name)

Delete Job

Retrieve Job Details

Retrieve All Jobs

Retrieve Job Run Logs

Retrieve Job Run Log Details

Update Job Run Log

Create Job Schedule

Configure Job Schedule

Delete Job Schedule

Activate or Deactivate All Job Schedules

Delete All Job Schedules

Retrieve Job Schedule Details

Retrieve Job Schedules

SAP Alert Notification service for SAP BTP