Update job details
put
/iam/governance/selfservice/api/v1/scheduler/jobs/{jobName}
Updates the details of a job such as a parameter value or retry count.
Request
Supported Media Types
- application/json
Path Parameters
-
jobName: string
Name of the job
Root Schema : JobDetails
Type:
Show Source
object-
concurrent(optional):
boolean
-
cronScheduleType(optional):
string
-
isEnabled(optional):
boolean
-
jobName:
string
-
jobScheduleType(optional):
string
-
notification(optional):
object notification
-
parameters(optional):
array parameters
-
retryCount:
integer(int32)
-
status(optional):
string
Allowed Values:
[ "STOPPED", "RUNNING", "INTERRUPTED" ]Order Status -
taskName:
string
Nested Schema : JobParameter
Type:
Show Source
object-
dataType(optional):
string
Allowed Values:
[ "String", "Number", "Boolean", "ITResource" ] -
helpText(optional):
string
-
required(optional):
boolean
-
value:
string
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Success
Type:
Show Source
object-
jobName(optional):
string
-
status(optional):
string
Status of the executed action
400 Response
Invalid input
Examples
The following example shows how to update the details of a job such as a parameter value or retry count by submitting the PUT request using cURL. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -i -X PUT -u username:password / --header 'Content-Type: application/json' / --header 'Accept: application/json' / --header 'X-Requested-By: <anyvalue>' -d @put.json' / 'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog Synchronization Job'
Example of PUT Request Body
The following example shows the contents of the request body in JSON format:
{
"parameters": {
"Application Instance Name": {
"value":"ALL"
},
"Mode": {
"value":"Revoke"
},
"Batch Size": {
"value":"500"
}
}
}
Example of PUT Response Body
The following example shows the contents of the response body in JSON format:
{
"status": "Job Update successfull"
}