REST API for Scheduler in OIG

Get job details

get

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

Retrieves the details of a job such as a parameter, failed notification, and other details.

Request

Path Parameters

jobName: string

Name of the job

Response

Supported Media Types

application/json

200 Response

Root Schema : JobDetails

Type: object

Show Source

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

{
    "required":[
        "taskName",
        "jobName",
        "retryCount"
    ],
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "jobScheduleType":{
            "type":"string"
        },
        "cronScheduleType":{
            "type":"string"
        },
        "retryCount":{
            "type":"integer",
            "format":"int32"
        },
        "concurrent":{
            "type":"boolean"
        },
        "isEnabled":{
            "type":"boolean"
        },
        "notification":{
            "type":"object",
            "properties":{
                "receiverID":{
                    "type":"string"
                },
                "receiverType":{
                    "type":"string"
                }
            }
        },
        "status":{
            "type":"string",
            "description":"Order Status",
            "enum":[
                "STOPPED",
                "RUNNING",
                "INTERRUPTED"
            ]
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobParameter"
            }
        }
    }
}

Nested Schema : notification

Type: object

Show Source

receiverID(optional): string
receiverType(optional): string

{
    "type":"object",
    "properties":{
        "receiverID":{
            "type":"string"
        },
        "receiverType":{
            "type":"string"
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

Array of: object JobParameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobParameter"
    }
}

Nested Schema : JobParameter

Type: object

Show Source

dataType(optional): string

Allowed Values: [ "String", "Number", "Boolean", "ITResource" ]
helpText(optional): string
required(optional): boolean
value: string

{
    "required":[
        "value"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "helpText":{
            "type":"string"
        },
        "dataType":{
            "type":"string",
            "enum":[
                "String",
                "Number",
                "Boolean",
                "ITResource"
            ]
        },
        "required":{
            "type":"boolean"
        }
    }
}

400 Response

Invalid input

Examples

The following example shows how to retrieve the details of a job such as a parameter, failed notification, and other details by submitting the GET request using cURL. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl -i -X GET -u username:password /
--header 'Accept: application/json' /
--header 'Content-Type: application/json' /
'http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs/Catalog Synchronization Job'

Example of Response Body

The following example shows the JSON response for a retrieval request for the details of a job:

{
    "jobName": "Catalog Synchronization Job",
    "taskName": "Catalog Synchronization Task",
    "jobScheduleType": "Cron",
    "cronScheduleType": "MONTHLYWEEKDAYS",
    "retryCount": 5,
    "concurrent": false,
    "parameters": {
        "Process Entitlements": {
            "value": "true",
            "helpText": "Processing required for Entitlements",
            "required": false,
            "dataType": "Boolean"
        },
        "Mode": {
            "value": "Incremental",
            "helpText": "Possible values are 'Full'/'Incremental'/'Metadata'/'Recalculate Tags'/'Technical Glossary'",
            "required": true,
            "dataType": "String"
        },
        "Update Date": {
            "value": "",
            "helpText": "Update Date",
            "required": false,
            "dataType": "String"
        },
        "Process Roles": {
            "value": "false",
            "helpText": "Processing required for Roles",
            "required": false,
            "dataType": "Boolean"
        },
        "Process Application Instances": {
            "value": "true",
            "helpText": "Processing required for Application Instances",
            "required": false,
            "dataType": "Boolean"
        },
        "File Path": {
            "value": "",
            "helpText": "Path of CSV file for seeding Metadata Or Directory path Containing XML for Seeding Technical Glossary",
            "required": false,
            "dataType": "String"
        },
        "Updated Date": {
            "value": "08/23/2022 09:58:51",
            "helpText": "Date after which records will be synchronized with catalog('MM/dd/yyyy HH:mm:ss')",
            "required": false,
            "dataType": "String"
        }
    },
    "status": "STOPPED",
    "enabled": true
}