ジャンプ先

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

ジョブを削除します。

POST

/rhp-restapi/rhp/jobs/actions/delete

リクエスト

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

• application/json

ヘッダー・パラメータ

• Authorization(必須): string
  リクエストをしているユーザーのユーザー名とパスワードのBase64エンコーディング。詳細は、「フリート・パッチ適用およびプロビジョニングの認証」を参照してください。

Body ()

ルート・スキーマ: DeleteJobsBody

タイプ: object

ソースの表示

• client: string
  削除するジョブのクライアント名属性
• jobsIds: string
  削除する1つ以上のジョブのカンマ区切りリスト
• status: string
  指定できる値: [ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]

  ジョブ取得の対象となるジョブ・ステータス。
• user: string
  削除するジョブのユーザー名属性

{
    "type":"object",
    "properties":{
        "jobsIds":{
            "type":"string",
            "description":"Comma separated list of one or more jobs to be deleted"
        },
        "status":{
            "type":"string",
            "description":"Job status for which to get the jobs.",
            "enum":[
                "SCHEDULED",
                "UNKNOWN",
                "EXECUTING",
                "PAUSED",
                "ABORTED",
                "TERMINATED",
                "FAILED",
                "SUCCEEDED"
            ]
        },
        "user":{
            "type":"string",
            "description":"User name attribute of the jobs to be deleted"
        },
        "client":{
            "type":"string",
            "description":"Client name attribute of the jobs to be deleted"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json
• text/html

200 レスポンス

OK。削除が成功したことを示すHTTPステータス・コード200。

Body ()

ルート・スキーマ: schema

デフォルト・レスポンス

予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。

Body ()

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

• errorCode: string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails: array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath: string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance: string
  エラーに関する詳細を提供するリンクへのURI。
• status: integer
  HTTPステータス・コード。
• title: string
  要約エラー・メッセージ。
• type: string
  HTTPエラー・コード・ページへのリンク。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

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

タイプ: array

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。

ソースの表示

• 配列: オブジェクト errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

先頭に戻る