ジャンプ先

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

新しいジョブを作成します。

post

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

指定した詳細でスケジューラに新しいジョブを作成します。

リクエスト

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

• application/json

本文()

ルート・スキーマ: JobDetails

型: 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
  指定可能な値: [ "STOPPED", "RUNNING", "INTERRUPTED" ]

  オーダー・ステータス
• 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"
            }
        }
    }
}

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

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• 配列: object JobParameter

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

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

型: object

ソースを表示

• dataType(optional): string
  指定可能な値: [ "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"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: Success

型: object

ソースを表示

• jobName(optional): string
• status(optional): string
  実行されたアクションのステータス

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

400レスポンス

入力が無効です

先頭に戻る

例

次の例は、cURLを使用してPOSTリクエストを発行することにより、指定した詳細でスケジューラに新しいジョブを作成する方法を示しています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

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/'

POSTリクエスト本文の例

JSON形式のリクエスト本文のコンテンツの例を次に示します。

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

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "jobName": "Test Job",
    "status": "Job Create successfull"
}

先頭に戻る