REST API for Scheduler in OIG

Add/Update the trigger details

put

/iam/governance/selfservice/api/v1/scheduler/jobs/{jobName}/trigger

Adds or updates the trigger of a job.

Request

Supported Media Types

application/json

Path Parameters

jobName(required): string

Name of the job

Root Schema : Trigger

Type: object

Show Source

endTime: string(date-time)

Format: yyyy-MM-dd'T'HH:mm:ss'Z'
intervalType: string
intervalValues: array intervalValues
jobName: string
nextFireTime: string(date-time)

Format: yyyy-MM-dd'T'HH:mm:ss'Z'
startTime: string(date-time)

Format: yyyy-MM-dd'T'HH:mm:ss'Z'
triggerName: string
triggerType: string

Allowed Values: [ "Cron", "Periodic", "Single", "None" ]

{
    "type":"object",
    "properties":{
        "triggerName":{
            "type":"string"
        },
        "jobName":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
        },
        "nextFireTime":{
            "type":"string",
            "format":"date-time",
            "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
        },
        "triggerType":{
            "type":"string",
            "enum":[
                "Cron",
                "Periodic",
                "Single",
                "None"
            ]
        },
        "intervalType":{
            "type":"string"
        },
        "intervalValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : intervalValues

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Success

Type: object

Show Source

jobName: string
status: string

Status of the executed action

{
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"Status of the executed action"
        }
    }
}

400 Response

Invalid input

Examples

The following example shows how to add or update the trigger of a job 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/trigger/'

Example of PUT Request Body

The following example shows the contents of the request body in JSON format:

{
    "startTime": "2021-11-24T17:44:00Z",
    "intervalType": "MONTHLYWEEKDAYS",
    "triggerType": "Cron",
    "intervalValues": [
        "Fourth Monday"
    ]
}

Example of PUT Response Body

The following example shows the contents of the response body in JSON format:

{
    "jobName": "Catalog Synchronization Job",
    "status": "Trigger add successfull"
}