ジャンプ先

• リクエスト
• レスポンス
• 例

ジョブ詳細の取得

get

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

パラメータ、失敗通知およびその他の詳細などのジョブの詳細を取得します。

リクエスト

パス・パラメータ

• jobName(required): string
  ジョブの名前。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: JobDetails

型: object

ソースを表示

• concurrent: boolean
• cronScheduleType: string
• isEnabled: boolean
• jobName(required): string
• jobScheduleType: string
• notification: object notification
• parameters: array parameters
• retryCount(required): integer(int32)
• status: string
  指定可能な値: [ "STOPPED", "RUNNING", "INTERRUPTED" ]

  オーダー・ステータス
• taskName(required): 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"
            }
        }
    }
}

ネストされたスキーマ: notification

型: object

ソースを表示

• receiverID: string
• receiverType: string

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

ネストされたスキーマ: parameters

型: array

ソースを表示

• 配列: object JobParameter

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

ネストされたスキーマ: JobParameter

型: object

ソースを表示

• dataType: string
  指定可能な値: [ "String", "Number", "Boolean", "ITResource" ]
• helpText: string
• required: boolean
• value(required): string

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

400レスポンス

入力が無効です

先頭に戻る

例

次の例は、cURLを使用してGETリクエストを発行することにより、パラメータ、失敗通知およびその他の詳細などのジョブの詳細を取得する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

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'

レスポンス本文の例

次の例は、ジョブの詳細の取得リクエストに対するJSONレスポンスを示しています:

{
    "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
}

先頭に戻る