---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

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

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：34分

CICD 更新セット API は、更新セットを作成、取得、プレビュー、コミット、および切り戻しするためのメソッドを提供します。
この API は、 [システムアップデートセット](https://www.servicenow.com/docs/bundle/xanadu-application-development/page/build/system-update-sets/concept/system-update-sets.html) で実行できるアクションに関連付けられており、アクセスするには sn_cicd.sys_ci_automation ロールと 継続的インテグレーションと継続的デリバリ (CICD) REST API (com.glide.continuousdelivery) プラグインが必要です。

## CICD 更新セット - POST /api/sn_cicd/update_set/retrieve {#ariaid-title2}

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

### URL 形式

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

デフォルト URL: /api/sn_cicd/update_set/retrieve  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd-update-set-POST-retrieve__entry__2}{#cicd-update-set-POST-retrieve__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 1. パスパラメーター]

{#cicd-update-set-POST-retrieve__entry__6}

| 名前 | 説明 |
|-|-|
| 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:取得時に更新セットをプレビューしません。 {#cicd-update-set-POST-retrieve__ul_flv_lfx_qdc} データタイプ：ブーリアン デフォルト値：false |
| cleanup_retrieved | 既存の取得済み更新セットをインスタンスから削除するかどうかを示すフラグ。 有効な値： * true:更新セットを削除します。 * false:更新セットを削除しない {#cicd-update-set-POST-retrieve__ul_ysn_nfx_qdc} データタイプ：ブーリアン デフォルト値：false |
[表 : 2. クエリパラメーター]

{#cicd-update-set-POST-retrieve__entry__18}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd-update-set-POST-retrieve__table_tq1_qdy_qdc__entry__2}{#cicd-update-set-POST-retrieve__accept-RESTAPI}

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

{#cicd-update-set-POST-retrieve__table_tq1_qdy_qdc}

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#cicd-update-set-POST-retrieve__entry__26}{#cicd-update-set-POST-retrieve__entry-200-status-code}{#cicd-update-set-POST-retrieve__entry-400-status-code}{#cicd-update-set-POST-retrieve__entry-401-status-code}{#cicd-update-set-POST-retrieve__entry-403-status-code}{#cicd-update-set-POST-retrieve__entry-404-status-code}{#cicd-update-set-POST-retrieve__entry-500-status-code}

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

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

{#cicd-update-set-POST-retrieve__table_lxy_pbx_qdc__entry__2}{#cicd-update-set-POST-retrieve__entry-error}{#cicd-update-set-POST-retrieve__entry-link}{#cicd-update-set-POST-retrieve__entry-links_progress}{#cicd-update-set-POST-retrieve__entry-progress_id}{#cicd-update-set-POST-retrieve__entry-progress_url}{#cicd-update-set-POST-retrieve__entry-percent_complete}{#cicd-update-set-POST-retrieve__entry-status}{#cicd-update-set-POST-retrieve__entry-status_detail}{#cicd-update-set-POST-retrieve__entry-status_label}{#cicd-update-set-POST-retrieve__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| リンク | 更新セットに関連付けられているリンクと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}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")を呼び出すときに使用できます。 データタイプ：文字列 |
| links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 |
| percent_complete | 完了した要求の割合。 データタイプ：数値 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 |
| status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 |
| status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 |
| status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 |
[ ]

{#cicd-update-set-POST-retrieve__table_lxy_pbx_qdc}  

### 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 {#ariaid-title3}

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

### URL 形式

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

デフォルト URL: /api/sn_cicd/update_set/commitMultiple  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd-update-set-POST-commitMultiple__entry__2}{#cicd-update-set-POST-commitMultiple__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 6. パスパラメーター]

{#cicd-update-set-POST-commitMultiple__entry__6}

| 名前 | 説明 |
|-|-|
| remote_update_set_ids | 必須です。コミットする更新セットに関連付けられたsys_idsのリスト。Sys_idsは、要求で指定された順序でコミットされます。 注: [CI/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")エンドポイントを使用して、リモート更新セット ID を取得できます。 データタイプ：文字列 テーブル:取得済み更新セット \[sys_remote_update_set\] |
[表 : 7. クエリパラメーター]

{#cicd-update-set-POST-commitMultiple__entry__10}

| 名前 | 説明 |
|-|-|
| force_commit | 更新セットを強制的にコミットするかどうかを示すフラグ。この機能は、入力で指定された一部のリモート更新セットが、以前の操作で既にコミットされている場合に便利です。また、この機能により、更新セットが提供された順序で収容順序が確実に守られるようになります。 有効な値： * true:更新セットを強制的にコミットします。 * false:更新セットを強制的にコミットしません。コミットが強制されない場合、コミット順序に従わないとコミットは失敗します。 {#cicd-update-set-POST-commitMultiple__ul_uvd_hjk_12c} データタイプ：文字列 デフォルト値：false |
[表 : 8. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd-update-set-POST-commitMultiple__entry__14}{#cicd-update-set-POST-commitMultiple__accept-RESTAPI}{#cicd-update-set-POST-commitMultiple__content_type-RESTAPI}

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

{#cicd-update-set-POST-commitMultiple__entry__20}

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

### ステータスコード

{#cicd-update-set-POST-commitMultiple__table_s54_4bx_qdc__entry__2}{#cicd-update-set-POST-commitMultiple__entry-200-status-code}{#cicd-update-set-POST-commitMultiple__entry-400-status-code}{#cicd-update-set-POST-commitMultiple__entry-401-status-code}{#cicd-update-set-POST-commitMultiple__entry-403-status-code}{#cicd-update-set-POST-commitMultiple__entry-404-status-code}{#cicd-update-set-POST-commitMultiple__entry-409-status-code}{#cicd-update-set-POST-commitMultiple__entry-500-status-code}

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

{#cicd-update-set-POST-commitMultiple__table_s54_4bx_qdc}

### 応答本文のパラメーター (JSON または XML) {#cicd-update-set-POST-commitMultiple__section_kxy_pbx_qdc}

{#cicd-update-set-POST-commitMultiple__table_lxy_pbx_qdc__entry__2}{#cicd-update-set-POST-commitMultiple__entry-error}{#cicd-update-set-POST-commitMultiple__entry-link}{#cicd-update-set-POST-commitMultiple__entry-links_progress}{#cicd-update-set-POST-commitMultiple__entry-progress_id}{#cicd-update-set-POST-commitMultiple__entry-progress_url}{#cicd-update-set-POST-commitMultiple__entry-percent_complete}{#cicd-update-set-POST-commitMultiple__entry-status}{#cicd-update-set-POST-commitMultiple__entry-status_detail}{#cicd-update-set-POST-commitMultiple__entry-status_label}{#cicd-update-set-POST-commitMultiple__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| リンク | 更新セットに関連付けられているリンクと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}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")を呼び出すときに使用できます。 データタイプ：文字列 |
| links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 |
| percent_complete | 完了した要求の割合。 データタイプ：数値 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 |
| status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 |
| status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 |
| status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 |
[ ]

{#cicd-update-set-POST-commitMultiple__table_lxy_pbx_qdc}  

### 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} {#ariaid-title4}

更新セットをプレビューして競合をチェックし、更新セット操作に関する進捗情報を取得します。
注:  
プレビューする更新セットがインスタンスに存在しない場合は、最初に [CICD 更新セット - POST /api/sn_cicd/update_set/retrieve](https://servicenow-prod.fluidtopics.net/suzEVEcAZmnF_0JsBWcTJg#cicd-update-set-POST-retrieve "指定されたsys_idで更新セットを取得し、既存の取得済み更新セットをインスタンスから削除できるようにします。") エンドポイントを使用して更新セットを取得するか、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 エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd-update-set-POST-preview__entry__2}{#cicd-update-set-POST-preview__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| remote_update_set_id | プレビューする更新セットのSys_id。 テーブル:取得済み更新セット \[sys_remote_update_set\] データタイプ：文字列 |
[表 : 12. パスパラメーター]

{#cicd-update-set-POST-preview__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 13. クエリパラメーター]

{#cicd-update-set-POST-preview__entry__12}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 14. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd-update-set-POST-preview__table_rbg_n2y_qdc__entry__2}{#cicd-update-set-POST-preview__accept-RESTAPI}{#cicd-update-set-POST-preview__content_type-RESTAPI}

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

{#cicd-update-set-POST-preview__table_rbg_n2y_qdc} {#cicd-update-set-POST-preview__entry__22}

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

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#cicd-update-set-POST-preview__entry__26}{#cicd-update-set-POST-preview__entry-200-status-code}{#cicd-update-set-POST-preview__entry-400-status-code}{#cicd-update-set-POST-preview__entry-401-status-code}{#cicd-update-set-POST-preview__entry-403-status-code}{#cicd-update-set-POST-preview__entry-404-status-code}{#cicd-update-set-POST-preview__entry-500-status-code}

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

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

{#cicd-update-set-POST-preview__table_lxy_pbx_qdc__entry__2}{#cicd-update-set-POST-preview__entry-error}{#cicd-update-set-POST-preview__entry-link}{#cicd-update-set-POST-preview__entry-links_progress}{#cicd-update-set-POST-preview__entry-progress_id}{#cicd-update-set-POST-preview__entry-progress_url}{#cicd-update-set-POST-preview__entry-percent_complete}{#cicd-update-set-POST-preview__entry-status}{#cicd-update-set-POST-preview__entry-status_detail}{#cicd-update-set-POST-preview__entry-status_label}{#cicd-update-set-POST-preview__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| リンク | 更新セットに関連付けられているリンクと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}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")を呼び出すときに使用できます。 データタイプ：文字列 |
| links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 |
| percent_complete | 完了した要求の割合。 データタイプ：数値 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 |
| status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 |
| status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 |
| status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 |
[ ]

{#cicd-update-set-POST-preview__table_lxy_pbx_qdc}  

### 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 {#ariaid-title5}

指定されたsys_idの更新セットで実行されたインストール操作を取り消します。
切り戻し操作が更新セットに与える影響の詳細については、「 [Back out an update set](https://www.servicenow.com/docs/access?context=t_BackOutUpdateSet&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。

### URL 形式

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

デフォルト URL: /api/sn_cicd/update_set/back_out  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd_update_set-POST-back_out__entry__2}{#cicd_update_set-POST-back_out__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 18. パスパラメーター]

{#cicd_update_set-POST-back_out__entry__6}

| 名前 | 説明 |
|-|-|
| rollback_installs | 更新セットのコミット中に実行されたバッチインストールをロールバックするかどうかを示すフラグ。 可能な値： * true:インストールをロールバックします。 * false:インストールをロールバックしません。 {#cicd_update_set-POST-back_out__ul_ypf_zdw_qdc} データタイプ：ブーリアン デフォルト：true |
| update_set_id | 必須です。更新セットのSys_id。 テーブル:更新セット \[sys_update_set\] データタイプ：文字列 |
[表 : 19. クエリパラメーター]

{#cicd_update_set-POST-back_out__entry__12}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 20. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd_update_set-POST-back_out__entry__16}{#cicd_update_set-POST-back_out__accept-RESTAPI}{#cicd_update_set-POST-back_out__content_type-RESTAPI}

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

{#cicd_update_set-POST-back_out__entry__22}{#cicd_update_set-POST-back_out__d3014e173}

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

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#cicd_update_set-POST-back_out__entry__26}{#cicd_update_set-POST-back_out__entry-200-status-code}{#cicd_update_set-POST-back_out__entry-400-status-code}{#cicd_update_set-POST-back_out__entry-401-status-code}{#cicd_update_set-POST-back_out__entry-403-status-code}{#cicd_update_set-POST-back_out__entry-404-status-code}{#cicd_update_set-POST-back_out__entry-405-status-code}{#cicd_update_set-POST-back_out__entry-500-status-code}

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

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

{#cicd_update_set-POST-back_out__entry__42}{#cicd_update_set-POST-back_out__entry-error}{#cicd_update_set-POST-back_out__entry-link}{#cicd_update_set-POST-back_out__entry-links_progress}{#cicd_update_set-POST-back_out__entry-progress_id}{#cicd_update_set-POST-back_out__entry-progress_url}{#cicd_update_set-POST-back_out__entry-percent_complete}{#cicd_update_set-POST-back_out__entry-status}{#cicd_update_set-POST-back_out__entry-status_detail}{#cicd_update_set-POST-back_out__entry-status_label}{#cicd_update_set-POST-back_out__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| リンク | 更新セットに関連付けられているリンクと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}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")を呼び出すときに使用できます。 データタイプ：文字列 |
| links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 |
| percent_complete | 完了した要求の割合。 データタイプ：数値 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。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} {#ariaid-title6}

指定されたsys_idで更新セットをコミットします。
更新セットをプレビューして問題を解決したら、このエンドポイントを使用して更新セットを収容できます。更新セットをコミットすると、すべての変更がインスタンスに適用され、各変更の更新レコードを含んだ更新セットのローカルコピーが作成されます。更新セットの収容の詳細については、「 [Commit an update set](https://www.servicenow.com/docs/access?context=t_CommitAnUpdateSet&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。

### 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 エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd_update_set-POST-commit__entry__2}{#cicd_update_set-POST-commit__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| remote_update_set_id | 収容する更新セットのSys_id。 注: [CI/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")エンドポイントを使用して、リモート更新セット ID を取得できます。 テーブル:取得済み更新セット \[sys_remote_update_set\] データタイプ：文字列 |
[表 : 24. パスパラメーター]

{#cicd_update_set-POST-commit__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 25. クエリパラメーター]

{#cicd_update_set-POST-commit__entry__12}

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

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd_update_set-POST-commit__entry__16}{#cicd_update_set-POST-commit__accept-RESTAPI}{#cicd_update_set-POST-commit__content_type-RESTAPI}

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

{#cicd_update_set-POST-commit__entry__22}

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

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#cicd_update_set-POST-commit__entry__26}{#cicd_update_set-POST-commit__entry-200-status-code}{#cicd_update_set-POST-commit__entry-400-status-code}{#cicd_update_set-POST-commit__entry-401-status-code}{#cicd_update_set-POST-commit__entry-403-status-code}{#cicd_update_set-POST-commit__entry-404-status-code}{#cicd_update_set-POST-commit__entry-409-status-code}{#cicd_update_set-POST-commit__entry-500-status-code}

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

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

{#cicd_update_set-POST-commit__entry__42}{#cicd_update_set-POST-commit__entry-error}{#cicd_update_set-POST-commit__entry-link}{#cicd_update_set-POST-commit__entry-links_progress}{#cicd_update_set-POST-commit__entry-progress_id}{#cicd_update_set-POST-commit__entry-progress_url}{#cicd_update_set-POST-commit__entry-percent_complete}{#cicd_update_set-POST-commit__entry-status}{#cicd_update_set-POST-commit__entry-status_detail}{#cicd_update_set-POST-commit__entry-status_label}{#cicd_update_set-POST-commit__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| リンク | 更新セットに関連付けられているリンクと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}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。")を呼び出すときに使用できます。 データタイプ：文字列 |
| links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 |
| percent_complete | 完了した要求の割合。 データタイプ：数値 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。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 {#ariaid-title7}

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

### URL 形式

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

デフォルト URL: /api/sn_cicd/update_set/create  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

{#cicd_update_set-POST-create__entry__2}{#cicd_update_set-POST-create__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 30. パスパラメーター]

{#cicd_update_set-POST-create__entry__6}

| 名前 | 説明 |
|-|-|
| description | 更新セットの説明。 データタイプ：文字列 デフォルト値:null |
| scope | sys_idパラメーターが渡されない場合は必須です。新しい更新セットを作成するアプリケーションのスコープ名。 テーブル:アプリケーション \[sys_scope\] データタイプ：文字列 |
| sys_id | scopeパラメーターが渡されない場合は必須です。新しい更新セットを作成するアプリケーションのSys_id。 テーブル:アプリケーション \[sys_scope\] データタイプ：文字列 |
| update_set_name | 必須です。更新セットに付ける名前。 データタイプ：文字列 |
[表 : 31. クエリパラメーター]

{#cicd_update_set-POST-create__entry__16}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 32. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#cicd_update_set-POST-create__entry__20}{#cicd_update_set-POST-create__accept-RESTAPI}{#cicd_update_set-POST-create__content_type-RESTAPI}

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

{#cicd_update_set-POST-create__entry__26}

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

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#cicd_update_set-POST-create__table_n5q_tn2_rdc__entry__2}{#cicd_update_set-POST-create__entry-403-status-code}{#cicd_update_set-POST-create__entry-409-status-code}{#cicd_update_set-POST-create__entry-500-status-code}

|   |   |
|-|-|
| 201 | 更新セットが正常に作成されました。 |
| 400 | 要求が正しくありません。更新セット名が null または空であるか、入力sys_idとスコープの両方が null または空です。 |
| 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 |
| 409 | 競合。要求されたアイテムが一意ではありません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 |
[ ]

{#cicd_update_set-POST-create__table_n5q_tn2_rdc}

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

{#cicd_update_set-POST-create__entry__42}{#cicd_update_set-POST-create__entry-error}{#cicd_update_set-POST-create__entry-status}{#cicd_update_set-POST-create__entry-status_detail}{#cicd_update_set-POST-create__entry-status_label}{#cicd_update_set-POST-create__entry-status_message}

| 名前 | 説明 |
|-|-|
| エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 |
| status | 更新セットで実行されたアクションの実行ステータスを表す数値。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"
      }
    }


