継続的インテグレーションと継続的デリバリー (CICD) 更新セット API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：34分

    • CICD 更新セット API は、更新セットを作成、取得、プレビュー、コミット、および取り消しするためのメソッドを提供します。

    この API は、 システムアップデートセット で実行できるアクションに関連付けられており、アクセスするには sn_cicd.sys_ci_automation ロールと 継続的インテグレーションと継続的デリバリー (CICD) REST API (com.glide.continuousdelivery) プラグインが必要です。

    CICD 更新セット - POST /api/sn_cicd/update_set/retrieve

    指定されたsys_idで更新セットを取得し、既存の取得済み更新セットをインスタンスから削除できるようにします。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/retrieve

    デフォルト URL: /api/sn_cicd/update_set/retrieve

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    update_set_id 必須。更新セットの取得元のソースインスタンス上の更新セットのSys_id。

    テーブル:更新セット [sys_update_set]

    データタイプ：文字列
    update_source_id リモートインスタンスレコードのSys_id。

    テーブル:リモートインスタンス [sys_update_set_source]

    データタイプ：文字列
    update_source_instance_id リモートインスタンスのインスタンス ID。

    テーブル:リモートインスタンス [sys_update_set_source]

    データタイプ：文字列
    auto_preview 取得後に更新セットを自動的にプレビューするかどうかを示すフラグ。
    有効な値：
    • true:取得時に更新セットをプレビューします。
    • false:取得時に更新セットをプレビューしません。

    データタイプ：ブーリアン

    デフォルト値：false
    cleanup_retrieved 既存の取得済み更新セットをインスタンスから削除するかどうかを示すフラグ。
    有効な値：
    • true:更新セットを削除します。
    • false:更新セットを削除しない

    データタイプ：ブーリアン

    デフォルト値：false
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 5. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    リンク 更新セットに関連付けられたリンクとsys_idsに関する情報です。

    データタイプ: オブジェクト

    "links": {
  "progress": {Object}
}
    links.progress 更新セットで実行された操作に関する進捗状況情報。

    データタイプ: オブジェクト

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id 操作の進捗状況の詳細を含むSys_id。この値は、エンドポイント CI/CD - GET /sn_cicd/progress/{progress_id}を呼び出すときに使用できます。

    データタイプ：文字列
    links.progress.url 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。

    データタイプ：文字列
    percent_complete 完了した要求の割合。

    データタイプ：数値
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列

    cURL 要求

    次の例では、指定されたsys_idとインスタンス ID を持つ特定の更新セットを取得します。

    curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/retrieve?update_set_id=2ce715950d619e10f87785462179bd67&update_source_id=e66613a49d011210f877036c70ae59f7" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。更新セットの現在のステータスと実行の進捗状況に関する詳細を表示します。

    {
  "result": {
    "links": {
      "progress": {
        "id": "e2ea3eedc92dde10f877184664aecd90",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/e2ea3eedc92dde10f877184664aecd90"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CICD 更新セット - POST /api/sn_cicd/update_set/commitMultiple

    指定された順序に従って、単一の要求で複数の更新セットを収容します。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/commitMultiple

    デフォルト URL: /api/sn_cicd/update_set/commitMultiple

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 6. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 7. クエリパラメーター
    名前 説明
    remote_update_set_ids 必須。コミットする更新セットに関連付けられたsys_idsのリスト。Sys_idsは、要求で指定された順序でコミットされます。
    注:
    CI/CD - GET /sn_cicd/progress/{progress_id}エンドポイントを使用して、リモート更新セット ID を取得できます。

    データタイプ：文字列

    テーブル:取得済み更新セット [sys_remote_update_set]
    表 : 8. 要求本文パラメーター (XML または JSON)
    名前 説明
    force_commit 更新セットを強制的にコミットするかどうかを示すフラグ。この機能は、入力で指定された一部のリモート更新セットが以前の操作で既に収容されている場合に便利です。また、この機能により、更新セットが提供された順序でコミット順序が守られるようになります。
    有効な値：
    • true:更新セットを強制的にコミットします。
    • false:更新セットを強制的にコミットしません。コミットが強制されない場合、コミット順序に従わないとコミットは失敗します。

    データタイプ：文字列

    デフォルト値：false

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 9. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 10. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    表 : 11. ステータスコード
    名前 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 ユーザー資格情報が正しくありません。
    403 禁止されました。ユーザーがアドミンでないか、sn_cicd.sys_ci_automation ロールを持っていない。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    409 競合。要求アイテムが一意ではない。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    リンク 更新セットに関連付けられたリンクとsys_idsに関する情報です。

    データタイプ: オブジェクト

    "links": {
  "progress": {Object}
}
    links.progress 更新セットで実行された操作に関する進捗状況情報。

    データタイプ: オブジェクト

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id 操作の進捗状況の詳細を含むSys_id。この値は、エンドポイント CI/CD - GET /sn_cicd/progress/{progress_id}を呼び出すときに使用できます。

    データタイプ：文字列
    links.progress.url 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。

    データタイプ：文字列
    percent_complete 完了した要求の割合。

    データタイプ：数値
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列

    cURL 要求

    次の例は、特定のsys_idで更新をコミットする方法を示しています。

    curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commitMultiple?remote_update_set_ids=0a9f45ab9d415e10f877036c70ae5968%2Cc2e89999c9e19e10f877184664aecd40" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"force_commit\":\"true\"}" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "links": {
      "progress": {
        "id": "3d174aa1c969de10f877184664aecdc0",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/3d174aa1c969de10f877184664aecdc0"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CICD 更新セット - POST /api/sn_cicd/update_set/preview/{remote_update_set_id}

    更新セットをプレビューして競合をチェックし、更新セットの操作に関する進捗状況を取得します。

    注:
    プレビューする更新セットがインスタンスに存在しない場合は、最初に CICD 更新セット - POST /api/sn_cicd/update_set/retrieve エンドポイントを使用して更新セットを取得するか、UI で手動で取得する必要があります。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/preview/{remote_update_set_id}

    デフォルト URL: /api/sn_cicd/update_set/preview/{remote_update_set_id}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 12. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    remote_update_set_id プレビューする更新セットのSys_id。

    テーブル:取得済み更新セット [sys_remote_update_set]

    データタイプ：文字列
    表 : 13. クエリパラメーター
    名前 説明
    なし
    表 : 14. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 15. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 16. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 17. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー資格情報が間違っているか、渡されていません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    リンク 更新セットに関連付けられたリンクとsys_idsに関する情報です。

    データタイプ: オブジェクト

    "links": {
  "progress": {Object}
}
    links.progress 更新セットで実行された操作に関する進捗状況情報。

    データタイプ: オブジェクト

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id 操作の進捗状況の詳細を含むSys_id。この値は、エンドポイント CI/CD - GET /sn_cicd/progress/{progress_id}を呼び出すときに使用できます。

    データタイプ：文字列
    links.progress.url 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。

    データタイプ：文字列
    percent_complete 完了した要求の割合。

    データタイプ：数値
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列

    cURL 要求

    次の例は、指定された ID を使用してリモート更新セットをプレビューする方法を示しています。

    curl 
curl "https://instance.servicenow.com/api/sn_cicd/update_set/preview/8f4608d39d89da10f877036c70ae5998" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "links": {
      "progress": {
        "id": "54e9c665c969de10f877184664aecd72",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/54e9c665c969de10f877184664aecd72"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CICD 更新セット - POST /api/sn_cicd/update_set/back_out

    指定されたsys_idで更新セットに対して実行されたインストール操作を取り消します。

    切り戻し操作が更新セットにどのように影響するかについて詳しくは、 Back out an update setを参照してください。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/back_out

    デフォルト URL: /api/sn_cicd/update_set/back_out

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 18. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 19. クエリパラメーター
    名前 説明
    rollback_installs 更新セットのコミット中に実行されたバッチインストールをロールバックするかどうかを示すフラグ。
    可能な値：
    • true:インストールをロールバックします。
    • false:インストールをロールバックしません。

    データタイプ：ブーリアン

    デフォルト：true
    update_set_id 必須。更新セットのSys_id。

    テーブル:更新セット [sys_update_set]

    データタイプ：文字列
    表 : 20. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 21. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 22. 応答ヘッダー
    ヘッダー 説明
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 23. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 ユーザー資格情報が正しくありません。
    403 禁止されました。ユーザーがアドミンでないか、sn_cicd.sys_ci_automation ロールを持っていない。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    405 メソッドが無効です。この機能は非アクティブです。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    リンク 更新セットに関連付けられたリンクとsys_idsに関する情報です。

    データタイプ: オブジェクト

    "links": {
  "progress": {Object}
}
    links.progress 更新セットで実行された操作に関する進捗状況情報。

    データタイプ: オブジェクト

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id 操作の進捗状況の詳細を含むSys_id。この値は、エンドポイント CI/CD - GET /sn_cicd/progress/{progress_id}を呼び出すときに使用できます。

    データタイプ：文字列
    links.progress.url 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。

    データタイプ：文字列
    percent_complete 完了した要求の割合。

    データタイプ：数値
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列

    cURL 要求

    次の例は、特定の更新プログラムsys_idのインストール操作をロールバックする方法を示しています。

    curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/back_out?update_set_id=73dd24e39dcd1e10f877036c70ae59ae&rollback_installs=false" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    応答：

    {
  "result": {
    "links": {
      "progress": {
        "id": "036bf811c9619e10f877184664aecdcb",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/036bf811c9619e10f877184664aecdcb"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CICD 更新セット - POST /api/sn_cicd/update_set/commit/{remote_update_set_id}

    指定されたsys_idで更新セットを収容します。

    更新セットをプレビューして問題を解決したら、このエンドポイントを使用して更新セットを収容できます。更新セットをコミットすると、すべての変更がインスタンスに適用され、各変更の更新レコードを含んだ更新セットのローカルコピーが作成されます。更新セットの収容の詳細については、「 Commit an update set」を参照してください。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/commit/{remote_update_set_id}

    デフォルト URL: /api/sn_cicd/update_set/ commit/{remote_update_set_id}

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 24. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    remote_update_set_id コミットする更新セットのSys_id。
    注:
    CI/CD - GET /sn_cicd/progress/{progress_id}エンドポイントを使用して、リモート更新セット ID を取得できます。

    テーブル:取得済み更新セット [sys_remote_update_set]

    データタイプ：文字列
    表 : 25. クエリパラメーター
    名前 説明
    なし
    表 : 26. 要求本文パラメーター (XML または JSON)
    名前 説明
    force_commit更新セットを強制的にコミットするかどうかを示すフラグ。
    有効な値：
    • true:競合をチェックするために、まだプレビューしていない場合でも更新セットを強制的にコミットします。
    • false:更新セットを強制的にコミットしません。コミットを続行する前に、更新セットをプレビューする必要があります。

    データタイプ：文字列

    デフォルト値：false

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 27. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 28. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 29. ステータスコード
    名前 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 ユーザー資格情報が正しくありません。
    403 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    409 競合。要求アイテムが一意ではない。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    リンク 更新セットに関連付けられたリンクとsys_idsに関する情報です。

    データタイプ: オブジェクト

    "links": {
  "progress": {Object}
}
    links.progress 更新セットで実行された操作に関する進捗状況情報。

    データタイプ: オブジェクト

    "progress": {
  "id": "String",
  "url": "String"
}
    links.progress.id 操作の進捗状況の詳細を含むSys_id。この値は、エンドポイント CI/CD - GET /sn_cicd/progress/{progress_id}を呼び出すときに使用できます。

    データタイプ：文字列
    links.progress.url 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。

    データタイプ：文字列
    percent_complete 完了した要求の割合。

    データタイプ：数値
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列

    cURL 要求

    次の例では、関連するsys_idとともに更新セットを収容します。

    curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/commit/4ee89999c9e19e10f877184664aecd42" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "links": {
      "progress": {
        "id": "bf380a11c9e59e10f877184664aecd0e",
        "url": "https://instance.servicenow.com/api/sn_cicd/progress/bf380a11c9e59e10f877184664aecd0e"
      }
    },
    "status": "0",
    "status_label": "Pending",
    "status_message": "",
    "status_detail": "",
    "error": "",
    "percent_complete": 0
  }
}

    CICD 更新セット - POST /api/sn_cicd/update_set/create

    新しい更新セットを作成し、新しいレコードを更新セット [sys_update_set] テーブルに挿入します。

    URL 形式

    バージョニングされた URL: /api/sn_cicd/{api_version}/update_set/create

    デフォルト URL: /api/sn_cicd/update_set/create

    注:
    利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

    サポートされている要求パラメーター

    表 : 30. パスパラメーター
    名前 説明
    api_version オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 31. クエリパラメーター
    名前 説明
    説明 更新セットの説明。

    データタイプ：文字列

    デフォルト：null
    scope sys_idパラメーターが渡されない場合は必須です。新しい更新セットを作成するアプリケーションのスコープ名。

    テーブル:アプリケーション [sys_scope]

    データタイプ：文字列
    sys_id scopeパラメーターが渡されない場合は必須です。新しい更新セットを作成するアプリケーションのSys_id。

    テーブル:アプリケーション [sys_scope]

    データタイプ：文字列
    update_set_name 必須。更新セットに付ける名前。

    データタイプ：文字列
    表 : 32. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 33. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 34. 応答ヘッダー
    ヘッダー 説明
    Content-Type 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
    201更新セットが正常に作成されました。
    400 要求が正しくありません。更新セット名が null または空であるか、入力sys_idとスコープの両方が null または空です。
    403 禁止されました。ユーザーがアドミンでないか、sn_cicd.sys_ci_automation ロールを持っていない。
    409 競合。要求アイテムが一意ではない。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    エラー エラーの詳細を含むエラーメッセージ。

    データタイプ：文字列
    ステータス 更新セットで実行されたアクションの実行状態を表す番号。status_label記述子に対応します。
    可能な値：
    • 0：処理待ち
    • 1：実行中
    • 2：成功
    • 3：失敗
    • 4:キャンセル

    データタイプ：文字列
    status_detail 実行状況に関する詳細なメッセージ (利用可能な場合)。実行トラッカー [sys_execution_tracker] テーブルの detailed_message フィールドに対応します。

    データタイプ：文字列
    status_label 更新セットアクションの実行ステータス。status番号に対応します。
    可能な値：
    • キャンセル済み
    • 失敗
    • 保留
    • 実行中
    • 成功

    データタイプ：文字列
    status_message アクションの現在のステータスに関する補足説明 (ある場合)。

    データタイプ：文字列
    update_set_id 作成された更新セットのSys_id。

    テーブル:更新セット [sys_update_set]

    データタイプ：文字列

    cURL 要求

    次の例は、 Testupdateset という名前でスコープを sn_test に設定して新しい更新セットを作成する方法を示しています。

    curl 
"https://instance.servicenow.com/api/sn_cicd/update_set/create?update_set_name=Testupdateset&scope=sn_test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "status": "2",
    "status_label": "",
    "status_message": "Successfully created update set: Test update set 1",
    "status_detail": "",
    "error": "",
    "update_set_id": "a9a485d1c9a19e10f877184664aecd11"
  }
}