Create a new job
post
/iam/governance/selfservice/api/v1/scheduler/jobs
Creates a new job in the scheduler with the provided details.
Request
Supported Media Types
- application/json
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 create a new job in the scheduler with the provided details by submitting the POST request using cURL. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -i -X POST -u username:password / --header 'Content-Type: application/json' / --header 'Accept: application/json' / --header 'X-Requested-By: <anyvalue>' -d @post.json / 'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/'
Example of POST Request Body
The following example shows the contents of the request body in JSON format:
{
"jobName": "Test Job",
"taskName": "OIM Certification Purge Task",
"retryCount": 1,
"parameters": {
"Cert Campaigns for Purge": {
"value": 11
},
"Purge Retention Period(in days)": {
"value": 5
},
"Purge Criteria": {
"value": 1
},
"Maximum Purge Run Duration(in Mins)": {
"value": 6
}
}
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"jobName": "Test Job",
"status": "Job Create successfull"
}