--- 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) 所要時間：137分 CICD API は、パイプラインを構築するための一般的なDevOpsツールとの統合を可能にするエンドポイントを提供します。これらのツールには、 Jenkins、 Azure Pipelines、 GitLab、 GitHub Actions、 Atlassian Bamboo/Pipelines などが含まれます。 これにより、インテグレーターは、ソース駆動型開発で一般的なプル/マージ要求ワークフローによって駆動されるServiceNow AI Platformアプリケーション用のCICDパイプラインをビルドできます。ソースコントロール、アプリケーションリポジトリ、および 自動テストフレームワーク (ATF) 機能を活用します。 CI/CD API は、次の製品領域と機能領域を提供します。 * ソースコントロールスタジオのソースコントロール機能を使用して、特定のインスタンスで、リモート Git リポジトリにリンクされたアプリケーションにリモート変更を適用します。 指定されたリポジトリ URL と分岐名を使用してアプリケーションをインポートします。 * アプリケーションリポジトリ:スコープ対象のアプリケーション、グローバルアプリケーション、 ServiceNow Store 上のスコープ対象アプリケーションのアプリケーションのカスタマイズ、およびプラグインを介して使用できます。 * インスタンスから接続されたアプリケーションリポジトリにアプリケーションを公開します。 * 接続されたアプリケーションリポジトリからインスタンスにアプリケーションをインストールします。 * ロールバックコンテキストを通じてインストールされたアプリケーションをロールバックします。 * バッチ * 複数のアプリケーションをまとめてバッチインストールする JSON マニフェストファイルを定義します。 * ロールバックコンテキストを使用してバッチインストール全体をロールバックします。 * 指定された結果識別子に基づいてバッチインストールの結果を返します。 * プラグイン * プラグインをアクティブ化します。 * ロールバックコンテキストを使用してプラグインをロールバックします。 * 自動テストフレームワーク (ATF) (ATF) * ATF テストスイートを開始します。 * ATF テストスイートの合格/不合格の結果を取得します。 * インスタンススキャン * インスタンススキャンを開始します (フル、テーブルのポイントスキャン、レコードのポイントスキャン、スコープ対象のアプリケーション、更新セット、これらのアイテムの組み合わせ)。 * インスタンススキャン実行の合格/不合格の結果を取得します。 * 進行状況他のエンドポイント呼び出しによって開始されたプロセスのインスタンスの完了率を取得します。この機能を使用して、次のステップに進む前に、進行状況が完了するまでポーリングできます。 {#cicd-api__ul_rr4_fnq_spb} この API は非同期応答モデルを使用します。テストスイート /sn_cicd/testsuite/run を実行するなど、エンドポイントを呼び出すと、テストスイートの実行開始など、関連する機能がエンドポイントによって開始されます。次に、エンドポイントは、要求された関数の実行ステータス (通常は `処理待ち`) と、一意の識別子とリンクを含む応答メッセージを返します。この情報を使用して、要求の進捗状況、ソース、結果、または検出結果に関する追加情報を取得します。機能要求に応じて、次のいずれかの方法を使用して要求に関する追加情報を取得できます。 * 開始エンドポイントによって返された links.progress.id パラメーターを使用して、/sn_cicd/progress/{progress_id} エンドポイントを呼び出します。 * 開始エンドポイントによって返された links.result.id パラメーターを使用して、/sn_cicd/testsuite/results/{result_id} エンドポイントを呼び出します。 * 開始エンドポイントによって返された links.progress.id パラメーターを使用して、/sn_cicd/instance_scan/result/{progress_id} エンドポイントを呼び出します。 * / sn_cicd/sc/apply_stash/{stash_id } エンドポイントによって返された links.stash.id パラメーターを使用して、/sn_cicd/sc/{progress_id} エンドポイントを呼び出します。 * 開始エンドポイントによって返された links.\.url パラメーターへのリンクアウト。 注: リポジトリからアプリケーションをインストールするには、まず /sn_cicd/app_repo/publish エンドポイントを使用してアプリケーションをリポジトリに公開する必要があります。公開されると、そのリポジトリに接続されているすべてのインスタンスがアプリケーションをインストールしてロールバックできるようになります。アプリケーションが最初に公開されていない場合、インストール要求は失敗します。 この API を使用するには、sn_cicd.sys_ci_automation または admin ロールが必要です。 Tokyo 以降、要求された操作を実行するためにインスタンス全体のロック/ミューテックスを取得する必要がある CICD API エンドポイントは、インスタンス全体のロック/ミューテックスが占有されている間は要求を拒否するのではなく、キューを使用します。複数の CICD パイプラインは、却下を検出して再試行することなく同時に要求を行うため、代わりに、以前は成功した要求の場合と同じように進捗状況を簡単に監視できます。この動作はデフォルトでオンになっています。 現在のキューは、admin ロールを持つユーザーが、\[ システム診断 -\>アプリケーション操作キュー\] に移動して検査できます。ここから、管理者はキューを一時停止および再開して、 インスタンス全体のロック/ミューテックスを必要とする可能性のある他の手動操作を許可できます。 注: 一時停止すると、進行中の操作は完了するまで実行されますが、新しい操作は開始されません。API は引き続き新しい要求を受け入れ、キューに入れます。リストされた実行トラッカーをキャンセル済みステータスに更新することで、処理待ちの操作を実行開始前にキャンセルすることもできます。何らかの理由で com.glide.update_operation.job_cancel_timeout_minutes で指定されたタイムアウト (デフォルトは 48 時間) を過ぎても操作を続行できない場合、操作はキャンセルされます。 アップグレードがスケジュールされている場合、プロパティ com.glide.update_operation.queue_upgrade_window によって上書きされない限り、キューはアップグレードの 2 時間前にアップグレード一時停止状態になります。これにより、アップグレードを開始する前に進行中の操作を完了できます。 注: アップグレードが完了すると、キューは自動的に再開されます。 CICDに関する追加情報については、以下を参照してください。 * [継続的インテグレーションと継続的デリバリ (CICD) スポーク](https://www.servicenow.com/docs/access?context=cicd-spoke&version=australia&pubname=australia-integrate-applications&ft:locale=en-US) * * * [https://github.com/marketplace?type=actions\&query=servicenow](https://github.com/marketplace?type=actions&query=servicenow) * ## CI/CD:GET /sn_cicd/app/batch/results/{result_id} {#ariaid-title2} 指定された結果識別子に基づいてバッチインストールの結果を返します。 /sn_cicd/app/batch/install エンドポイントを呼び出した後にこのメソッドを呼び出して、バッチインストールの結果を取得します。/sn_cicd/app/batch/install エンドポイントのリターン結果の links.results.id パラメーターで返された値を、このエンドポイントのresult_idとして使用します。インストールがまだ完了していない場合は、 /api/sn_cicd/progress/{progress_id} エンドポイントを呼び出して、インストールの進捗状況に関する情報を取得することもできます。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/app/batch/results/{result_id} デフォルト URL: /api/sn_cicd/app/batch/results/{result_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-GET-app-batch-results__entry__2}{#cicd-GET-app-batch-results__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | result_id | 結果情報を返すバッチインストールのSys_id。この値は、/sn_cicd/app/batch/install エンドポイントの links.results.id パラメーターで返されます。 データタイプ：文字列 | [表 : 1. パスパラメーター] {#cicd-GET-app-batch-results__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#cicd-GET-app-batch-results__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-GET-app-batch-results__entry__16}{#cicd-GET-app-batch-results__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 4. 要求ヘッダー] {#cicd-GET-app-batch-results__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-GET-app-batch-results__entry__24}{#cicd-GET-app-batch-results__entry-200-status-code}{#cicd-GET-app-batch-results__row-401-status-code}{#cicd-GET-app-batch-results__row-403-status-code}{#cicd-GET-app-batch-results__row-404-status-code}{#cicd-GET-app-batch-results__row-405-status-code}{#cicd-GET-app-batch-results__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-GET-app-batch-results__entry__38}{#cicd-GET-app-batch-results__row-error} | 名前 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | batch_items | JSON アレイ。各オブジェクトはパッケージインストールの詳細を提供します。 データタイプ：アレイ "batch_items" [{ "customization_version": "String", "id": "String", "install_date": "String", "name": "String", "notes": "String", "state": "String", "status_message": "String", "type": "String", "url": "String", "version": "String" }] | | batch_items.customization_version | batch_items.typeパラメーターがアプリケーションまたはプラグインに設定され、バッチインストール要求でrequested_customization_versionパラメーターが渡された場合にのみ適用されます。インストールするストアアプリケーションまたはスコープ対象 ServiceNow プラグインカスタマイズパッケージのバージョン (1.0.2 や 2.3 など)。 データタイプ：文字列 | | batch_items.id | インストールするアプリケーションのSys_idまたはプラグインの識別子。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの packages.id パラメーターと同じです。 データタイプ：文字列 | | batch_items.install_date | パッケージがインストールされた日時。要求がまだ処理中の場合は空です。 データタイプ：文字列 | | batch_items.name | パッケージの名前。 データタイプ：文字列 | | batch_items.notes | パッケージに関するユーザー指定のメモ。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの packages.notes パラメーターと同じです。 データタイプ：文字列 | | batch_items.state | 関連付けられたパッケージインストールの現在のステータス。 可能な値： * 失敗 * 進行中 * インストール済み * 無効 * 準備完了 * ロールバック済み データタイプ：文字列 | | batch_items.status_message | パッケージやカスタマイズのインストール中に発生したエラーについて説明します。 データタイプ：文字列 | | batch_items.type | アプリケーションのタイプ。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの packages.type パラメーターと同じです。 有効な値： * アプリケーション * プラグイン {#cicd-GET-app-batch-results__ul_pfk_sbq_2nb} データタイプ：文字列 | | batch_items.url | ServiceNow インスタンスに関連付けられたパッケージインストールレコードの URL。 データタイプ：文字列 | | batch_items.version | インストールするパッケージのバージョン (1.0.2 や 2.3 など)。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの packages.requested_version パラメーターと同じです。 データタイプ：文字列 | | batch_plan | インストールバッチ計画について説明します。 データタイプ: オブジェクト "batch_plan": { "id": "String", "name": "String", "notes": "String", "state": "String", "url": "String" } | | batch_plan.id | 返される結果情報のSys_id。result_id要求パラメーターで渡された値と同じ値。 データタイプ：文字列 | | batch_plan.name | このバッチ要求のユーザー指定のわかりやすい名前。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの name パラメーターと同じです。 データタイプ：文字列 | | batch_plan.notes | バッチインストールが呼び出されたときに渡されたメモ。開始する /sn_cicd/app/batch/install エンドポイント呼び出しの notes パラメーターと同じです。 データタイプ：文字列 | | batch_plan.state | バッチインストール全体の現在のステータス。 可能な値： * 失敗 * 進行中 * インストール済み * 無効 * 部分インストール * 準備完了 * ロールバック済み {#cicd-GET-app-batch-results__ul_dyj_sfy_2nb} データタイプ：文字列 | | batch_plan.url | ServiceNowインスタンスのバッチインストール計画レコードの URL。 データタイプ：文字列 | [ ] ### cURL 要求 {#cicd-GET-app-batch-results__example_eyp_wdq_2nb} この例では、リリース 2.0 IT 運用と呼ばれるバッチインストール計画のステータスを確認します。 curl 'instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561 \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "batch_plan": { "name":"Release 2.0 IT Operations", "id": "df24b1e9db2d0110b5e3f6c5ae97c561", "url": "https://instance.service-now.com/sys_batch_install_plan.do?sys_id=df24b1e9db2d0110b5e3f6c5ae97c561", "state": "Installed", "notes": "User specified notes for batch install plan", } "batch_items": [ { "name": "com.sn_cicd_spoke", "type": "Application", "version": "7.0.0", "state": "Installed", "install_date": "2020-08-31 15:30:01", "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url":"https://instance.service-now.com/sys_batch_install_item.do?sys_id=c159b1e9db1c0010b5e3f6c5ae961903", "notes" : "" }, { "name": "Customization for CSM App1", "type": "Application", "version": "1.0.0", "state": "Installed", "install_date": "2020-08-31 15:32:01", "id": "e824b1e9db2d1001b5e3f6c5ae97d628", "url": "https://instance.service-now.com/sys_batch_install_item.do?sys_id=e824b1e9db2d1001b5e3f6c5ae97d628", "notes": "Customized headers.", "customization_version": "2.1.1", "status_message": "" }] } } ## CI/CD - GET /sn_cicd/instance_scan/result/{progress_id} {#ariaid-title3} 渡された進行状況 ID に関連付けられた CI/CD インスタンススキャン機能の現在の進行状況とステータスを返します。/sn_cicd/instance_scan/full_scan や /sn_cicd/instance_scan/point_scan などの他のインスタンススキャン CI/CD エンドポイントのいずれかを呼び出した後に、このメソッドを呼び出します。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/result/{progress_id} デフォルト URL: /api/sn_cicd/instance_scan/result/{progress_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-GET-instancescan-result__entry__2}{#cicd-GET-instancescan-result__version-not_optional-RESTAPI} | パラメーター | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | progress_id | 進捗状況情報を返す関数の一意の識別子。この値は、アクションを開始したエンドポイントの links.progress.id パラメーター ( /sn_cicd/instance_scan/full_scan や /sn_cicd/instance_scan/point_scan など) で返されます。 データタイプ：文字列 | [表 : 7. パラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-GET-instancescan-result__entry__8}{#cicd-GET-instancescan-result__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 8. 要求ヘッダー] {#cicd-GET-instancescan-result__entry__12} | ヘッダー | 説明 | |-|-| | なし | | [表 : 9. 応答ヘッダー] ### ステータスコード 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-GET-instancescan-result__table_wwn_rhd_ct__entry__2}{#cicd-GET-instancescan-result__entry-200-status-code}{#cicd-GET-instancescan-result__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 10. ステータスコード] {#cicd-GET-instancescan-result__table_wwn_rhd_ct} ### 要求本文 API は、要求本文でこれらの JSON または XML 要素を受け入れます。 {#cicd-GET-instancescan-result__table_rm1_yjd_kv__entry__2} | 要素 | 説明 | |-|-| | なし | | [表 : 11. 要求本文で承認された要素] {#cicd-GET-instancescan-result__table_rm1_yjd_kv} ### 応答本文 API は、応答本文でこれらの JSON または XML 要素を返します。 {#cicd-GET-instancescan-result__table_mc1_pr1_tx__entry__2}{#cicd-GET-instancescan-result__entry-error}{#cicd-GET-instancescan-result__entry-link}{#cicd-GET-instancescan-result__entry-links_progress}{#cicd-GET-instancescan-result__entry-progress_url}{#cicd-GET-instancescan-result__entry-links_results}{#cicd-GET-instancescan-result__entry-links_results_id}{#cicd-GET-instancescan-result__entry-links_results_url}{#cicd-GET-instancescan-result__entry-status}{#cicd-GET-instancescan-result__entry-status_detail}{#cicd-GET-instancescan-result__entry-status_label}{#cicd-GET-instancescan-result__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.findings | インスタンススキャン検出結果に関する情報を含むオブジェクト。 | | links.findings.label | インスタンススキャン検出結果に関する追加情報。 | | links.findings.url | チェックに違反したレコードのリストを取得するために使用する URL。 | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | links.results | 実行結果の ID と URL。 データタイプ: オブジェクト "results": { "id": "String", "url": "String" } | | links.results.id | インスタンススキャン結果レコードのSys_id。 | | links.results.url | インスタンススキャンの結果を取得するために使用する URL。 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [表 : 12. 応答本文で返される要素] {#cicd-GET-instancescan-result__table_mc1_pr1_tx} ### cURL 要求のサンプル curl 'instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "findings": { "url": "https://instance.service-now.com/api/now/table/scan_finding?sysparm_query%3Dresult%3D6f4cf8651b7800103d374087bc4bcb41%5EORDERBYsys_id", "label": "First 10,000 findings" }, "progress": { "id": "a74c70a11b7800103d374087bc4bcb28", "url": "https://instance.service-now.com/api/sn_cicd/progress/a74c70a11b7800103d374087bc4bcb28" }, "results": { "id": "a74c70a11b7800103d374087bc4bcb28", "url": "https://instance.service-now.com/api/sn_cicd/instance_scan/result/a74c70a11b7800103d374087bc4bcb28" } }, "status": "2", "status_label": "Successful", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - GET /sn_cicd/progress/{progress_id} {#ariaid-title4} 指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。 /sn_cicd/app_repo/publish、/sn_cicd/app_repo/install、/sn_cicd/testsuite/run、/sn_cicd/sc/apply_stash などの非同期 CICD エンドポイントのいずれかを呼び出した後に、このメソッドを呼び出します。 ### URL 形式 {#cicd-GET-progress__section_jcv_cwv_ylb} バージョニングされた URL: /api/sn_cicd/{api_version}/progress/{progress_id} デフォルト URL: /api/sn_cicd/progress/{progress_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-GET-progress__entry__2}{#cicd-GET-progress__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | progress_id | 進捗状況情報を返す関数の一意の識別子。 この値は、アクションを開始したエンドポイントの links.progress.id パラメーター ( /sn_cicd/app_repo/publish、 /sn_cicd/app_repo/install、 /sn_cicd/testsuite/run、 /sn_cicd/sc/apply_stash など) で返されます。 データタイプ：文字列 | [表 : 13. パスパラメーター] {#cicd-GET-progress__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#cicd-GET-progress__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-GET-progress__entry__16}{#cicd-GET-progress__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 16. 要求ヘッダー] {#cicd-GET-progress__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-GET-progress__entry__24}{#cicd-GET-progress__entry-200-status-code}{#cicd-GET-progress__row-401-status-code}{#cicd-GET-progress__row-403-status-code}{#cicd-GET-progress__row-404-status-code}{#cicd-GET-progress__row-405-status-code}{#cicd-GET-progress__row-409-status-code}{#cicd-GET-progress__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-GET-progress__entry__40}{#cicd-GET-progress__row-error}{#cicd-GET-progress__row-link}{#cicd-GET-progress__row-links_progress}{#cicd-GET-progress__row-links_progress_id}{#cicd-GET-progress__row-links_progress_url}{#cicd-GET-progress__row-links_results}{#cicd-GET-progress__row-links_results_id}{#cicd-GET-progress__row-links_results_url}{#cicd-GET-progress__row-links_source}{#cicd-GET-progress__row-links_source_id}{#cicd-GET-progress__row-links_source_url}{#cicd-GET-progress__row-percent_complete}{#cicd-GET-progress__row-status}{#cicd-GET-progress__row-status_detail}{#cicd-GET-progress__row-status_label}{#cicd-GET-progress__row-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。 データタイプ：文字列 | | links.results | 実行結果の ID と URL。 データタイプ: オブジェクト "results": { "id": "String", "url": "String" } | | links.results.id | 結果情報のSys_id。関連する結果エンドポイントを呼び出す際に、この値を使用します。 データタイプ：文字列 | | links.results.url | エンドポイントの実行結果を取得するために使用する URL。 データタイプ：文字列 | | links.source | 実行トラッカー \[sys_execution_tracker\] テーブル内のソースレコードに関するSys_idと URL 情報。 データタイプ: オブジェクト "source": { "id": "String", "url": "String" } | | links.source.id | ソースレコードの一意の識別子。 テーブル:実行トラッカー \[sys_execution_tracker\] テーブル データタイプ：文字列 | | links.source.url | 実行トラッカー \[sys_execution_tracker\] テーブルのソース情報を取得するために使用する URL。 データタイプ：文字列 | | links.stash | [apply_changes](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-POST-sc-apply_changes "リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズへの変更の適用を開始します。")操作中に作成された場合、このオブジェクトにはスタッシュに関する情報が含まれます。スタッシュが作成されていない場合、このオブジェクトは返されません。 データタイプ: オブジェクト "stash": { "id": "String", "url": "String" } | | links.stash.id | 作成されたスタッシュの一意の識別子。[CI/CD - POST /sn_cicd/sc/apply_stash/{stash_id}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-POST-sc-apply_stash "リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズ内容への、以前に生成された変更の「スタッシュ」の適用を開始します。")エンドポイントを呼び出してスタッシュを適用する場合は、この値を使用します。 データタイプ：文字列 | | links.stash.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 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' 変更適用コールの進行状況。 { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" }, "source": { "id": "59c4c4d11b5c00103d374087bc4bcb26", "url": "https://instance.servicenow.com/api/now/table/sys_app/59c4c4d11b5c00103d374087bc4bcb26" } }, "status": "2", "status_label": "Successful", "status_message": "This operation succeeded", "status_detail": "Successfully applied commit 1f14e11a7dedcbfa194beb5875fcdaa15ed8accb from source control", "error": "", "percent_complete": 100 } } ### 変更適用コールの進行状況を取得します。この場合、Studio のインスタンスに未保存/コミットされていない変更があったため、未保存の変更を保持するスタッシュが作成されました curl 'instance.servicenow.com/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' 作成されたスタッシュに関する情報を提供する進捗状況。 { "result": { "links": { "progress": { "id": "5b12eca4e0429110f8771827f8fd36a4", "url": "https://instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4" }, "stash": { "id": "fc2224e4e0429110f8771827f8fd3634", "url": "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634" } }, "status": "2", "status_label": "Successful", "status_message": "This operation succeeded", "status_detail": "Successfully applied commit fa5626f6f1f7fef677c16b4a0dd8b22ba8a6e311 from source control", "error": "", "percent_complete": 100 } } ### cURL 要求 {#cicd-GET-progress__example_k4r_rrk_z5b} curl 'instance.servicenow.com/api/sn_cicd/progress/5b12eca4e0429110f8771827f8fd36a4' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' テストスイートの実行の進捗状況 (/sn_cicd/testsuite/run)。 { "result": { "links": { "progress": { "id": "e891389d1b1040103d374087bc4bcb75", "url": "https://instance.servicenow.com/api/sn_cicd/progress/e891389d1b1040103d374087bc4bcb75" }, "results": { "id": "2891389d1b1040103d374087bc4bcb09", "url": "https://instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09" } }, "status": "2", "status_label": "Successful", "status_message": "Suite passed", "status_detail": "Suite passed", "error": "", "percent_complete": 100 } } ## CI/CD - GET /sn_cicd/testsuite/results/{result_id} {#ariaid-title5} 指定された結果識別子に基づいてテストスイートの実行結果を返します。 /sn_cicd/progress/{progress_id} を呼び出した後にこのエンドポイントを呼び出して、実行されたテストスイートの結果を取得します。 ### URL 形式 {#cicd-GET-testsuite-results__section_od3_myv_ylb} バージョニングされた URL: /api/sn_cicd/{api_version}/testsuite/results/{result_id} デフォルト URL: /api/sn_cicd/testsuite/results/{result_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-GET-testsuite-results__entry__2}{#cicd-GET-testsuite-results__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | result_id | 取得するテストスイート結果の一意の識別子。対応する /sn_cicd/progress/{progress_id} エンドポイント呼び出しは、この情報を返します。 データタイプ：文字列 | [表 : 19. パスパラメーター] {#cicd-GET-testsuite-results__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#cicd-GET-testsuite-results__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-GET-testsuite-results__entry__16}{#cicd-GET-testsuite-results__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 22. 要求ヘッダー] {#cicd-GET-testsuite-results__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-GET-testsuite-results__entry__24}{#cicd-GET-testsuite-results__entry-200-status-code}{#cicd-GET-testsuite-results__row-401-status-code}{#cicd-GET-testsuite-results__row-403-status-code}{#cicd-GET-testsuite-results__row-404-status-code}{#cicd-GET-testsuite-results__row-405-status-code}{#cicd-GET-testsuite-results__row-409-status-code}{#cicd-GET-testsuite-results__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-GET-testsuite-results__entry__40}{#cicd-GET-testsuite-results__entry-error}{#cicd-GET-testsuite-results__entry-link}{#cicd-GET-testsuite-results__entry-links_results}{#cicd-GET-testsuite-results__entry-links_results_id}{#cicd-GET-testsuite-results__entry-links_results_url}{#cicd-GET-testsuite-results__entry-percent_complete}{#cicd-GET-testsuite-results__entry-status}{#cicd-GET-testsuite-results__entry-status_detail}{#cicd-GET-testsuite-results__entry-status_label}{#cicd-GET-testsuite-results__entry-status_message} | 名前 | 説明 | |-|-| | child_suite_results | ネストされたテストスイートの結果。このコンテンツの形式は親テストと同じです。 | | エラー | エラーメッセージ。 データタイプ：文字列 | | リンク | 応答に関連付けられているすべてのリンクとsys_idsを含むオブジェクト。 データタイプ: オブジェクト | | links.results | 結果情報を含むオブジェクト。 データタイプ: オブジェクト | | links.results.id | 結果情報の一意の識別子。エンドポイント /sn_cicd/testsuite/results/{result_id} を呼び出すときに、この値を使用します。 データタイプ：文字列 | | links.results.url | 結果などのエンドポイント実行の結果を取得するために使用する URL。 データタイプ：文字列 | | percent_complete | 完了した要求の割合。 | | rolledup_test_error_count | エラーのあるテストの数。 データタイプ：数値 | | rolledup_test_failure_count | 失敗したテストの数。 データタイプ：数値 | | rolledup_test_skip_count | スキップされたテストの数。 データタイプ：数値 | | rolledup_test_success_count | 正常に実行されたテストの数。 データタイプ：数値 | | status | 数値による実行ステータス。status_labelとともに使用されます (0:保留中など)。 値： * 0 (保留中) * 1 (実行中) * 2 (成功) * 3 (失敗) * 4 (キャンセル) {#cicd-GET-testsuite-results__ul_qm3_pzg_w3b} データタイプ：文字列 | | status_detail | 現在のステータスに関する追加情報。 データタイプ：文字列 | | status_label | 実行ステータスの説明。statusとともに使用されます (0:保留中など)。 値： * 保留中 * 実行中 * 成功 * 失敗 * キャンセル済み {#cicd-GET-testsuite-results__ul_hhg_wzg_w3b} データタイプ：文字列 | | status_message | 現在のステータスの説明。 データタイプ：文字列 | | test_suite_duration | テストスイートの実行に要した時間。 単位：秒 データタイプ：文字列 | | test_suite_name | テストスイートの名前。 データタイプ：文字列 | | test_suite_status | テストスイートのステータス。 データタイプ：文字列 | [ ] ### cURL 要求 curl 'instance.servicenow.com/api/sn_cicd/testsuite/results/2891389d1b1040103d374087bc4bcb09' \ --request GET \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "results": { "id": "2891389d1b1040103d374087bc4bcb09", "url": "https://instance.servicenow.com/sys_atf_test_suite_result.do?sys_id=2891389d1b1040103d374087bc4bcb09" } }, "status": "2", "status_label": "Successful", "status_message": "", "status_detail": "", "error": "", "test_suite_status": "success", "test_suite_duration": "1 Second", "rolledup_test_success_count": 1, "rolledup_test_failure_count": 0, "rolledup_test_error_count": 0, "rolledup_test_skip_count": 0, "test_suite_name": "Quick Test", "child_suite_results": [] } } ## CI/CD - POST /sn_cicd/app/batch/install {#ariaid-title6} 指定された単一のバッチに 2 つ以上のパッケージをインストールします。 バッチには、次のタイプの任意の組み合わせを含めることができます。 * アプリケーション： * 会社が所有していない ServiceNow Store 内のスコープ対象のアプリケーション * 会社が所有するアプリケーションリポジトリ内のスコープ対象のアプリケーションまたはグローバルアプリケーション * アプリケーションリポジトリ内のストアアプリケーションのアプリケーションのカスタマイズ {#cicd-POST-app-batch-install__ul_plg_s4l_znb} * ServiceNow プラグイン: プラグインにパッケージ化され、アプリケーションリポジトリに公開されたスコープ対象アプリケーションのアプリケーションのカスタマイズ。 {#cicd-POST-app-batch-install__ul_f1s_kpp_2nb} 注: このエンドポイントは非同期応答モデルを使用します。エンドポイントを呼び出すと、バッチインストール計画の実行の開始など、関連する関数が開始されます。次に、エンドポイントは、要求された関数の実行ステータス (通常は処理待ち) と、一意の識別子とリンクを含む応答メッセージを返します。この情報を使用して、要求の進捗状況または結果に関する追加情報を取得します。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/app/batch/install デフォルト URL: /api/sn_cicd/app/batch/install 注: 使用可能なバージョン [は、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-POST-app-batch-install__entry__2}{#cicd-POST-app-batch-install__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 25. パスパラメーター] {#cicd-POST-app-batch-install__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 26. クエリパラメーター] {#cicd-POST-app-batch-install__entry__10} | 名前 | 説明 | |-|-| | name | 必須です。このバッチ要求のユーザー指定のわかりやすい名前。 データタイプ：文字列 | | notes | バッチインストール計画に関するユーザー指定の追加メモ。 データタイプ：文字列 デフォルト：Null | | パッケージ | 必須です。JSON アレイ。各オブジェクトは、インストールするパッケージの詳細を指定します。 データタイプ：アレイ "packages": [{ "id": "String", "load_demo_data": Boolean, "notes": "String", "requested_customization_version": "String", "requested_version": "String", "type": "String" }] | | packages.id | 必須です。インストールするアプリケーションのSys_idまたはプラグインの識別子。 データタイプ：文字列 | | packages.load_demo_data | パッケージのインストール時にデモデータをロードするかどうかを示すフラグ。 有効な値： * true:デモデータをロードする必要があります。 * false:デモデータはロードされません。 データタイプ：ブーリアン デフォルト値：false | | packages.notes | パッケージに関するユーザー指定のメモ。 データタイプ：文字列 デフォルト：Null | | packages.requested_customization_version | ストアアプリケーションまたはインストールするスコープ対象の ServiceNow プラグインに対するアプリケーションのカスタマイズのバージョン (1.0.2 や 2.3 など)。 データタイプ：文字列 デフォルト:なし。このパラメーターが設定されていない場合、システムはアプリケーションのカスタマイズを検索しません。 | | packages.requested_version | packages.type がアプリケーションに設定されている場合は必須。プラグインに設定されている場合は無視されます。インストールするパッケージのバージョン (1.0.2 や 2.3 など)。 データタイプ：文字列 | | Packages.Type | 必須です。パッケージのタイプ。 有効な値： * アプリケーション * プラグイン {#cicd-POST-app-batch-install__ul_pfk_sbq_2nb} データタイプ：文字列 | [表 : 27. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-app-batch-install__entry__30}{#cicd-POST-app-batch-install__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 28. 要求ヘッダー] {#cicd-POST-app-batch-install__entry__34} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-app-batch-install__entry__38}{#cicd-POST-app-batch-install__entry-200-status-code}{#cicd-POST-app-batch-install__entry-405-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 405 | メソッドが無効です。機能が無効になっています。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-app-batch-install__entry__48}{#cicd-POST-app-batch-install__row-error}{#cicd-POST-app-batch-install__row-link}{#cicd-POST-app-batch-install__row-links_progress}{#cicd-POST-app-batch-install__row-links_progress_id}{#cicd-POST-app-batch-install__row-links_progress_url}{#cicd-POST-app-batch-install__row-percent_complete}{#cicd-POST-app-batch-install__row-status}{#cicd-POST-app-batch-install__row-status_detail}{#cicd-POST-app-batch-install__row-status_label}{#cicd-POST-app-batch-install__row-status_message} | 名前 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 応答に関連付けられているすべてのリンクとsys_ids。 データタイプ: オブジェクト "links": { "progress": {Object}, "results": {Object}, "rollback": {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。 データタイプ：文字列 | | links.results | 結果リンク情報について説明します。 データタイプ: オブジェクト "results": { "id": "String", "url": "String" } | | links.results.id | バッチエンドポイント呼び出しの結果のSys_id。links.results.url で指定されたエンドポイントを呼び出してバッチインストール結果を照会するときに、この値を使用します。 データタイプ：文字列 | | links.results.url | バッチインストールの結果を取得するために使用する URL。 データタイプ：文字列 | | links.rollback | バッチインストールロールバック情報について説明します。 データタイプ: オブジェクト "rollback": { "id": "String" } | | links.rollback.id | インストール済みパッケージのロールバックの詳細のSys_id。/sn_cicd/app/batch/rollback/{rollback_id} エンドポイントを使用して、指定したパッケージのインストールを以前のバージョンにロールバックするには、このパラメーターを使用します。 注: ロールバック機能は、インストールが完了した後にのみ使用できます。 データタイプ：文字列 | | percent_complete | 完了した要求の割合。 データタイプ：数値 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 | [ ] ### cURL 要求 {#cicd-POST-app-batch-install__example_eyp_wdq_2nb} この例では、インストールする 3 つのパッケージ (各タイプに 1 つ) を含むリリース 2.2 展開と呼ばれるバッチインストールを開始します。 curl 'instance.servicenow.com/api/sn_cicd/app/batch/install \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' \ --data { "name": "Release 2.2 Deployment", "packages": [ { "id": "syd_id_abcefghi", "type": "application", "load_demo_data": false, "requested_version": "1.0.2", "notes": "User specific text to describe this application install" }, { "id": "syd_id_defabcde", "type": "application", "requested_version": "1.0.0", "requested_customization_version": "2.0.7", "notes": "Customization for CSM App1" }, { "id": "com.glide.some.plugin", "type": "plugin", "load_demo_data": true, "notes": "Plugin related notes" }] } { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" }, "results": { "id": "df24b1e9db2d0110b5e3f6c5ae97c561", "url": "https://instance.servicenow.com/api/sn_cicd/app/batch/results/df24b1e9db2d0110b5e3f6c5ae97c561" }, "rollback":{ "id": "a329f82e871da64c724ba21c82a764f2" }, }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/app/batch/rollback/{rollback_id} {#ariaid-title7} 特定のバッチインストールに関連付けられているすべてのパッケージを以前のバージョンにロールバックします。 このエンドポイントは、 /sn_cicd/app/batch/install エンドポイントと連携して機能します。rollback_idは、このエンドポイントの戻り結果で提供されます。このエンドポイントが呼び出されると、関連するインストールで指定されたすべてのパッケージがロールバックされます。個々のパッケージをロールバックすることはできません。以前のバージョンがない場合、エンドポイントは関連するパッケージをアンインストールします。 注: このエンドポイントは非同期応答モデルを使用します。エンドポイントを呼び出すと、バッチインストール計画の実行の開始など、関連する関数が開始されます。次に、エンドポイントは、要求された関数の実行ステータス (通常は処理待ち) と、一意の識別子とリンクを含む応答メッセージを返します。この情報を使用して、要求の進捗状況または結果に関する追加情報を取得します。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/app/batch/rollback/{rollback_id} デフォルト URL: /api/sn_cicd/app/batch/rollback/{rollback_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-POST-app-batch-rollback__entry__2}{#cicd-POST-app-batch-rollback__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | rollback_id | インストール済みパッケージを以前のバージョンにロールバックするバッチインストール計画のSys_id。この値は、/sn_cicd/app/batch/install エンドポイントの links.rollback.id パラメーターで返されます。 データタイプ：文字列 | [表 : 31. パスパラメーター] {#cicd-POST-app-batch-rollback__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメーター] {#cicd-POST-app-batch-rollback__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 33. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-app-batch-rollback__entry__16}{#cicd-POST-app-batch-rollback__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 34. 要求ヘッダー] {#cicd-POST-app-batch-rollback__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-app-batch-rollback__entry__24}{#cicd-POST-app-batch-rollback__entry-200-status-code}{#cicd-POST-app-batch-rollback__row-401-status-code}{#cicd-POST-app-batch-rollback__row-403-status-code}{#cicd-POST-app-batch-rollback__row-404-status-code}{#cicd-POST-app-batch-rollback__row-405-status-code}{#cicd-POST-app-batch-rollback__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-app-batch-rollback__entry__38}{#cicd-POST-app-batch-rollback__row-error}{#cicd-POST-app-batch-rollback__row-link}{#cicd-POST-app-batch-rollback__row-links_progress}{#cicd-POST-app-batch-rollback__row-links_progress_id}{#cicd-POST-app-batch-rollback__row-links_progress_url}{#cicd-POST-app-batch-rollback__row-percent_complete}{#cicd-POST-app-batch-rollback__row-status}{#cicd-POST-app-batch-rollback__row-status_detail}{#cicd-POST-app-batch-rollback__row-status_label}{#cicd-POST-app-batch-rollback__row-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 要求 {#cicd-POST-app-batch-rollback__example_eyp_wdq_2nb} この例では、指定されたインストールバッチ計画内のすべてのパッケージを以前のバージョンにロールバックします。 curl 'instance.servicenow.com/api/sn_cicd/app/batch/rollback/a329f82e871da64c724ba21c82a764f2 \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/app_repo/install {#ariaid-title8} アプリケーションリポジトリからエンドポイント呼び出しを行うインスタンスに、指定されたアプリケーションをインストールします。 このエンドポイントを使用すると、ベースシステムアプリケーションとServiceNow Storeアプリケーション、カスタマイズされたServiceNowプラグイン、および独自のServiceNowアプリケーションServiceNow、変更されていないものとカスタマイズされたものの両方をインストールできます。 特定のユースケースを実装するために渡す必要があるパラメーターの概要を以下に示します。指定されていないすべてのパラメーターは渡されず、関連するデフォルトが使用されます。 * ベースアプリケーションのみをインストールし、対応するアプリケーションのカスタマイズはインストールしません。 * sys_id:カスタマイズされたベースアプリケーションのSys_id。 * base_app_version:インストールするベースアプリケーションのバージョン。 {#cicd-POST-app_repo-install__ul_mwp_zly_hnb} * 指定したバージョンのアプリケーションカスタマイズをインストールし、推奨されるベースアプリケーションバージョンを自動的にインストールします。推奨されるベースアプリケーションバージョンは、カスタマイズが最後に公開された時点でインスタンスにインストールされていたベースアプリケーションのバージョンです。アプリケーションのカスタマイズのすべてのバージョンには、対応する推奨ベースアプリケーションバージョンがあります。 * sys_id:カスタマイズされたアプリケーションのSys_id。 * auto_upgrade_base_app:true * version:インストールするアプリケーションのカスタマイズのバージョン。 {#cicd-POST-app_repo-install__ul_c5t_wly_hnb} * アプリケーションのカスタマイズの最新バージョンと、それに対応する推奨ベースアプリケーションバージョンをインストールします。 * sys_id:カスタマイズされたアプリケーションのSys_id。 * auto_upgrade_base_app:true {#cicd-POST-app_repo-install__ul_iwh_dmy_hnb} * 最新バージョンのアプリケーションカスタマイズをインストールしますが、ベースアプリケーションをアプリケーションのカスタマイズが推奨するベースアプリケーションバージョンにアップグレードしないようにするには。 * sys_id:カスタマイズされたアプリケーションのSys_id。 * auto_upgrade_base_app:false {#cicd-POST-app_repo-install__ul_hp1_bny_hnb} * 現在のリリースのスコープ対象の ServiceNow プラグインとともにアプリケーションのカスタマイズをインストールするには、次の手順を実行します。 * scope:カスタマイズされたプラグインのスコープ、または * sys_id:カスタマイズされたアプリケーションのSys_id。これはプラグインの ID ではありません。 * version:インストールするアプリケーションのカスタマイズのバージョン。 {#cicd-POST-app_repo-install__ul_qs4_vvq_spb} * 既にインストールされ、アクティブ化されているスコープ対象のプラグインのアプリケーションカスタマイズをインストールするには、次の手順を実行します。 * sys_id:カスタマイズされたアプリケーションのSys_id。これはプラグインの ID ではありません。 * auto_upgrade_base_app:false * version:インストールするアプリケーションのカスタマイズのバージョン。 {#cicd-POST-app_repo-install__ul_ubt_jh5_mpb} ベースプラグインはファミリーリリースごとに 1 つのバージョンしか含めることができないため、 auto_upgrade_base_app パラメーターと base_app_version パラメーターはプラグインのアプリケーションカスタマイズインストールには適用されません。インスタンスで初めてプラグインをアクティブ化するには、 代わりに /sn_cicd/plugin/{plugin_id}/activate エンドポイントを使用します。 注: このエンドポイントは非同期応答モデルを使用します。エンドポイントを呼び出すと、バッチインストール計画の実行の開始など、関連する関数が開始されます。次に、エンドポイントは、要求された関数の実行ステータス (通常は処理待ち) と、一意の識別子とリンクを含む応答メッセージを返します。この情報を使用して、要求の進捗状況または結果に関する追加情報を取得します。 ### URL 形式 {#cicd-POST-app_repo-install__section_jrg_tbw_ylb} バージョニングされた URL: /api/sn_cicd/{api_version}/app_repo/install デフォルト URL: /api/sn_cicd/app_repo/install 注: 使用可能なバージョン [は、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-POST-app_repo-install__entry__2}{#cicd-POST-app_repo-install__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 37. パスパラメーター] {#cicd-POST-app_repo-install__entry__6} | 名前 | 説明 | |-|-| | auto_upgrade_base_app | アプリケーションのカスタマイズをインストールする予定で、ベースアプリケーションが現在インストールされているバージョンより後のバージョンで構築されている場合にのみ適用されます。 関連付けられたベースアプリケーションを新しいバージョンに自動的にアップグレードするかどうかを示すフラグ。 有効な値： * true:関連するベースアプリケーションを自動的にアップグレードします。 * false:ベースアプリケーションをインスタンスに現在インストールされているバージョンのままにします。 {#cicd-POST-app_repo-install__ul_nm2_rgx_2nb} データタイプ：ブーリアン デフォルト値：false | | base_app_version | インストールするベースアプリケーションのバージョン。ベースアプリケーションとは、ServiceNow Store で利用可能なサードパーティアプリケーションです。 アプリケーションにアプリケーションのカスタマイズがない場合、またはアプリケーションにアプリケーションのカスタマイズがあり、ベースアプリケーションのみを更新する場合は、アプリケーションの更新バージョンをこのパラメーターに入力します。アプリケーションのカスタマイズを更新する場合は、このパラメーターを渡すのではなく、 version パラメーターを渡します。 データタイプ：文字列 デフォルト：Null | | scope | sys_idが指定されていない場合は必須です。アプリケーションのスコープ名 ( x_aah_custom_app など)。 データタイプ：文字列 テーブル:カスタムアプリケーション \[sys_app\] テーブルまたはストアアプリケーション \[sys_store_app\] テーブルのスコープフィールド内。 | | sys_id | scopeが指定されていない場合は必須です。インストールするアプリケーションのSys_id。 データタイプ：文字列 テーブル:カスタムアプリケーション \[sys_app\] テーブルまたはストアアプリケーション \[sys_store_app\] テーブルの \[Sys ID\] フィールド。 | | version | インストールするアプリケーションのバージョン。 データタイプ：文字列 デフォルト: base_app_version パラメーターが空で、 auto_upgrade_base_app パラメーターが true に設定されている場合、(ベースアプリケーションをダウングレードしない限り) 最新のアプリケーションカスタマイズとその推奨ベースアプリケーションバージョンをインストールします。 auto_upgrade_base_appパラメーターが false の場合、アプリケーションのカスタマイズはインストールされますが、ベースアプリケーションはアップグレードされません。 base_app_versionパラメーターが定義されている場合は、ベースアプリケーションのみがインストールされます。 | [表 : 38. クエリパラメーター] {#cicd-POST-app_repo-install__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 39. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-app_repo-install__entry__22}{#cicd-POST-app_repo-install__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 40. 要求ヘッダー] {#cicd-POST-app_repo-install__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-app_repo-install__entry__30}{#cicd-POST-app_repo-install__entry-200-status-code}{#cicd-POST-app_repo-install__row-401-status-code}{#cicd-POST-app_repo-install__row-403-status-code}{#cicd-POST-app_repo-install__row-404-status-code}{#cicd-POST-app_repo-install__row-405-status-code}{#cicd-POST-app_repo-install__row-409-status-code}{#cicd-POST-app_repo-install__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-app_repo-install__entry__46}{#cicd-POST-app_repo-install__row-error}{#cicd-POST-app_repo-install__row-link}{#cicd-POST-app_repo-install__row-links_progress}{#cicd-POST-app_repo-install__row-links_progress_id}{#cicd-POST-app_repo-install__row-links_progress_url}{#cicd-POST-app_repo-install__row-percent_complete}{#cicd-POST-app_repo-install__row-status}{#cicd-POST-app_repo-install__row-status_detail}{#cicd-POST-app_repo-install__row-status_label}{#cicd-POST-app_repo-install__row-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 | 完了した要求の割合。 データタイプ：数値 | | rollback_version | 利用可能な場合は、以前にインストールしたバージョン。利用できない場合は null です。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 | [ ] ### cURL 要求 curl 'instance.servicenow.com/api/sn_cicd/app_repo/install?sys_id=2d146921dbd80010caf55268dc9619d8' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "c159b1e9db1c0010b5e3f6c5ae961903", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c159b1e9db1c0010b5e3f6c5ae961903" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0, "rollback_version": "1.1.0" } } ## CI/CD - POST /sn_cicd/app_repo/publish {#ariaid-title9} 指定されたアプリケーションとそのすべてのアーティファクトをアプリケーションリポジトリに公開します。 注: このエンドポイントを呼び出したときに、追跡対象ファイルに対するコミットされていない変更がある場合は、「400 Bad Request」ステータスコードが返されます。スタジオ で手動で変更をコミットすることも、[CI/CD - POST /sn_cicd/sc/apply_changes](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-POST-sc-apply_changes "リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズへの変更の適用を開始します。")エンドポイントを呼び出して変更をスタッシュすることもできます。顧客アップデート \[sys_update_xml\] テーブルで追跡されない変更は、アプリケーションリポジトリへの公開後に自動的にコミットされます。顧客アップデートテーブルの変更のレイアウトと、このテーブルに表示されていない変更の説明については、「 [Customer Updates table](https://www.servicenow.com/docs/access?context=r_CustomerUpdatesTable&version=australia&pubname=australia-platform-security&ft:locale=en-US)」を参照してください。 ### URL 形式 {#cicd-POST-app_repo-publish__section_zbt_tpb_zlb} バージョニングされた URL: /api/sn_cicd/{api_version}/app_repo/publish デフォルト URL: /api/sn_cicd/app_repo/publish 注: 使用可能なバージョン [は、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-POST-app_repo-publish__entry__2}{#cicd-POST-app_repo-publish__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 43. パスパラメーター] {#cicd-POST-app_repo-publish__entry__6} | 名前 | 説明 | |-|-| | dev_notes | アプリケーションとともに保存する開発者メモ。 データタイプ：文字列 | | scope | sys_idが指定されていない場合は必須です。アプリケーションのスコープ。 データタイプ：文字列 テーブル:カスタムアプリケーション \[sys_app\] テーブルのスコープフィールド内。 | | sys_id | scopeが指定されていない場合は必須です。リポジトリに格納するアプリケーションのsys_id。 データタイプ：文字列 テーブル:カスタムアプリケーション \[sys_app\] テーブルの \[Sys ID\] フィールド内。 | | version | アプリケーションを格納するバージョン。 バージョン番号が渡された場合、公開プロセスはそのバージョンを使用し、異なる場合はローカルアプリケーションのバージョンを更新します。バージョン番号が渡されない場合、公開プロセスはローカルアプリケーションの現在のバージョンを使用し、そのバージョンがアプリケーションリポジトリに存在する場合は失敗します。 データタイプ：文字列 | [表 : 44. クエリパラメーター] {#cicd-POST-app_repo-publish__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-app_repo-publish__entry__20}{#cicd-POST-app_repo-publish__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 46. 要求ヘッダー] {#cicd-POST-app_repo-publish__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-app_repo-publish__entry__28}{#cicd-POST-app_repo-publish__entry-200-status-code}{#cicd-POST-app_repo-publish__row-401-status-code}{#cicd-POST-app_repo-publish__row-403-status-code}{#cicd-POST-app_repo-publish__row-404-status-code}{#cicd-POST-app_repo-publish__row-405-status-code}{#cicd-POST-app_repo-publish__row-409-status-code}{#cicd-POST-app_repo-publish__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求に失敗しました。 考えられる問題: * アプリケーションのバージョンが正しくないか、ダウングレードです。 * アプリケーションはソースコントロールに接続されており、解決する必要があるコミットされていない変更が含まれています。 詳細については、返されたエラーメッセージを参照してください。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-app_repo-publish__entry__46}{#cicd-POST-app_repo-publish__row-error}{#cicd-POST-app_repo-publish__row-link}{#cicd-POST-app_repo-publish__row-links_progress}{#cicd-POST-app_repo-publish__row-links_progress_id}{#cicd-POST-app_repo-publish__row-links_progress_url}{#cicd-POST-app_repo-publish__row-percent_complete}{#cicd-POST-app_repo-publish__row-status}{#cicd-POST-app_repo-publish__row-status_detail}{#cicd-POST-app_repo-publish__row-status_label}{#cicd-POST-app_repo-publish__row-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 | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | アクションの現在のステータスの追加の説明 (該当する場合)。 データタイプ：文字列 | [ ] 次の例は、指定されたsys_idとそのすべてのアーティファクトを含むアプリケーションをアプリケーションリポジトリに公開する方法を示しています。 curl 'instance.servicenow.com/api/sn_cicd/app_repo/publish?sys_id=4dd9686d1b9800103d374087bc4bcb3d' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "d174f8e11bd800103d374087bc4bcbd9", "url": "https://instance.service-now.com/api/sn_cicd/progress/d174f8e11bd800103d374087bc4bcbd9" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/app_repo/ROLLBACK {#ariaid-title10} 指定したアプリケーションの指定したバージョンへのロールバックを開始します。 注: ロールバック機能は、インストールが完了した後にのみ使用できます。 ### URL 形式 {#cicd-POST-app_repo-rollback__section_hhk_brb_zlb} バージョニングされた URL: /api/sn_cicd/{api_version}/app_repo/rollback デフォルト URL: /api/sn_cicd/app_repo/rollback 注: 使用可能なバージョン [は、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-POST-app_repo-rollback__entry__2}{#cicd-POST-app_repo-rollback__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 49. パスパラメーター] {#cicd-POST-app_repo-rollback__entry__6} | 名前 | 説明 | |-|-| | scope | sys_idが指定されていない場合は必須です。ロールバックするアプリケーションのスコープ名。 データタイプ：文字列 | | sys_id | scopeが指定されていない場合は必須です。ロールバックするアプリケーションのsys_id。 データタイプ：文字列 | | version | 必須です。ロールバック操作後に予期されるアプリケーションのバージョン。要求でアプリのカスタマイズのインストールをロールバックする場合は、このフィールドをロールバック操作後にシステムに搭載することが想定されるベースアプリケーションのバージョンに設定します。 データタイプ：文字列 | [表 : 50. クエリパラメーター] {#cicd-POST-app_repo-rollback__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-app_repo-rollback__entry__18}{#cicd-POST-app_repo-rollback__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 52. 要求ヘッダー] {#cicd-POST-app_repo-rollback__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-app_repo-rollback__entry__26}{#cicd-POST-app_repo-rollback__entry-200-status-code}{#cicd-POST-app_repo-rollback__row-401-status-code}{#cicd-POST-app_repo-rollback__row-403-status-code}{#cicd-POST-app_repo-rollback__row-405-status-code}{#cicd-POST-app_repo-rollback__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-app_repo-rollback__entry__38}{#cicd-POST-app_repo-rollback__row-error}{#cicd-POST-app_repo-rollback__row-link}{#cicd-POST-app_repo-rollback__row-links_progress}{#cicd-POST-app_repo-rollback__row-links_progress_id}{#cicd-POST-app_repo-rollback__row-links_progress_url}{#cicd-POST-app_repo-rollback__row-percent_complete}{#cicd-POST-app_repo-rollback__row-status}{#cicd-POST-app_repo-rollback__row-status_detail}{#cicd-POST-app_repo-rollback__row-status_label}{#cicd-POST-app_repo-rollback__row-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 要求 curl 'instance.servicenow.com/api/sn_cicd/app_repo/rollback?sys_id=2d146921dbd80010caf55268dc9619d8&version=1.1.0' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "f7ddb1eddb1c0010b5e3f6c5ae9619c1", "url": "https://instance.service-now.com/api/sn_cicd/progress/f7ddb1eddb1c0010b5e3f6c5ae9619c1" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/instance_scan/full_scan {#ariaid-title11} インスタンスに存在するすべてのアクティブなチェックを実行します。 インスタンススキャンで提供されているチェックを実行することも、独自のチェックを作成することもできます。詳細については、「 [インスタンススキャン](https://www.servicenow.com/docs/access?context=hs-landing-page&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/full_scan デフォルト URL: /api/sn_cicd/instance_scan/full_scan 注: 使用可能なバージョン [は、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-POST-instancescan-fullscan__entry__2}{#cicd-POST-instancescan-fullscan__version-not_optional-RESTAPI} | パラメーター | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 55. パラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-fullscan__entry__6}{#cicd-POST-instancescan-fullscan__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 56. 要求ヘッダー] {#cicd-POST-instancescan-fullscan__entry__10} | ヘッダー | 説明 | |-|-| | なし | | [表 : 57. 応答ヘッダー] ### ステータスコード 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-fullscan__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-fullscan__entry-200-status-code}{#cicd-POST-instancescan-fullscan__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 58. ステータスコード] {#cicd-POST-instancescan-fullscan__table_wwn_rhd_ct} ### 要求本文 API は、要求本文でこれらの JSON または XML 要素を受け入れます。 {#cicd-POST-instancescan-fullscan__table_rm1_yjd_kv__entry__2} | 要素 | 説明 | |-|-| | なし | | [表 : 59. 要求本文で承認された要素] {#cicd-POST-instancescan-fullscan__table_rm1_yjd_kv} ### 応答本文 API は、応答本文でこれらの JSON または XML 要素を返します。 {#cicd-POST-instancescan-fullscan__table_mc1_pr1_tx__entry__2}{#cicd-POST-instancescan-fullscan__entry-error}{#cicd-POST-instancescan-fullscan__entry-link}{#cicd-POST-instancescan-fullscan__entry-links_progress}{#cicd-POST-instancescan-fullscan__entry-progress_url}{#cicd-POST-instancescan-fullscan__entry-status}{#cicd-POST-instancescan-fullscan__entry-status_detail}{#cicd-POST-instancescan-fullscan__entry-status_label}{#cicd-POST-instancescan-fullscan__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。この値は、エンドポイント /sn_cicd/instance_scan/result/{progress_id} を呼び出すときに使用します。 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [表 : 60. 応答本文で返される要素] {#cicd-POST-instancescan-fullscan__table_mc1_pr1_tx} ### cURL 要求のサンプル curl 'instance.service-now.com/api/sn_cicd/instance_scan/full_scan' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/point_scan {#ariaid-title12} 指定されたレコードに対して該当するすべてのチェックを実行します。 たとえば、カタログアイテムに対してポイントスキャンを実行すると、カタログアイテムテーブルに適用可能なチェックのみが実行され、指定されたレコードのみがスキャンされます。 インスタンススキャンで提供されているチェックを実行することも、独自のチェックを作成することもできます。詳細については、「 [インスタンススキャン](https://www.servicenow.com/docs/access?context=hs-landing-page&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/point_scan デフォルト URL: /api/sn_cicd/instance_scan/point_scan 注: 使用可能なバージョン [は、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-POST-instancescan-pointscan__entry__2}{#cicd-POST-instancescan-pointscan__version-not_optional-RESTAPI} | パラメーター | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | target_table | 必須です。「インシデント」など、スキャンするレコードが存在するテーブルの名前。 データタイプ：文字列 | | target_sys_id | 必須です。スキャン対象として指定されたテーブル内のレコードのsys_id。 データタイプ：文字列 | [表 : 61. パラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-pointscan__entry__10}{#cicd-POST-instancescan-pointscan__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 62. 要求ヘッダー] {#cicd-POST-instancescan-pointscan__entry__14} | ヘッダー | 説明 | |-|-| | なし | | [表 : 63. 応答ヘッダー] ### ステータスコード 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-pointscan__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-pointscan__entry-200-status-code}{#cicd-POST-instancescan-pointscan__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。クエリパラメーターが無効または空です。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 64. ステータスコード] {#cicd-POST-instancescan-pointscan__table_wwn_rhd_ct} ### 要求本文 API は、要求本文でこれらの JSON または XML 要素を受け入れます。 {#cicd-POST-instancescan-pointscan__table_rm1_yjd_kv__entry__2} | 要素 | 説明 | |-|-| | なし | | [表 : 65. 要求本文で承認された要素] {#cicd-POST-instancescan-pointscan__table_rm1_yjd_kv} ### 応答本文 API は、応答本文でこれらの JSON または XML 要素を返します。 {#cicd-POST-instancescan-pointscan__table_mc1_pr1_tx__entry__2}{#cicd-POST-instancescan-pointscan__entry-error}{#cicd-POST-instancescan-pointscan__entry-link}{#cicd-POST-instancescan-pointscan__entry-links_progress}{#cicd-POST-instancescan-pointscan__entry-progress_url}{#cicd-POST-instancescan-pointscan__entry-status}{#cicd-POST-instancescan-pointscan__entry-status_detail}{#cicd-POST-instancescan-pointscan__entry-status_label}{#cicd-POST-instancescan-pointscan__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。この値は、エンドポイント /sn_cicd/instance_scan/result/{progress_id} を呼び出すときに使用します。 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [表 : 66. 応答本文で返される要素] {#cicd-POST-instancescan-pointscan__table_mc1_pr1_tx} ### cURL 要求のサンプル curl 'instance.service-now.com/api/sn_cicd/instance_scan/point_scan?target_table=incident&target_sys_id=2d146921dbd80010caf55268dc9619d8' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/suite_scan/combo/{combo_sys_id} {#ariaid-title13} 既に実行されたスイートとターゲット (スコープ対象アプリまたは更新セット) を使用してスキャンを実行します。 このエンドポイントを呼び出す前に、 /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps または /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets エンドポイントを呼び出すか、UI で [スイートスキャンを実行する](https://www.servicenow.com/docs/access?context=hc-execute-suite-scan&version=australia&pubname=australia-platform-administration&ft:locale=en-US) 必要があります。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 {#cicd-POST-instancescan-ss-combo__section_yhg_mkk_fpb} バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/suite_scan/combo/{combo_sys_id} デフォルト URL: /api/sn_cicd/instance_scan/suite_scan/combo/{combo_sys_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-POST-instancescan-ss-combo__entry__2}{#cicd-POST-instancescan-ss-combo__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | combo_sys_id | 実行するスキャンのSys_id。スキャンは、再実行する既存のスキャンである必要があります。 データタイプ：文字列 テーブル:コンボ \[scan_combo\] | [表 : 67. パスパラメーター] {#cicd-POST-instancescan-ss-combo__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 68. クエリパラメーター] {#cicd-POST-instancescan-ss-combo__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 69. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-ss-combo__entry__16}{#cicd-POST-instancescan-ss-combo__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 70. 要求ヘッダー] {#cicd-POST-instancescan-ss-combo__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 71. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-instancescan-ss-combo__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-combo__entry-200-status-code}{#cicd-POST-instancescan-ss-combo__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 72. ステータスコード] {#cicd-POST-instancescan-ss-combo__table_wwn_rhd_ct} ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-instancescan-ss-combo__entry__34}{#cicd-POST-instancescan-ss-combo__entry-error}{#cicd-POST-instancescan-ss-combo__entry-link}{#cicd-POST-instancescan-ss-combo__entry-links_progress}{#cicd-POST-instancescan-ss-combo__entry-progress_url}{#cicd-POST-instancescan-ss-combo__entry-status}{#cicd-POST-instancescan-ss-combo__entry-status_detail}{#cicd-POST-instancescan-ss-combo__entry-status_label}{#cicd-POST-instancescan-ss-combo__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。この値は、エンドポイント /sn_cicd/instance_scan/result/{progress_id} を呼び出すときに使用します。 データタイプ：文字列 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [ ] ### cURL 要求
curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/combo/245d29cc1bd32010178aed72604bcb4b" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' 応答本文:成功。 { "result": { "links": { "progress": { "id": "c08be5c71b1b2010178aed72604bcb6e", "url": "https://instance.servicenow.com/api/sn_cicd/progress/c08be5c71b1b2010178aed72604bcb6e" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps {#ariaid-title14} スコープ対象アプリのリストに対してスイート内のすべてのアクティブなチェックを実行します。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/scoped_apps デフォルト URL: /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/scoped_apps 注: 使用可能なバージョン [は、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-POST-instancescan-ss-sa__entry__2}{#cicd-POST-instancescan-ss-sa__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | suite_sys_id | 実行する [スイート](https://www.servicenow.com/docs/access?context=hc-suites-mgmt&version=australia&pubname=australia-platform-administration&ft:locale=en-US) のSys_id。 データタイプ：文字列 テーブル:スイート \[scan_check_suite\] | [表 : 73. パスパラメーター] {#cicd-POST-instancescan-ss-sa__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 74. クエリパラメーター] {#cicd-POST-instancescan-ss-sa__entry__12} | 名前 | 説明 | |-|-| | app_scope_sys_ids | 必須です。スキャンするスコープ対象アプリケーションのsys_idsのリスト。空のアレイにすることはできません。 データタイプ：アレイ app_scope_sys_ids: ["String", "String", "String"] テーブル:アプリケーション \[sys_scope\] | [表 : 75. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-ss-sa__entry__16}{#cicd-POST-instancescan-ss-sa__accept-RESTAPI}{#cicd-POST-instancescan-ss-sa__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 76. 要求ヘッダー] {#cicd-POST-instancescan-ss-sa__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 77. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-instancescan-ss-sa__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-sa__entry-200-status-code}{#cicd-POST-instancescan-ss-sa__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 78. ステータスコード] {#cicd-POST-instancescan-ss-sa__table_wwn_rhd_ct} ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-instancescan-ss-sa__entry__36}{#cicd-POST-instancescan-ss-sa__entry-error}{#cicd-POST-instancescan-ss-sa__entry-link}{#cicd-POST-instancescan-ss-sa__entry-links_progress}{#cicd-POST-instancescan-ss-sa__entry-progress_url}{#cicd-POST-instancescan-ss-sa__entry-status}{#cicd-POST-instancescan-ss-sa__entry-status_detail}{#cicd-POST-instancescan-ss-sa__entry-status_label}{#cicd-POST-instancescan-ss-sa__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。この値は、エンドポイント /sn_cicd/instance_scan/result/{progress_id} を呼び出すときに使用します。 データタイプ：文字列 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [ ] ### cURL 要求 この例では、スイート内のすべてのアクティブなチェックを 1 つのスコープ対象のアプリケーションに対して実行します。 curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/scoped_apps" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{app_scope_sys_ids: [\"078e8020950f12a215a92e8ad9b346e0\"]}" \ --user 'username':'password' 応答本文:成功。 { "result": { "links": { "progress": { "id": "147fc14b1b572010178aed72604bcbca", "url": "https://instance.servicenow.com/api/sn_cicd/progress/147fc14b1b572010178aed72604bcbca" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets {#ariaid-title15} 更新セットのリストに対してスイート内のすべてのアクティブなチェックを実行します。 注: このエンドポイントは CICD インスタンススキャン実行サービス API の一部であり、 `sn_cicd` 名前空間で使用されます。 ### URL 形式 {#cicd-POST-instancescan-ss-us__section_yhg_mkk_fpb} バージョニングされた URL: /api/sn_cicd/{api_version}/instance_scan/suite_scan/{suite_sys_id}/update_sets デフォルト URL: /api/sn_cicd/instance_scan/suite_scan/{suite_sys_id}/update_sets 注: 使用可能なバージョン [は、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-POST-instancescan-ss-us__entry__2}{#cicd-POST-instancescan-ss-us__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | suite_sys_id | 実行する [スイート](https://www.servicenow.com/docs/access?context=hc-suites-mgmt&version=australia&pubname=australia-platform-administration&ft:locale=en-US) のSys_id。 データタイプ：文字列 テーブル:スイート \[scan_check_suite\] | [表 : 79. パスパラメーター] {#cicd-POST-instancescan-ss-us__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 80. クエリパラメーター] {#cicd-POST-instancescan-ss-us__entry__12} | 名前 | 説明 | |-|-| | update_set_sys_ids | 必須です。スキャンする更新セットのsys_idsのリスト。空のアレイにすることはできません。 データタイプ：アレイ update_set_sys_ids: ["String", "String", "String"] テーブル:更新セット \[sys_update_set\] | [表 : 81. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-instancescan-ss-us__table_dm1_1pk_fpb__entry__2}{#cicd-POST-instancescan-ss-us__accept-RESTAPI}{#cicd-POST-instancescan-ss-us__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 82. 要求ヘッダー] {#cicd-POST-instancescan-ss-us__table_dm1_1pk_fpb} {#cicd-POST-instancescan-ss-us__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 83. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-instancescan-ss-us__table_wwn_rhd_ct__entry__2}{#cicd-POST-instancescan-ss-us__entry-200-status-code}{#cicd-POST-instancescan-ss-us__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 84. ステータスコード] {#cicd-POST-instancescan-ss-us__table_wwn_rhd_ct} ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-instancescan-ss-us__entry__36}{#cicd-POST-instancescan-ss-us__entry-error}{#cicd-POST-instancescan-ss-us__entry-link}{#cicd-POST-instancescan-ss-us__entry-links_progress}{#cicd-POST-instancescan-ss-us__entry-progress_url}{#cicd-POST-instancescan-ss-us__entry-status}{#cicd-POST-instancescan-ss-us__entry-status_detail}{#cicd-POST-instancescan-ss-us__entry-status_label}{#cicd-POST-instancescan-ss-us__entry-healthscan_status_message} | 要素 | 説明 | |-|-| | エラー | エラーの詳細を含むエラーメッセージ。 データタイプ：文字列 | | リンク | 更新セットに関連付けられているリンクとsys_idsに関する情報。 データタイプ: オブジェクト "links": { "progress": {Object} } | | links.progress | 更新セットで実行された操作に関する進行状況情報。 データタイプ: オブジェクト "progress": { "id": "String", "url": "String" } | | links.progress.id | 進捗状況の詳細の一意の識別子。この値は、エンドポイント /sn_cicd/instance_scan/result/{progress_id} を呼び出すときに使用します。 データタイプ：文字列 | | links.progress.url | 更新セットで実行された操作に関する進捗状況の詳細を取得するために使用する URL。 データタイプ：文字列 | | status | 更新セットで実行されたアクションの実行ステータスを表す数値。status_label記述子に対応します。 可能な値： * 0：処理待ち * 1：実行中 * 2：成功 * 3：失敗 * 4:キャンセル済み データタイプ：文字列 | | status_detail | 実行ステータスに関する詳細なメッセージ (利用可能な場合)。実行トラッカー \[sys_execution_tracker\] テーブルの detailed_message フィールドに対応します。 データタイプ：文字列 | | status_label | 更新セットアクションの実行ステータス。status番号に対応します。 可能な値： * キャンセル済み * 失敗 * 保留 * 実行中 * 成功 データタイプ：文字列 | | status_message | 操作が失敗した理由に関する追加情報。操作が成功した場合は空の文字列を返します。 データタイプ：文字列 | [ ] ### cURL 要求 この例では、1つの更新セットに対してスイート内のすべてのアクティブなチェックを実行します。 curl "https://instance.servicenow.com/api/sn_cicd/instance_scan/suite_scan/833655cc1b94101046e87733cd4bcb4e/update_sets" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{update_set_sys_ids: [\"7abef63c1b572010178aed72604bcbfd\"]}" \ --user 'username':'password' 応答本文:成功。 { "result": { "links": { "progress": { "id": "d27511031b972010178aed72604bcb72", "url": "https://instance.servicenow.com/api/sn_cicd/progress/d27511031b972010178aed72604bcb72" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "" } } ## CI/CD - POST /sn_cicd/plugin/{plugin_id}/activate {#ariaid-title16} 指定されたプラグインをアクティブ化します。 ### URL 形式 {#cicd-POST-plugin-activate__section_ufb_vrk_zlb} バージョニングされた URL: /api/sn_cicd/{api_version}/plugin/{plugin_id}/activate デフォルト URL: /api/sn_cicd/plugin/{plugin_id}/activate 注: 使用可能なバージョン [は、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-POST-plugin-activate__entry__2}{#cicd-POST-plugin-activate__version-not_optional-RESTAPI}{#cicd-POST-plugin-activate__entry-plugin_id} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | plugin_id | プラグインの一意の識別子。この識別子は、目的のプラグインのカード内の \[プラグイン\] ページで見つけることができます。名前「ID」で識別されます。 データタイプ：文字列 | [表 : 85. パスパラメーター] {#cicd-POST-plugin-activate__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 86. クエリパラメーター] {#cicd-POST-plugin-activate__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 87. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-plugin-activate__entry__16}{#cicd-POST-plugin-activate__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 88. 要求ヘッダー] {#cicd-POST-plugin-activate__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 89. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-plugin-activate__entry__24}{#cicd-POST-plugin-activate__entry-200-status-code}{#cicd-POST-plugin-activate__row-401-status-code}{#cicd-POST-plugin-activate__row-403-status-code}{#cicd-POST-plugin-activate__row-404-status-code}{#cicd-POST-plugin-activate__row-405-status-code}{#cicd-POST-plugin-activate__row-409-status-code}{#cicd-POST-plugin-activate__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 90. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-plugin-activate__entry__40}{#cicd-POST-plugin-activate__row-error}{#cicd-POST-plugin-activate__row-link}{#cicd-POST-plugin-activate__row-links_progress}{#cicd-POST-plugin-activate__row-links_progress_id}{#cicd-POST-plugin-activate__row-links_progress_url}{#cicd-POST-plugin-activate__row-links_results}{#cicd-POST-plugin-activate__row-links_results_id}{#cicd-POST-plugin-activate__row-links_results_url}{#cicd-POST-plugin-activate__row-percent_complete}{#cicd-POST-plugin-activate__row-status}{#cicd-POST-plugin-activate__row-status_detail}{#cicd-POST-plugin-activate__row-status_label}{#cicd-POST-plugin-activate__row-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。 データタイプ：文字列 | | links.results | 実行結果の ID と URL。 データタイプ: オブジェクト "results": { "id": "String", "url": "String" } | | links.results.id | 結果情報のSys_id。関連する結果エンドポイントを呼び出す際に、この値を使用します。 データタイプ：文字列 | | links.results.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 要求 curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/activate' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "5b3f052ddb580010caf55268dc961963", "url": "https://instance.service-now.com/api/sn_cicd/progress/5b3f052ddb580010caf55268dc961963" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/plugin/{plugin_id}/rollback {#ariaid-title17} 指定したプラグインを、以前にインストールされたバージョンにロールバックします。以前のバージョンがインストールされていない場合は、エラーを返します。
### URL 形式 {#cicd-POST-plugin-rollback__section_zrh_q5k_zlb} バージョニングされた URL: /api/sn_cicd/{api_version}plugin/{plugin_id}/rollback デフォルト URL: /api/sn_cicd/plugin/{plugin_id}/rollback 注: 使用可能なバージョン [は、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-POST-plugin-rollback__entry__2}{#cicd-POST-plugin-rollback__version-not_optional-RESTAPI}{#cicd-POST-plugin-rollback__entry-plugin_id} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | plugin_id | プラグインの一意の識別子。この識別子は、目的のプラグインのカード内の \[プラグイン\] ページで見つけることができます。名前「ID」で識別されます。 データタイプ：文字列 | [表 : 91. パスパラメーター] {#cicd-POST-plugin-rollback__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 92. クエリパラメーター] {#cicd-POST-plugin-rollback__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 93. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-plugin-rollback__entry__16}{#cicd-POST-plugin-rollback__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 94. 要求ヘッダー] {#cicd-POST-plugin-rollback__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 95. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-plugin-rollback__entry__24}{#cicd-POST-plugin-rollback__entry-200-status-code}{#cicd-POST-plugin-rollback__row-401-status-code}{#cicd-POST-plugin-rollback__row-403-status-code}{#cicd-POST-plugin-rollback__row-404-status-code}{#cicd-POST-plugin-rollback__row-405-status-code}{#cicd-POST-plugin-rollback__row-409-status-code}{#cicd-POST-plugin-rollback__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 96. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-plugin-rollback__entry__40}{#cicd-POST-plugin-rollback__row-error}{#cicd-POST-plugin-rollback__row-link}{#cicd-POST-plugin-rollback__row-links_progress}{#cicd-POST-plugin-rollback__row-links_progress_id}{#cicd-POST-plugin-rollback__row-links_progress_url}{#cicd-POST-plugin-rollback__row-percent_complete}{#cicd-POST-plugin-rollback__row-status}{#cicd-POST-plugin-rollback__row-status_detail}{#cicd-POST-plugin-rollback__row-status_label}{#cicd-POST-plugin-rollback__row-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 要求 curl 'instance.servicenow.com/api/sn_cicd/plugin/com.glide.web_service_aggregate/rollback' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "6185dd61db980010caf55268dc961916", "url": "https://instance.service-now.com/api/sn_cicd/progress/6185dd61db980010caf55268dc961916" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/sc/apply_changes {#ariaid-title18} リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズへの変更の適用を開始します。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/sc/apply_changes デフォルト URL: /api/sn_cicd/sc/apply_changes 注: 使用可能なバージョン [は、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-POST-sc-apply_changes__entry__2}{#cicd-POST-sc-apply_changes__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 97. パスパラメーター] {#cicd-POST-sc-apply_changes__entry__6} | 名前 | 説明 | |-|-| | auto_upgrade_base_app | アプリのカスタマイズに変更が適用され、Git リポジトリの最新のコミットが、ローカルインスタンスに現在インストールされているベースアプリケーションのバージョンよりも後のバージョンでビルドされている場合にのみ適用されます。ベースアプリケーションを新しいバージョンに自動アップグレードするかどうかを示すフラグ。 データタイプ：ブーリアン デフォルト：true | | branch_name | アプリケーションを取得するソースコントロールシステム内の分岐の名前。 データタイプ：文字列 デフォルト:ソースコントロールシステムで指定されたデフォルトの分岐。 | | scope | sys_idが指定されていない場合は必須です。x_aah_custom_app など、変更を適用するアプリケーションのスコープ名。この値は、アプリのカスタマイズのカスタムアプリケーション \[sys_app\] テーブルまたはストアアプリケーション \[sys_store_app\] テーブルの \[ scope \] フィールドにあります。 データタイプ：文字列 | | sys_id | scopeが指定されていない場合は必須です。変更を適用するアプリケーションのsys_id。この値は、アプリのカスタマイズのカスタムアプリケーション \[sys_app\] テーブルまたはストアアプリケーション \[sys_store_app\] テーブルの \[ Sys ID \] フィールドにあります。 データタイプ：文字列 | [表 : 98. クエリパラメーター] {#cicd-POST-sc-apply_changes__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 99. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-sc-apply_changes__entry__20}{#cicd-POST-sc-apply_changes__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 100. 要求ヘッダー] {#cicd-POST-sc-apply_changes__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 101. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-sc-apply_changes__entry__28}{#cicd-POST-sc-apply_changes__entry-200-status-code}{#cicd-POST-sc-apply_changes__row-401-status-code}{#cicd-POST-sc-apply_changes__row-403-status-code}{#cicd-POST-sc-apply_changes__row-404-status-code}{#cicd-POST-sc-apply_changes__row-405-status-code}{#cicd-POST-sc-apply_changes__row-409-status-code}{#cicd-POST-sc-apply_changes__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 102. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-sc-apply_changes__entry__44}{#cicd-POST-sc-apply_changes__row-error}{#cicd-POST-sc-apply_changes__row-link}{#cicd-POST-sc-apply_changes__row-links_progress}{#cicd-POST-sc-apply_changes__row-links_progress_id}{#cicd-POST-sc-apply_changes__row-links_progress_url}{#cicd-POST-sc-apply_changes__row-percent_complete}{#cicd-POST-sc-apply_changes__row-status}{#cicd-POST-sc-apply_changes__row-status_detail}{#cicd-POST-sc-apply_changes__row-status_label}{#cicd-POST-sc-apply_changes__row-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 要求 curl 'https://instance.servicenow.com/api/sn_cicd/sc/apply_changes?app_sys_id=043db024db737300a9a754e4dc961915' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "a4fae8911bdc00103d374087bc4bcbbd", "url": "https://instance.service-now/api/sn_cicd/progress/a4fae8911bdc00103d374087bc4bcbbd" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/sc/apply_stash/{stash_id} {#ariaid-title19} リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズ内容への、以前に生成された変更の「スタッシュ」の適用を開始します。 このエンドポイントは、[POST/api/sn_cicd/sc/apply_changes および](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-POST-sc-apply_changes "リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズへの変更の適用を開始します。")[CI/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。") エンドポイントと連携して動作します。POST /api/sn_cicd/sc/apply_changes エンドポイントが呼び出されると、関連付けられたインスタンスのApp Engine Studioの未保存またはコミットされていない変更は、スタ[ッシュ](https://www.servicenow.com/docs/access?context=stash-changes&version=australia&pubname=australia-application-development&ft:locale=en-US)としてデータベースに保存されます。 変更が最初に適用されたときにスタッシュが作成されたかどうかを判断するには、 GET /sn_cicd/progress/{progress_id} エンドポイントを呼び出します。スタッシュが作成された場合は、スタッシュのsys_id (stash_id) と URL が返されます。関連アプリケーションにしまい込まれた変更を適用するには、進行状況エンドポイントによって返されたstash_idを使用してこのapply_stashエンドポイントを呼び出します。 ### URL 形式 {#cicd-POST-sc-apply_stash__section_nw2_lth_y5b} バージョニングされた URL: /api/sn_cicd/{api_version}/sc/apply_stash/{stash_id} デフォルト URL: /api/sn_cicd/sc/apply_stash/{stash_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-POST-sc-apply_stash__entry__2}{#cicd-POST-sc-apply_stash__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | stash_id | 適用するスタッシュの一意の識別子。この値は、対応する [CI/CD - GET /sn_cicd/progress/{progress_id}](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-GET-progress "指定された進捗 ID に関連付けられた 継続的インテグレーションと継続的デリバリ (CICD) 関数の現在の進捗状況とステータスを返します。") エンドポイント呼び出しの links.stash.id パラメーターで返されます。 データタイプ：文字列 | [表 : 103. パスパラメーター] {#cicd-POST-sc-apply_stash__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 104. クエリパラメーター] {#cicd-POST-sc-apply_stash__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 105. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-sc-apply_stash__entry__16}{#cicd-POST-sc-apply_stash__accept-RESTAPI}{#cicd-POST-sc-apply_stash__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 106. 要求ヘッダー] {#cicd-POST-sc-apply_stash__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 107. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-sc-apply_stash__entry__26}{#cicd-POST-sc-apply_stash__entry-200-status-code}{#cicd-POST-sc-apply_stash__row-401-status-code}{#cicd-POST-sc-apply_stash__row-403-status-code}{#cicd-POST-sc-apply_stash__row-404-status-code}{#cicd-POST-sc-apply_stash__row-405-status-code}{#cicd-POST-sc-apply_stash__row-409-status-code}{#cicd-POST-sc-apply_stash__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 108. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-sc-apply_stash__entry__42}{#cicd-POST-sc-apply_stash__row-error}{#cicd-POST-sc-apply_stash__row-link}{#cicd-POST-sc-apply_stash__row-links_progress}{#cicd-POST-sc-apply_stash__row-links_progress_id}{#cicd-POST-sc-apply_stash__row-links_progress_url}{#cicd-POST-sc-apply_stash__row-percent_complete}{#cicd-POST-sc-apply_stash__row-status}{#cicd-POST-sc-apply_stash__row-status_detail}{#cicd-POST-sc-apply_stash__row-status_label}{#cicd-POST-sc-apply_stash__row-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 要求 次のコード例は、stash_id fc2224e4e0429110f8771827f8fd3634 の apply_stash エンドポイントを呼び出す方法を示しています。 curl "https://instance.servicenow.com/api/sn_cicd/sc/apply_stash/fc2224e4e0429110f8771827f8fd3634"\ --request POST \ --header "Accept:application/json" \ --header "Content_Type:application/json" \ --user 'username':'password' スタッシュは処理待ちであるため、まだ適用されていません。 { "result": { "links": { "progress": { "id": "6b04ec28e0429110f8771827f8fd36a4", "url": "https://instance.servicenow.com/api/sn_cicd/progress/6b04ec28e0429110f8771827f8fd36a4" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/sc/import {#ariaid-title20} 指定されたリポジトリ URL と分岐名を使用してアプリケーションをインポートします。 このエンドポイントを使用して、呼び出し元インスタンスのソースコントロールからアプリケーションをインポートし、[/sn_cicd/sc/apply_changes](https://servicenow-prod.fluidtopics.net/cMVhZsDsvQlbZ6gdRP8DBA#cicd-POST-sc-apply_changes "リモートソースコントロールから指定したローカルアプリケーションまたはアプリケーションのカスタマイズへの変更の適用を開始します。") などの継続的インテグレーションと継続的デリバリ (CICD)エンドポイントを使用してアプリケーションを上位環境に展開できるようにします。 注: このエンドポイントを使用する前に、\[ ソースコントロールにリンク \] を使用して別のインスタンスによってセットアップされた Git リポジトリが利用可能である必要があります。 ### URL 形式 バージョニングされた URL: /api/sn_cicd/{api_version}/sc/import デフォルト URL: /api/sn_cicd/sc/import 注: 使用可能なバージョン [は、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-POST-sc-import__entry__2}{#cicd-POST-sc-import__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 109. パスパラメーター] {#cicd-POST-sc-import__entry__6} | 名前 | 説明 | |-|-| | auto_upgrade_base_app | インポートするアプリケーションがアプリのカスタマイズであり、Git リポジトリの最新のコミットが、ローカルインスタンスに現在インストールされているベースアプリケーションのバージョンよりも後のバージョンでビルドされている場合にのみ適用されます。 ベースアプリケーションを新しいバージョンに自動アップグレードするかどうかを示すフラグ。 有効な値： * true:ベースアプリケーションを自動アップグレードします。 * false:ベースアプリケーションを自動アップグレードしません。 データタイプ：ブーリアン デフォルト：True | | branch_name | 必須です。アプリケーションのインポート元のソースコントロールシステム内の分岐の名前。 データタイプ：文字列 | | credential_sys_id | Git リポジトリにアクセスできる認証情報のSys_id。 データタイプ：文字列 デフォルト: repo_url パラメーターが https リポジトリか ssh リポジトリかに応じて、システムプロパティ glide.source_control.default_basic_auth_credential_sys_id または glide.source_control.default_ssh_private_key_credential_sys_id でSys_id設定されます。デフォルトでは、このプロパティは空です。 | | mid_server_sys_id | このアプリケーションのソースコントロール操作に使用する MID サーバーのSys_id。 データタイプ：文字列 デフォルト:空の文字列/NULL | | repo_url | 必須です。アプリケーションのインポート元の Git リポジトリの URL。 データタイプ：文字列 | [表 : 110. クエリパラメーター] {#cicd-POST-sc-import__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 111. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-sc-import__entry__22}{#cicd-POST-sc-import__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 112. 要求ヘッダー] {#cicd-POST-sc-import__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 113. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-sc-import__entry__30}{#cicd-POST-sc-import__entry-200-status-code}{#cicd-POST-sc-import__row-401-status-code}{#cicd-POST-sc-import__row-403-status-code}{#cicd-POST-sc-import__row-405-status-code}{#cicd-POST-sc-import__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 114. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-sc-import__entry__46}{#cicd-POST-sc-import__row-error}{#cicd-POST-sc-import__row-link}{#cicd-POST-sc-import__row-links_progress}{#cicd-POST-sc-import__row-links_progress_id}{#cicd-POST-sc-import__row-links_progress_url}{#cicd-POST-sc-import__row-percent_complete}{#cicd-POST-sc-import__row-status}{#cicd-POST-sc-import__row-status_detail}{#cicd-POST-sc-import__row-status_label}{#cicd-POST-sc-import__row-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 要求 次の例は、`main_branch`の `https://code.devsnc.com/some-user/ncRegrApp1.git` にあるアプリケーションをインポートする方法を示しています。 curl "https://instance.servicenow.com/api/sn_cicd/sc/import?repo_url=https%3A%2F%2Fcode.devsnc.com%2Fsome-user%2FncRegrApp1.git&branch_name=main_branch&credential_sys_id=af9b6d6180feb010f8779c30d4dd6b6b" \ --request POST \ --header "Accept:application/json" \ --user 'admin':'admin' インポートの進行状況を返します。 { "result": { "links": { "progress": { "id": "a18c06ea64f23010f87769cd983d4574", "url": "https://instance.servicenow.com/api/sn_cicd/progress/a18c06ea64f23010f87769cd983d4574" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } ## CI/CD - POST /sn_cicd/testsuite/run {#ariaid-title21} 指定された自動テストスイートを開始します。テストスイートは、エンドポイントの呼び出し元のインスタンスで実行されます。 注: 実行しているスイートに UI テストが含まれている場合は、スケジュール済みのクライアントテストランナーを開いているか、ヘッドレステストランナーの実行を設定できる必要があります。詳細については、「 [自動テストフレームワーク (ATF) のヘッドレスブラウザ」](https://www.servicenow.com/docs/access?context=atf-headless-browser&version=australia&pubname=australia-application-development&ft:locale=en-US)を参照してください。 ### URL 形式 {#cicd-POST-testsuite-run__section_mvk_l2s_zlb} バージョニングされた URL: /api/sn_cicd/{api_version}/testsuite/run デフォルト URL: /api/sn_cicd/testsuite/run 注: 使用可能なバージョン [は、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-POST-testsuite-run__entry__2}{#cicd-POST-testsuite-run__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 115. パスパラメーター] {#cicd-POST-testsuite-run__entry__6} | 名前 | 説明 | |-|-| | browser_name | クライアントテストの実行に使用するブラウザーの名前。この値は、スケジュール済みのクライアントテストランナーで指定された値と一致する必要があります。スケジュール済みのクライアントテストランナーの詳細については、「 [スケジュール済みのクライアントテストランナー](https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_atf_rome_using_the_automated_test_framework/app_store_learnv2_atf_rome_scheduled_client_test_runners?v=utah)」を参照してください。 データタイプ：文字列 有効な値:(すべて小文字である必要があります) * 任意 * クロム * ファイアフォックス * エッジ * IE * サファリ {#cicd-POST-testsuite-run__ul_thd_qln_3jb} デフォルト:any | | browser_version | テストの実行に使用する browser_name で指定されたブラウザのバージョンの開始値。たとえば、「9」と入力すると、すべての 9.x.x.x バージョンが有効になります。この値は、スケジュール済みのクライアントテストランナーで指定された値と一致する必要があります。 データタイプ：文字列 | | is_performance_run | オプション。 テストスイートをパフォーマンステスト (パフォーマンス実行) として実行するかどうかを示すフラグ。 有効な値： * true:テストスイートをパフォーマンステストとして実行します。 * false:インスタンスの標準的な機能テストのデフォルトの動作でテストスイートを実行します。 {#cicd-POST-testsuite-run__ul_lcr_c45_lbc} デフォルト値：false | | os_name | テストスイートを実行するオペレーティングシステムの名前。この値は、スケジュール済みのクライアントテストランナーで指定された値と一致する必要があります。 データタイプ：文字列 | | os_version | テストスイートを実行するオペレーティングシステムのバージョンの開始値。たとえば、「8」と入力すると、すべての 8.x.x.x バージョンが有効になります。この値は、スケジュール済みのクライアントテストランナーで指定された値と一致する必要があります。 データタイプ：文字列 | | run_in_cloud | オプション。テストスイートをクラウドランナーで実行するか手動で実行するかを示すフラグ。 有効な値： * true:Cloud Runner を使用してテストスイートを実行します。 * false:手動テストランナーを使用してテストスイートを実行します。 {#cicd-POST-testsuite-run__ul_jqw_145_lbc} デフォルト値：false | | test_suite_sys_id | test_suite_nameが指定されていない場合は必須です。実行するテストスイートのsys_id。 データタイプ：文字列 テーブル:Test \[sys_atf_test_suite\] | | test_suite_name | test_suite_sys_idが指定されていない場合は必須です。実行するテストスイートの名前。 データタイプ：文字列 Table:Test \[sys_atf_test_suite\] | [表 : 116. クエリパラメーター] {#cicd-POST-testsuite-run__entry__24} | 名前 | 説明 | |-|-| | なし | | [表 : 117. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#cicd-POST-testsuite-run__entry__28}{#cicd-POST-testsuite-run__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 118. 要求ヘッダー] {#cicd-POST-testsuite-run__entry__32} | ヘッダー | 説明 | |-|-| | なし | | [表 : 119. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#cicd-POST-testsuite-run__entry__36}{#cicd-POST-testsuite-run__entry-200-status-code}{#cicd-POST-testsuite-run__row-401-status-code}{#cicd-POST-testsuite-run__row-403-status-code}{#cicd-POST-testsuite-run__row-404-status-code}{#cicd-POST-testsuite-run__row-405-status-code}{#cicd-POST-testsuite-run__row-409-status-code}{#cicd-POST-testsuite-run__row-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | ユーザー認証情報が正しくありません。 | | 403 | 禁止されました。ユーザーがアドミンではないか、sn_cicd.sys_ci_automation ロールを持っていません。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | | 405 | メソッドが無効です。機能が非アクティブです。 | | 409 | 競合。要求されたアイテムが一意ではありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。 | [表 : 120. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#cicd-POST-testsuite-run__entry__52}{#cicd-POST-testsuite-run__row-error}{#cicd-POST-testsuite-run__row-link}{#cicd-POST-testsuite-run__row-links_progress}{#cicd-POST-testsuite-run__row-links_progress_id}{#cicd-POST-testsuite-run__row-links_progress_url}{#cicd-POST-testsuite-run__row-links_results}{#cicd-POST-testsuite-run__row-links_results_id}{#cicd-POST-testsuite-run__row-links_results_url}{#cicd-POST-testsuite-run__row-percent_complete}{#cicd-POST-testsuite-run__row-status}{#cicd-POST-testsuite-run__row-status_detail}{#cicd-POST-testsuite-run__row-status_label}{#cicd-POST-testsuite-run__row-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。 データタイプ：文字列 | | links.results | 実行結果の ID と URL。 データタイプ: オブジェクト "results": { "id": "String", "url": "String" } | | links.results.id | 結果情報のSys_id。関連する結果エンドポイントを呼び出す際に、この値を使用します。 データタイプ：文字列 | | links.results.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 要求 curl 'https://instance.servicenow.com/api/sn_cicd/testsuite/run?test_suite_sys_id=632e43900b20220050192f15d6673a7e' \ --request POST \ --header 'Accept: application/json' \ --user 'username':'password' { "result": { "links": { "progress": { "id": "0578a8d91bdc00103d374087bc4bcbcc", "url": "https://instance.service-now.com/api/sn_cicd/progress/0578a8d91bdc00103d374087bc4bcbcc" } }, "status": "0", "status_label": "Pending", "status_message": "", "status_detail": "", "error": "", "percent_complete": 0 } } 失敗応答: { "result": { "status": "3", "status_label": "Failed", "status_message": "", "status_detail": "", "error": "Scheduled test/suite execution is disabled. Change the value of property 'sn_atf.schedule.enabled' to true to enable it" } }