Skip to content

Latest commit

 

History

History
140 lines (82 loc) · 2.45 KB

check-parameters-for-scheduling-a-job-b331bde.md

File metadata and controls

140 lines (82 loc) · 2.45 KB

Check Parameters for Scheduling a Job

Check the parameter string that you intend to schedule a job with. This call makes the same checks as the Check button contained within the Application Jobs app.

You can include the following properties in the URL of the request:

Property

Necessity

Comment

JobTemplateName

Mandatory

This is the name of the application job.

JobParameterValues

Mandatory

These are the parameter values of the application job. For more information, see 3383044.

JobUser

Optional

This is the user under whom the application job is supposed to run. This field is kept optional for compatibility reasons only. It's recommended to always provide the job user when making the call.

The operation returns:

  • Parameter String: An overview of the supplied parameter string. (In some applications, the supplied parameters can be changed by the framework. In such cases, a string with the changed parameters is returned in the response).

  • Successful Indicator: Returns true when the supplied parameters are allowed. Otherwise it will return false.

  • Changed Indicator: Returns true if the parameters have been adjusted. Otherwise it will return false.

  • Dynamic Properties: <Reserved>

  • Error Messages: Shows errors or warnings regarding the supplied parameter string.

Request

POST <host>/sap/opu/odata/SAP/BC_EXT_APPJOB_MANAGEMENT;v=0002/JobScheduleCheck?JobTemplateName='TemplateName'&JobParameterValues='ParameterValueString'&JobUser='UserName'

Response

{
					"d": {
					"results": [
					{
					"JobParameterValues": "ParameterValueString",
					"SuccessfulInd": "boolean",
					"ChangedInd": "boolean",
					"DynamicProperties": "",
					"ErrMessages": "ErrorMessagesString",
					}
					]
					}
					}