OIGでのスケジューラのためのREST API

ジョブの検索

get

/iam/governance/selfservice/api/v1/scheduler/jobs

指定した検索基準に一致するジョブの詳細を取得します。

リクエスト

問合せパラメータ

limit: integer

返されるアイテムの数
offset: string

結果セットの収集開始前にスキップするアイテムの数
orderBy: string

ソート・フィールドとソート順序の書式は「field:order」です。「field」の使用可能な値は、*jobName*、*taskName*および*status*です。「order」の使用可能な値は*desc*および*asc*です。
q: string

「field eq search_text」の書式で問合せを検索します。「field」には*Job::Name*、*Task::Name*、*Status*を指定できます。「search_text」ではワイルドカード文字*がサポートされます。空白文字は二重コロン(::)に置き換える必要があります

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: JobSearchResult

型: object

ソースを表示

count: integer(int32)
hasMore: boolean
jobs: array jobs
limit: integer(int32)
totalResult: integer(int32)

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "totalResult":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "jobs":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "taskName":{
                        "type":"string"
                    },
                    "enabled":{
                        "type":"boolean"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "STOPPED",
                            "RUNNING",
                            "INTERRUPTED",
                            "FAILED"
                        ]
                    },
                    "haveHistory":{
                        "type":"boolean"
                    },
                    "nextScheduleTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                }
            }
        }
    }
}

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

型: array

ソースを表示

配列: オブジェクト items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "taskName":{
                "type":"string"
            },
            "enabled":{
                "type":"boolean"
            },
            "status":{
                "type":"string",
                "enum":[
                    "STOPPED",
                    "RUNNING",
                    "INTERRUPTED",
                    "FAILED"
                ]
            },
            "haveHistory":{
                "type":"boolean"
            },
            "nextScheduleTime":{
                "type":"string",
                "format":"date-time",
                "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
            }
        }
    }
}

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

型: object

ソースを表示

enabled: boolean
haveHistory: boolean
name: string
nextScheduleTime: string(date-time)

書式: yyyy-MM-dd'T'HH:mm:ss'Z'
status: string

指定可能な値: [ "STOPPED", "RUNNING", "INTERRUPTED", "FAILED" ]
taskName: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean"
        },
        "status":{
            "type":"string",
            "enum":[
                "STOPPED",
                "RUNNING",
                "INTERRUPTED",
                "FAILED"
            ]
        },
        "haveHistory":{
            "type":"boolean"
        },
        "nextScheduleTime":{
            "type":"string",
            "format":"date-time",
            "description":"Format: yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
    }
}

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?orderBy=jobName:desc&q=Job::Status eq 5 and Job::Status eq 2 and Job::Name eq A*'

レスポンス本文の例

次の例は、指定した検索基準に一致するジョブの詳細の取得リクエストに対するJSONレスポンスを示しています:

{
    "links": [
        {
            "rel": "self",
            "href": "pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs"
        },
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs?orderBy=jobName%3Adesc&offset=1&limit=10&q=Job%3A%3AStatus%20eq%205%20and%20Job%3A%3AStatus%20eq%202%20and%20Job%3A%3AName%20eq%20A%2A"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs?orderBy=jobName%3Adesc&offset=1&limit=10&q=Job%3A%3AStatus%20eq%205%20and%20Job%3A%3AStatus%20eq%202%20and%20Job%3A%3AName%20eq%20A%2A"
        }
    ],
    "count": 5,
    "hasMore": false,
    "totalResult": 6,
    "jobs": [
        {
            "name": "Automated Retry of Failed Async Task",
            "taskName": "Retry Failed Async Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": true,
            "nextScheduleTime": "2022-08-23T16:58:51Z"
        },
        {
            "name": "Attestation Grace Period Expiry Checker",
            "taskName": "Attestation Grace Period Expiry Checker",
            "status": "STOPPED",
            "enabled": false,
            "haveHistory": false,
            "nextScheduleTime": "2022-08-23T16:58:51Z"
        },
        {
            "name": "Application Template Generation Job",
            "taskName": "Application Template Generation Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": false
        },
        {
            "name": "Application Instance Post Delete Processing Job",
            "taskName": "Application Instance Post Delete Processing Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": false
        },
        {
            "name": "Application Bulk Create Job",
            "taskName": "Application Bulk Create",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": false
        }
    ],
    "offset": 1,
    "limit": 10
}{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs"
        },
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs?orderBy=jobName%3Adesc&offset=1&limit=10&q=Job%3A%3AStatus%20eq%205%20and%20Job%3A%3AStatus%20eq%202%20and%20Job%3A%3AName%20eq%20A%2A"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/scheduler/jobs?orderBy=jobName%3Adesc&offset=1&limit=10&q=Job%3A%3AStatus%20eq%205%20and%20Job%3A%3AStatus%20eq%202%20and%20Job%3A%3AName%20eq%20A%2A"
        }
    ],
    "count": 5,
    "hasMore": false,
    "totalResult": 6,
    "jobs": [
        {
            "name": "Automated Retry of Failed Async Task",
            "taskName": "Retry Failed Async Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": true,
            "nextScheduleTime": "2022-07-28T05:36:51Z"
        },
        {
            "name": "Attestation Grace Period Expiry Checker",
            "taskName": "Attestation Grace Period Expiry Checker",
            "status": "STOPPED",
            "enabled": false,
            "haveHistory": false,
            "nextScheduleTime": "2022-07-28T05:36:51Z"
        },
        {
            "name": "Application Template Generation Job",
            "taskName": "Application Template Generation Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": false
        },
        {
            "name": "Application Instance Post Delete Processing Job",
            "taskName": "Application Instance Post Delete Processing Task",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": false
        },
        {
            "name": "Application Bulk Create Job",
            "taskName": "Application Bulk Create",
            "status": "STOPPED",
            "enabled": true,
            "haveHistory": true,
            "nextScheduleTime": "2022-07-28T06:02:00Z"
        }
    ],
    "offset": 1,
    "limit": 10
}

先頭に戻る