--- 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 --- # CdmChangesetsApi # CdmChangesetsApi {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：68分 CdmChangesetsApi は、変更セットを管理できるようにするエンドポイントを提供します。これらのエンドポイントを使用して、次のことができます。 * 新しい変更セットを作成します。 * 変更セットの展開 * 変更セットのリストまたは個々の変更セットを取得します。 * 変更セット内のノードの変更を取得します。 * 変更セットの影響を受けるアプリケーションまたは展開可能項目のリストを取得します。 * 変更セットを削除します。 * 指定された変更セットに関連付けられている共有コンポーネントのリストを返します。変更セットの作成エンドポイントでは、非同期キューイング実装が使用されます。このタイプの実装では、最初に変更セットの作成要求エンドポイントを呼び出します。このエンドポイントは要求をキューに入れ、コミット識別子を返します。次に、このコミット識別子を使用して適切なステータスエンドポイントを呼び出し、作成要求のステータスを取得します。この API にアクセスするには、次のいずれかのロールが必要です。 * スクリプト済み REST CDM ビュー ACL (sn_cdm.cdm.viewer) * スクリプト済み REST CDM エディター ACL (sn_cdm.cdm_editor) さらに、この API をインスタンスで使用するには、構成データ管理 (CDM) プラグインをアクティブ化する必要があります。変更セットの詳細については、「 [CDM の変更セットとバージョン管理」](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US)を参照してください。 ## CdmChangesetsApi - 削除 /sn_cdm/changesets {#ariaid-title2} 指定された変更セットを削除します。このエンドポイントにアクセスするには、呼び出し元に CDM エディターロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets デフォルト URL: /api/sn_cdm/changesets 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-DELETE-chgnsets__entry__2}{#chngsets-DELETE-chgnsets__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#chngsets-DELETE-chgnsets__entry__6}{#chngsets-DELETE-chgnsets__changesetNumber-changeset-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | [表 : 2. クエリパラメーター] {#chngsets-DELETE-chgnsets__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-DELETE-chgnsets__entry__14}{#chngsets-DELETE-chgnsets__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 4. 要求ヘッダー] {#chngsets-DELETE-chgnsets__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-DELETE-chgnsets__entry__22}{#chngsets-DELETE-chgnsets__entry-200-status-code}{#chngsets-DELETE-chgnsets__entry-400-status-code}{#chngsets-DELETE-chgnsets__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター {#chngsets-DELETE-chgnsets__entry__30} | 名前 | 説明 | |-|-| | なし | | [ ] ### cURL 要求次のコード例は、変更セットを削除する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \ --request DELETE \ --header "Accept:application/json" \ --user 'username':'password' 変更セットが正常に削除された場合、HTTP ステータスコード以外の応答は返されません。 None - results defined by the HTTP status code ## CdmChangesetsApi - GET /sn_cdm/changesets {#ariaid-title3} 構成データ管理 (CDM) アプリケーションまたは指定された変更セットレコードに関連付けられたすべての変更セットを取得します。
### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets デフォルト URL: /api/sn_cdm/changesets 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-changesets__entry__2}{#chngsets-GET-changesets__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 7. パスパラメーター] {#chngsets-GET-changesets__entry__6} | 名前 | 説明 | |-|-| | appName | 必須です。変更セットを返す CDM アプリケーションの名前。これはアクティブなアプリケーションである必要があります。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | | number | 変更セット番号。この値を渡すと、指定された変更セットのみが返されます。これは、 appName パラメーターで指定された CDM アプリケーションに関連付けられた変更セットである必要があります。データタイプ：文字列デフォルト:なし:CDM アプリケーションに関連付けられているすべての変更セット、または state パラメーターで指定された変更セットを返します。テーブル:CDMChangeset \[sn_cdm_changeset\] | | 状況 | 返される変更セットのステータス。指定されたステータスの指定された CDM アプリケーションに関連付けられた変更セットのみを返します。有効な値： * ブロック済み * 競合をチェックしています * コミットに失敗しました * コミット進行中 * コミット済み * オープンデータタイプ：文字列デフォルト:すべてのステータスのすべての変更セットを返します | [表 : 8. クエリパラメーター] {#chngsets-GET-changesets__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-changesets__entry__18}{#chngsets-GET-changesets__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 10. 要求ヘッダー] {#chngsets-GET-changesets__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-changesets__entry__26}{#chngsets-GET-changesets__entry-200-status-code}{#chngsets-GET-changesets__entry-400-status-code}{#chngsets-GET-changesets__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-changesets__entry__34}{#chngsets-GET-changesets__cdm_apps-autoValidate-row}{#chngsets-GET-changesets__committed_at-changeset-entry}{#chngsets-GET-changesets__sys_created_by-changeset-entry}{#chngsets-GET-changesets__sys_created_on-changeset-entry}{#chngsets-GET-changesets__sys_id-changeset-entry}{#chngsets-GET-changesets__sys_updated_by-changeset-entry}{#chngsets-GET-changesets__sys_updated_on-changeset-entry} | 名前 | 説明 | |-|-| | auto_validate | コミット時に作成された変更セットが検証されているかどうかを示すフラグ。有効な値： * true:変更セットを検証します。 * false:変更セットを検証しません。データタイプ：ブーリアン | | cdm_application | 変更セットに関連付けられた CDM アプリケーションの詳細。データタイプ: オブジェクト "cdm_application": { "link": "String", "value": "String" } | | cdm_application.link | テーブル REST エンドポイントを呼び出して関連する CDM アプリケーションを取得するために使用するクエリ。データタイプ：文字列 | | cdm_application.value | 関連付けられた CDM アプリケーションのSys_id。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | | committed_at | 変更セットが最後にコミットされた日時。データタイプ：文字列形式:YYYY-mm-DD hh:mm:ss | | committed_by | 変更セットをコミットしたユーザーの詳細。データタイプ: オブジェクト "committed_by": { "link": "String", "value": "String" } | | committed_by.link | REST テーブル API を使用して、変更セットをコミットしたユーザーのレコードを取得するために呼び出します。データタイプ：文字列 | | committed_by.value | 変更セットをコミットしたユーザーのSys_id。データタイプ：文字列 | | description | 変更セットの目的の簡単な説明。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | last_conflict_detection_time | 前回の競合の検出が実行されてからの経過時間。競合の検出は、変更セットがコミットされるたびに実行されます。データタイプ：数値単位：ミリ秒 | | last_updated | この変更セットを使用して関連する構成データに変更が加えられた日時。形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | number | 一意の変更セット番号。データタイプ：文字列 | | publish_option | 関連付けられた構成済みスナップショットの公開オプション。有効な値： * publish_none:スナップショットを公開しません。 * publish_valid:コミット後に検証に合格したスナップショットのみを公開します。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | | 状況 | 変更セットの現在のステータス。可能な値： * ブロック済み * 競合をチェックしています * コミットに失敗しました * コミット進行中 * コミット済み * オープンデータタイプ：文字列 | | sys_created_by | 変更セットを作成したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_created_on | 変更セットが作成された日時。データタイプ：文字列形式:YYYY-mm-DD hh:mm:ss | | sys_id | 変更セットのSys_id。データタイプ：文字列テーブル:CDMChangeset \[sn_cdm_changeset\] | | sys_updated_by | 変更セットを最後に更新したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_updated_on | 変更セットが最後に更新された日時。データタイプ：文字列形式:YYYY-mm-DD hh:mm:ss | | タイトル | 変更セットのタイトル。データタイプ：文字列 | [ ] ### cURL 要求このコード例は、特定の変更セットを取得する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 結果を返します: { "result": [ { "description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", "cdm_application": { "value": "62b517a953b70110a1d3ddeeff7b128c", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" }, "sys_updated_on": "2022-06-29 13:09:47", "title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", "number": "Chset-946", "sys_id": "955d6c0f53141110a1d3ddeeff7b1233", "sys_updated_by": "admin", "committed_at": "2022-06-29 13:09:46", "sys_created_on": "2022-06-29 13:09:46", "committed_by": { "value": "6816f79cc0a8016401c5a33be04be441", "link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441" }, "state": "committed", "auto_validate": true, "publish_option": "publish_none", "last_conflict_detection_time": "1656508187450", "sys_created_by": "admin", "last_updated": "2022-06-29 13:09:46" } ] } ## CdmChangesetsApi - GET /sn_cdm/changesets/activity {#ariaid-title4} 指定された変更セット内のノードの変更を取得します。
### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/activity デフォルト URL: /api/sn_cdm/changesets/activity 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-activity__entry__2}{#chngsets-GET-activity__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 13. パスパラメーター] {#chngsets-GET-activity__entry__6}{#chngsets-GET-activity__changesetNumber-changeset-entry}{#chngsets-GET-activity__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。データタイプ：アレイデフォルト:エンドポイントによって決定されたすべてのフィールド | [表 : 14. クエリパラメーター] {#chngsets-GET-activity__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-activity__entry__16}{#chngsets-GET-activity__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 16. 要求ヘッダー] {#chngsets-GET-activity__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-activity__entry__24}{#chngsets-GET-activity__entry-200-status-code}{#chngsets-GET-activity__entry-400-status-code}{#chngsets-GET-activity__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-activity__entry__32} | 名前 | 説明 | |-|-| | changeset_id | 要求された変更セットの詳細。データタイプ: オブジェクト "changeset_id": { "link": "String", "value": "String" } | | changeset_id.link | テーブル REST エンドポイントを呼び出して関連する変更セットを取得するために使用するクエリ。データタイプ：文字列 | | changeset_id.value | 関連する変更セットのSys_id。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | 競合 | 関連する変更セットに競合があるかどうかを示すフラグ。有効な値： * true:競合が検出されました。 * false:競合は見つかりませんでした。データタイプ：ブーリアン | | created | ノードが作成された日時。形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | created_by | ノードを作成するユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | name_path | ノードパス名。データタイプ：文字列 | | new_name | ノードの現在の名前。データタイプ：文字列 | | new_value | ノードの現在の値。リーフノードとアレイリテラルの場合。データタイプ：文字列 | | old_name | ノードの以前の名前。データタイプ：文字列 | | old_value | ノードの以前の値。リーフノードとアレイリテラルの場合。データタイプ：文字列 | | updated | ノードが最後に更新された日時。形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | updated_by | ノードを最後に更新したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | セキュア | 関連付けられたリーフノードが保護されているかどうかを示すフラグ。有効な値： * true:ノードは保護されています。 * false:ノードは保護されませんでした。データタイプ：ブーリアン | | type | ノードタイプ。可能な値： * sn_cdm_node_collection * sn_cdm_node_component * sn_cdm_node_folder * sn_cdm_node_cdi * sn_cdm_node_variable {#chngsets-GET-activity__ul_mlj_vdm_c5b} データタイプ：文字列 | [ ] ### cURL 要求このコード例は、特定の変更セットのノードの変更を取得する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 結果を返します: { "result": [ { "sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233", "changeset_id": "955d6c0f53141110a1d3ddeeff7b1233", "new_value": null, "new_state": "Deleted", "new_name": "Dep-1", "new_type": "Deployable", "new_encrypted": false, "updated_on": "2022-06-29 13:09:46", "updated_by": "admin", "resolution_method": "", "conflict": null, "path": "deployables/Dep-1", "created_by": null, "created_on": null, "old_value": null, "old_state": "Superseded", "old_name": "Dep-1", "old_type": "Deployable", "old_encrypted": false } ] } ## CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id} {#ariaid-title5} 指定された変更セットコミット要求の現在のステータスを返します。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/commit-status/{commit_id} デフォルト URL: /api/sn_cdm/changesets/commit-status/{commit_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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-commit-status__entry__2}{#chngsets-GET-commit-status__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | commit_id | ステータスを返すコミット要求のSys_id。この値は、 [CdmChangesetsApi - POST /sn_cdm/changesets/{changeset_id}/commit](https://servicenow-prod.fluidtopics.net/C8Oqr5tu7yOmassGzieamQ#chngsets-POST-commit "指定された変更セットをコミットします。コミットされると、変更セットは関連するインスタンス内の CDM テーブルに保持されます。") エンドポイントによって返されます。データタイプ：文字列 | [表 : 19. パスパラメーター] {#chngsets-GET-commit-status__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#chngsets-GET-commit-status__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-commit-status__entry__16}{#chngsets-GET-commit-status__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#chngsets-GET-commit-status__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-commit-status__entry__24}{#chngsets-GET-commit-status__entry-200-status-code}{#chngsets-GET-commit-status__entry-400-status-code}{#chngsets-GET-commit-status__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-commit-status__entry__32}{#chngsets-GET-commit-status__cdm_apps-request_id-row}{#chngsets-GET-commit-status__cdm_apps-export_id-row}{#chngsets-GET-commit-status__cdm_apps-state-row} | 名前 | 説明 | |-|-| | commit_id | コミット要求レコードsys_id。エンドポイントに渡されたものと同じです。データタイプ：文字列 | | エラー | アップロード中に発生したエラーの説明。データタイプ：文字列 | | output | アップロードされたデータの説明、またはアップロード中にエラーが発生した場合は、発生したエラーを説明するエラーメッセージ。データタイプ: オブジェクト "output": { "auto_validate": "String", "cdm_application": "String", "committed_at": "String", "committed_by": "String", "description": "String", "last_conflict_detection_time": "String", "number": "String", "publish_option": "String", "snapshot_description": "String", "snapshot_name": "String", "state": "String", "sys_created_by": "String", "sys_id": "String", "title": "String" } | | output.auto_validate | コミット後に検証を呼び出すかどうかを示します。データタイプ：文字列 | | output.cdm_application | アップロードが実行されたアプリケーションの名前。データタイプ：文字列 | | output.committed_at | アップロードされたコンテンツがコミットされた日時。データタイプ：文字列 | | output.committed_by | コミットを実行したエンティティのレコードのSys_id。データタイプ：文字列 | | output.description | 現在使用されていません。データタイプ：文字列 | | output.last_conflict_detection_time | 日時競合の検出の発動。データタイプ：文字列 | | output.number | 変更セットの一意の番号。データタイプ：文字列 | | output.publish_option | 関連付けられた構成済みスナップショットの公開オプション。有効な値： * publish_none:スナップショットを公開しません。 * publish_valid:コミット後に検証に合格したスナップショットのみを公開します。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | | output.snapshot_description | 関連付けられたスナップショットの説明。データタイプ：文字列 | | output.snapshot_name | 関連付けられたスナップショットの名前。データタイプ：文字列 | | output.state | アップロードコンテンツのステータス。可能な値： * コミット済み * 完了 * エラー * 進行中 * 新規 * ready {#chngsets-GET-commit-status__ul_qhn_w4p_psb} データタイプ：文字列 | | output.sys_created_by | レコードを作成したエンティティのSys_id。データタイプ：文字列 | | output.sys_id | 変更セットを含むレコードのSys_id。データタイプ：文字列 | | output.title | アップロードの一部として作成された変更セットのタイトル。データタイプ：文字列 | | processing_state | コミット要求の現在の処理ステータス。可能な値： * NOT_PROCREED * 処理済み {#chngsets-GET-commit-status__ul_gmt_2pp_psb} データタイプ：文字列 | | request_id | 要求 ID。エンドポイントと commit_idに渡されたものと同じです。データタイプ：文字列 | | 状況 | 指定されたコミットの現在のステータス。可能な値： * 完了 * エラー * 進行中 * 新規 * ready データタイプ：文字列テーブル:CDM 要求キュー \[sn_cdm_request_queue\] テーブルの state 列の値。 | | type | 要求のタイプ。可能な値： * commit * エクスポート * upload_and_commit データタイプ：文字列 | [ ] ### cURL 要求次の例は、このエンドポイントを呼び出して、指定されたコミットのステータスを取得する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 成功応答とエラー応答の例を次に示します。 // Successful response { "result": { "type": "commit", "state": "completed", "output": { "sys_id": "4a4407e953124110da35ddeeff7b1235", "number": "Chset-1207", "title": "admin064407e953124110da35ddeeff7b1235", "description": "A description of my changeset provided during creation", "committed_at": "2022-03-17 22:19:33", "committed_by": "6816f79cc0a8016401c5a33be04be441", "sys_created_by": "admin", "state": "committed", "publish_option": "publish_none", "auto_validate": false, "snapshot_name": null, "snapshot_description": null, "cdm_application": "DemoApp", "last_conflict_detection_time": null }, "processing_state": "PROCESSED", "commit_id": "9cd583e953124110da35ddeeff7b128a" } } // Example of an error response { "result": { "state": "error", "errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'", "commit_id": "9cd583e953124110da35ddeeff7b128" } } ## CdmChangesetsApi - GET /sn_cdm/changesets/impacted-deployables {#ariaid-title6} 指定された変更セットに関連付けられている展開可能項目のリストを返します。このエンドポイントにアクセスするには、CDM ビューアーロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/impacted-deployables デフォルト URL: /api/sn_cdm/changesets/impacted-deployables 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-impact-deploys__entry__2}{#chngsets-GET-impact-deploys__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 25. パスパラメーター] {#chngsets-GET-impact-deploys__entry__6}{#chngsets-GET-impact-deploys__changesetNumber-changeset-entry}{#chngsets-GET-impact-deploys__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。データタイプ：アレイデフォルト:エンドポイントによって決定されたすべてのフィールド | [表 : 26. クエリパラメーター] {#chngsets-GET-impact-deploys__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 27. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-impact-deploys__entry__16}{#chngsets-GET-impact-deploys__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#chngsets-GET-impact-deploys__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-impact-deploys__entry__24}{#chngsets-GET-impact-deploys__entry-200-status-code}{#chngsets-GET-impact-deploys__entry-400-status-code}{#chngsets-GET-impact-deploys__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-impact-deploys__id_lcm_5dn_qtb__entry__2}{#chngsets-GET-impact-deploys__cdm_app_link-app-entry}{#chngsets-GET-impact-deploys__cdm_app_value-app-entry}{#chngsets-GET-impact-deploys__cdm_apps-error-entry}{#chngsets-GET-impact-deploys__cdm_dep-sys_created_by-row}{#chngsets-GET-impact-deploys__cdm_deps-sys_created_on-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact-deploys__cdm_dep-sys_updated_on-row} | 名前 | 説明 | |-|-| | cdi_count | 関連する CDM アプリケーションに含まれる構成データアイテム (CDI) の数。データタイプ:数値 (整数) | | cdi_usage | 展開可能項目によって使用される CDI の割合。データタイプ:数値 (整数) | | cdm_app | 展開可能項目に関連付けられた CDM アプリケーションオブジェクト。データタイプ: オブジェクト "cdm_app": { "link": "String", "value": "String" } | | cdm_app.link | REST テーブル API を使用して CDM アプリケーションレコードにアクセスするために使用する呼び出し。データタイプ：文字列 | | cdm_app.value | 関連付けられた CDM アプリケーションレコードのSys_id。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | | cdm_ci | 展開可能項目に関連付けられたアプリケーションサービスオブジェクト。データタイプ: オブジェクト "cdm_ci": { "link": "String", "value": "String" } | | cdm_ci.link | REST テーブル API を使用してアプリケーションサービスレコードにアクセスするために使用する呼び出し。データタイプ：文字列 | | cdm_ci.value | 関連付けられたアプリケーションサービスレコードのSys_id。データタイプ：文字列テーブル:構成アイテム \[cmdb_ci\] | | description | 生成された CDM 展開可能項目の説明。データタイプ：文字列 | | environment_type | 展開可能な環境タイプ。可能な値： * 開発 * 本番 * テストデータタイプ：文字列 | | エラー | 処理中にエラーが発生した場合のみ返されます。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | name | CDM 展開可能項目の名前。データタイプ：文字列 | | node | 展開可能ノードの詳細。データタイプ: オブジェクト "node": { "link": "String", "value": "String" } | | node.link | REST テーブル API を使用して展開可能ノードレコードにアクセスするために使用する呼び出し。データタイプ：文字列 | | node.value | 展開可能ノードレコードのSys_id。データタイプ：文字列テーブル:CDM 展開可能項目 \[sn_cdm_deployable\] | | snapshot_version_counter | 展開可能項目に対して作成されたスナップショットの数。データタイプ:数値 (整数) | | 状況 | 展開可能項目の現在のステータス。可能な値： * アクティブ * 削除済みデータタイプ：文字列 | | sys_created_by | CDM 展開可能項目を作成したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_created_on | CDM 展開可能項目が作成された日時。データタイプ：文字列形式:YYYY-mm-DD hh:mm:ss | | sys_id | 作成された展開可能項目のSys_id。データタイプ：文字列テーブル:CDM 展開可能項目 \[sn_cdm_deployable\] | | sys_updated_by | CDM 展開可能項目を最後に更新したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_updated_on | CDM 展開可能項目が最後に更新された日時。データタイプ：文字列形式:YYYY-mm-DD hh:mm:ss | [ ] {#chngsets-GET-impact-deploys__id_lcm_5dn_qtb} ### cURL 要求次のコード例は、指定した変更セットの影響を受ける展開可能項目を取得する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 結果を返します: { "result": [ { "cmdb_ci": { "value": "75c5d7a953b70110a1d3ddeeff7b12a2", "link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2" }, "cdi_count": "2", "snapshot_version_counter": "3", "description": null, "sys_updated_on": "2022-06-29 16:19:05", "environment_type": "Development", "node": { "value": "a1c517a953b70110a1d3ddeeff7b129b", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b" }, "sys_id": "6dc517a953b70110a1d3ddeeff7b129b", "sys_updated_by": "admin", "cdm_app": { "value": "62b517a953b70110a1d3ddeeff7b128c", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" }, "sys_created_on": "2022-05-31 13:03:23", "cdi_usage": "0.02", "name": "Development_1", "state": "active", "sys_created_by": "admin" } ] } ## CdmChangesetsApi - GET /sn_cdm/changesets/impacted-shared-components {#ariaid-title7} 指定された変更セットに関連付けられている共有コンポーネントのリストを返します。このエンドポイントにアクセスするには、CDM ビューアーロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/impacted-shared-components デフォルト URL: /api/sn_cdm/changesets/impacted-shared-components 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-impact_shared_comp__entry__2}{#chngsets-GET-impact_shared_comp__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 31. パスパラメーター] {#chngsets-GET-impact_shared_comp__entry__6}{#chngsets-GET-impact_shared_comp__changesetNumber-changeset-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。データタイプ：アレイデフォルト:エンドポイントによって決定されたすべてのフィールド | [表 : 32. クエリパラメーター] {#chngsets-GET-impact_shared_comp__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 33. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-impact_shared_comp__entry__16}{#chngsets-GET-impact_shared_comp__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 34. 要求ヘッダー] {#chngsets-GET-impact_shared_comp__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-impact_shared_comp__entry__24}{#chngsets-GET-impact_shared_comp__entry-200-status-code}{#chngsets-GET-impact_shared_comp__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。渡された変更セットは存在しません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-impact_shared_comp__entry__32}{#chngsets-GET-impact_shared_comp__cdm_apps-error-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_detail-entry}{#chngsets-GET-impact_shared_comp__cdm_apps-error_message-entry}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_created_by-row}{#chngsets-GET-impact_shared_comp__cdm_deps-sys_created_on-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_by-row}{#chngsets-GET-impact_shared_comp__cdm_dep-sys_updated_on-row} | 名前 | 説明 | |-|-| | cdm_shared__library | コンポーネントが存在する共有ライブラリのSys_id。データタイプ：文字列 | | description | CDM 共有コンポーネントの説明。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合のみ返されます。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 発生したエラーの詳細。データタイプ：文字列 | | error.message | エラーの概要を示すメッセージ。データタイプ：文字列 | | name | CDM 共有コンポーネントの名前。データタイプ：文字列 | | node | 共有コンポーネントノードのSys_id。データタイプ：文字列テーブル:CDM ノード \[sn_cdm_node\] | | node_main | 共有コンポーネントノードレコードのmain_idのSys_id。データタイプ：文字列テーブル:CDM ノードメイン \[sn_cdm_node_main\] | | 状況 | 共有コンポーネントの現在のステータス。可能な値： * アクティブ * 削除済みデータタイプ：文字列 | | sys_created_by | CDM 共有コンポーネントを作成するユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_created_on | CDM 共有コンポーネントが作成された日時。形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | sys_id | 共有コンポーネントのSys_id。データタイプ：文字列テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | sys_updated_by | CDM 共有コンポーネントを最後に更新したユーザーのユーザー名。たとえば、able.tuter です。データタイプ：文字列 | | sys_updated_on | CDM 共有コンポーネントが最後に更新された日時。形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | version_counter | 共有コンポーネントに対して作成されたバージョンの数。データタイプ：整数 | [ ] ### cURL 要求次のコード例は、changeset = "chset-20" の影響を受ける共有コンポーネントを取得する方法を示しています。 curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": [ { "version_counter": "1", "description": null, "cdm_shared_library": "acb905e097b3991052687b890353afcd", "sys_updated_on": "2022-12-12 20:28:49", "node": "3cb945e097b3991052687b890353af0d", "sys_id": "34b945e097b3991052687b890353af20", "sys_updated_by": "john.jones", "node_main": "74b945e097b3991052687b890353af0d", "sys_created_on": "2022-12-12 20:28:39", "name": "logonService-V2.1", "state": "active", "sys_created_by": "john.jones" }, { "version_counter": "1", "description": null, "cdm_shared_library": "acb905e097b3991052687b890353afcd", "sys_updated_on": "2022-12-12 20:28:49", "node": "b0b945e097b3991052687b890353af11", "sys_id": "30b945e097b3991052687b890353af21", "sys_updated_by": "john.jones", "node_main": "f8b945e097b3991052687b890353af10", "sys_created_on": "2022-12-12 20:28:39", "name": "logonService-V2.2", "state": "active", "sys_created_by": "john.jones" }, { "version_counter": "1", "description": null, "cdm_shared_library": "acb905e097b3991052687b890353afcd", "sys_updated_on": "2022-12-12 20:28:49", "node": "6cb905e097b3991052687b890353afd3", "sys_id": "b4b945e097b3991052687b890353af21", "sys_updated_by": "john.jones", "node_main": "a4b905e097b3991052687b890353afd3", "sys_created_on": "2022-12-12 20:28:39", "name": "paymentService-V1.0", "state": "active", "sys_created_by": "john.jones" }, { "version_counter": "1", "description": null, "cdm_shared_library": "acb905e097b3991052687b890353afcd", "sys_updated_on": "2022-12-12 20:28:49", "node": "e0b905e097b3991052687b890353aff1", "sys_id": "3cb945e097b3991052687b890353af21", "sys_updated_by": "john.jones", "node_main": "2cb905e097b3991052687b890353aff0", "sys_created_on": "2022-12-12 20:28:39", "name": "paymentService-V1.1", "state": "active", "sys_created_by": "john.jones" } ] } ## CdmChangesetsApi - GET /sn_cdm/changesets/{changeset_id}/impacted-deployables {#ariaid-title8} 指定された変更セットに関連付けられている展開可能項目のリストを返します。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables デフォルト URL: /api/sn_cdm/changesets/{changeset_id}/impacted-deployables 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-GET-impacted-deployables__entry__2}{#chngsets-GET-impacted-deployables__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | changeset_id | 処理する変更セットレコードのSys_id。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | [表 : 37. パスパラメーター] {#chngsets-GET-impacted-deployables__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#chngsets-GET-impacted-deployables__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 39. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-GET-impacted-deployables__entry__16}{#chngsets-GET-impacted-deployables__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 40. 要求ヘッダー] {#chngsets-GET-impacted-deployables__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-GET-impacted-deployables__entry__24}{#chngsets-GET-impacted-deployables__entry-200-status-code}{#chngsets-GET-impacted-deployables__entry-400-status-code}{#chngsets-GET-impacted-deployables__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター {#chngsets-GET-impacted-deployables__entry__32} | 名前 | 説明 | |-|-| | changeset_id | 展開可能ノードに関連付けられた前回の変更セットのSys_id。データタイプ：文字列 | | 競合 | 関連付けられた展開可能項目が競合しているかどうかを示すフラグ。可能な値： * 0:競合していません。 * 1:競合しています。詳細については、 conflict_type 返される結果を参照してください。 {#chngsets-GET-impacted-deployables__ul_enr_rxd_btb} データタイプ：数値 | | conflict_type | 展開可能項目の競合のタイプ。可能な値： * corrupted_node * deleted_node * duplicated_node * incomplete_deleted_parent * incomplete_deleted_ref * incomplete_renamed_ref * invalid_include * orphaned_descendant * related_conflict * unlinked_include * unrenamed_include * updated_node {#chngsets-GET-impacted-deployables__ul_okw_dyd_btb} データタイプ：文字列 | | description | 展開可能ノードの説明。データタイプ：文字列 | | effective_from | ノードが有効なときのタイムスタンプ。ノードが作成された変更セットをコミットするまで、この値は null です。データタイプ：数値 | | effective_to | ノードが有効でなくなったときのタイムスタンプ。この値が null の場合、ノードは新しいバージョンに置き換えられるまで有効になります。データタイプ：数値 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | level | アプリケーションレベル (0) から始まるノードの深度。データタイプ：数値 | | linked_to | コレクションおよびコンポーネント内の参照ノードの ID。たとえば、次のノードスニペットは、コレクション collA とコンポーネント compA の間のリンクを示しています。この例では、 linkedTo 値は 1 です。 { components : {compA:{} //MainId: 1}, Collections : { collA : { compA :{} //Include, linkedTo: 1 } } } データタイプ：文字列 | | main_id | 展開可能ノードの一意の識別子。この値は、ノードの作成時に生成され、展開可能ノードの識別に使用されます。データタイプ：数値 | | main_id_encoded | mainIdのエンコードされた値は、基数 57 の文字列表現を使用して結果を返します。データタイプ：文字列 | | name | 展開可能な項目の名前。データタイプ：文字列 | | node_classifier | 開発、本番、テストなどのノード分類。次の形式を使用します。 * /application/deployables/env:Development * /application/deployables/env:Production * /application/deployables/env:Test {#chngsets-GET-impacted-deployables__ul_fg5_ghd_btb} データタイプ：文字列 | | position | 展開可能ノードの位置。アレイにのみ適用されます。たとえば、配列の場合: node1:{ arrayNode: [{}, "literal1", "literal2", []] } {} は位置 1000、「literal1」は位置 2000、「literal2」は位置 3000、 \[\] は位置 4000 ですデータタイプ：数値 | | previous_version | 関連付けられた展開可能ノードの以前のバージョンのSys_id。データタイプ：文字列 | | restricted_to | 関連付けられている展開可能ノードへのアクセスが許可されているユーザーのsys_idsのリスト。すべてのグループが展開可能項目にアクセスできる場合、この値は null です。データタイプ：文字列テーブル:CDM 制限付きグループ \[sn_cdm_restricted_groups\] | | secure_value | CDI または変数の安全な値。リーフノードとアレイリテラルに対してのみ返されます。これは value の返される結果と同じですが、暗号化されています。データタイプ：文字列 | | status | 展開可能ノードのステータスまたは失敗した要求のステータス。可能な値： * 削除済み * 失敗 (エンドポイント呼び出しが失敗した場合は合格) * 新規 * 優先 * updated * 有効 {#chngsets-GET-impacted-deployables__ul_yjp_3gd_btb} データタイプ：文字列 | | system_folder | 関連付けられたフォルダーがシステムフォルダーかどうかを示すフラグ。可能な値： * 0:システムフォルダーではありません。 * 1:システムフォルダー。 {#chngsets-GET-impacted-deployables__ul_e3d_hwd_btb} データタイプ：数値 | | sys_id | 影響を受ける展開可能項目のSys_id。データタイプ：文字列 | | type | sn_cdm_node_deployable などのノードタイプ。この値を使用すると、ノードがコンポーネント、構成データアイテム (CDI)、または展開可能であるかどうかを判断できます。この値は、ノードの作成時に生成されます。データタイプ：文字列 | | value | CDI または変数の値。リーフノードとアレイリテラルに対してのみ返されます。この情報が暗号化されている場合は、 secure_value の戻り結果として返されます。たとえば、このノードが CDI `nodeA:{cdi1: 1}` の場合、 value 返される結果は 1 です。`node1: {arrayNode: [{}, "literal1", "literal2", []]}` などの配列ノードの場合、value返される結果は literal1 です。データタイプ：文字列 | [ ] ### cURL 要求次の例は、sys_idが bf506e69537c3010a1d3ddeeff7b12c0 の変更セットに関連付けられている展開可能項目を要求する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\ --request GET \ --header "Accept:application/json" \ --user 'username':'password' このエンドポイントの成功した応答とエラー応答の両方を次に示します。 // Successful response { "result": [ { "sys_id": "833527a953924110da35ddeeff7b12c1", "type": "sn_cdm_node_deployable", "main_id": "150", "main_id_encoded": "&M", "node_path": "!&@!&D!&M", "level": 2, "status": "valid", "node_classifier": "/application/deployables/env:Development", "position": null, "restricted_to": null, "changeset_id": "cb3527a953924110da35ddeeff7b12c0", "previous_version": "e8946f6953924110da35ddeeff7b1264", "effective_from": "1647563806950", "effective_to": null, "name": "Development_1", "description": "dev deployable decription", "value": null, "secure_value": null, "system_folder": "0", "linked_to": null, "conflict": "0", "conflict_type": null }, { "sys_id": "a245e7a953924110da35ddeeff7b1223", "type": "sn_cdm_node_deployable", "main_id": "153", "main_id_encoded": "&P", "node_path": "!&@!&D!&P", "level": 2, "status": "valid", "node_classifier": "/application/deployables/env:Test", "position": null, "restricted_to": null, "changeset_id": "ea45e7a953924110da35ddeeff7b1222", "previous_version": "9505ef6953924110da35ddeeff7b121a", "effective_from": "1647563821422", "effective_to": null, "name": "Test_1", "description": "test deployable decription", "value": null, "secure_value": null, "system_folder": "0", "linked_to": null, "conflict": "0", "conflict_type": null } ] } // Example of an error response { "error": { "message": "Error: Unexpected error occurred in create request.Error:Application not found", "detail": "" }, "status": "failure" } ## CdmChangesetsApi - POST /sn_cdm/changesets/{changeset_id}/commit {#ariaid-title9} 指定された変更セットをコミットします。コミットされると、変更セットは関連するインスタンス内の CDM テーブルに保持されます。システムはアプリケーションを更新して、変更セット内の構成データへの変更を保持します。変更セットの状況が \[コミット済み\] に変更されます。その後、変更セットの影響を受ける各展開可能項目のスナップショットが生成されます。このエンドポイントは、コミット要求の ID を返します。この ID を使用して [CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/C8Oqr5tu7yOmassGzieamQ#chngsets-GET-commit-status "指定された変更セットコミット要求の現在のステータスを返します。") エンドポイントを呼び出し、変更セットコミットの現在のステータスを取得します。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit デフォルト URL: /api/sn_cdm/changesets/{changeset_id}/commit 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-POST-commit__entry__2}{#chngsets-POST-commit__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | changeset_id | 処理する変更セットレコードのSys_id。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | [表 : 43. パスパラメーター] {#chngsets-POST-commit__entry__8} | 名前 | 説明 | |-|-| | autoValidate | コミット時に作成されたスナップショットが検証されているかどうか (関連するポリシーがスナップショットに対して実行されるかどうか) を示すフラグ。有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 {#chngsets-POST-commit__ul_aqt_zmb_psb} デフォルト値：false | | publishOption | 関連する構成スナップショットの公開オプション。有効な値： * publish_none:スナップショットを公開しません。 * publish_valid:コミット後に検証に合格したスナップショットのみを公開します。注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | [表 : 44. クエリパラメーター] {#chngsets-POST-commit__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-POST-commit__entry__18}{#chngsets-POST-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-commit__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 46. 要求ヘッダー] {#chngsets-POST-commit__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-POST-commit__entry__28}{#chngsets-POST-commit__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。エラー:\<エラーメッセージ\> 渡した changeset_id パラメーターが正しいことを検証します。このエンドポイントにアクセスするために必要なロールがあることを確認してください。 | | 500 | 内部サーバーエラーエラー:無効なブール値。 autoValidateパラメーターを渡した場合は、それがブール値であることを確認します。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター {#chngsets-POST-commit__id_bgt_byy_ztb__entry__2} | 名前 | 説明 | |-|-| | commit_id | コミット要求のSys_id。コミット要求のステータスを確認するために [CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/C8Oqr5tu7yOmassGzieamQ#chngsets-GET-commit-status "指定された変更セットコミット要求の現在のステータスを返します。") エンドポイントを呼び出すときに、この ID を使用します。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | コミットのステータス。エラーが発生した場合にのみ返されます。可能な値:失敗データタイプ：文字列 | [ ] {#chngsets-POST-commit__id_bgt_byy_ztb} ### cURL 要求次の例は、このエンドポイントを呼び出して変更セットレコードをコミットする方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'username':'password' 変更セットのコミット要求が成功した場合の応答を次に示します。 // Successful response { "result": { "commit_id": "64b5f79f5379301096edddeeff7b12eb" } } // Example of an error response { "error": { "message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue", "detail": "" }, "status": "failure" } ## CdmChangesetsApi - POST /sn_cdm/changesets/create {#ariaid-title10} 指定した CDM アプリケーションまたは共有ライブラリの新しい変更セットをオープンステータスで作成します。このエンドポイントにアクセスするには、CDM エディターロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/create/ デフォルト URL: /api/sn_cdm/changesets/create/ 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-POST-create__entry__2}{#chngsets-POST-create__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 49. パスパラメーター] {#chngsets-POST-create__entry__6}{#chngsets-POST-create__appName-changesets-entry} | 名前 | 説明 | |-|-| | appName | 必須です。この変更セットに関連付ける CDM アプリケーションまたは共有ライブラリの名前。これは、アクティブなアプリケーションまたは共有ライブラリである必要があります。データタイプ：文字列 | | description | 変更セットの説明。他のユーザーが変更セットの目的を理解できるように入力します。データタイプ：文字列デフォルト：なし | | returnFields | 応答の一部として返す CDM 変更セット \[sn_cdm_changeset\] テーブル内のフィールドのカンマ区切りリスト。データタイプ：文字列 | [表 : 50. クエリパラメーター] {#chngsets-POST-create__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-POST-create__entry__18}{#chngsets-POST-create__accept-JSON-only-entry-RESTAPI}{#chngsets-POST-create__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 52. 要求ヘッダー] {#chngsets-POST-create__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-POST-create__entry__28}{#chngsets-POST-create__entry-200-status-code}{#chngsets-POST-create__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。エラー:\<エラーメッセージ\> 指定された CDM アプリケーションまたは共有ライブラリが存在し、アクティブ状態であることを確認してください。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター {#chngsets-POST-create__entry__36} | 名前 | 説明 | |-|-| | auto_validate | 自動検証が実行されたかどうかを示すフラグ。可能な値： * true:自動検証が実行されました。 * false:自動検証は実行されませんでした。データタイプ：ブーリアン | | cdm_application | 変更セットに関連付けられた CDM アプリケーションの詳細。データタイプ: オブジェクト "cdm_application": { "link": "String", "value": "String" } 例: `{"value": "", "link": "http://localhost:8081/api/now/table/*'}"` | | cdm_application.link | 関連する CDM アプリケーションの URL。データタイプ：文字列 | | cdm_application.value | 関連付けられた CDM アプリケーションのSys_id。データタイプ：文字列 | | committed_at | 変更セットが関連するリポジトリにコミットされた日時。データタイプ：文字列 | | committed_by | 変更セットを作成したエンティティのSys_id。データタイプ：文字列 | | description | エンドポイントの呼び出し時に渡された変更セットの説明。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | last_conflict_detection_time | 前回競合の検出が実行された時間。データタイプ：数値単位：ミリ秒 | | number | 新しい変更セットの一意の識別子。データタイプ：文字列 | | publish_option | 関連付けられた構成済みスナップショットの公開オプション。有効な値： * publish_none:スナップショットを公開しません。 * publish_valid:コミット後に検証に合格したスナップショットのみを公開します。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | | snapshot_description | 変更セットに関連付けられたスナップショットの説明。データタイプ：文字列 | | 状況 | 変更セット作成のステータス。可能な値： * ブロック済み * 競合をチェックしています * コミットに失敗しました * コミット進行中 * コミット済み * オープンデータタイプ：文字列 | | status | 変更セット作成のステータス。エラーが発生した場合にのみ返されます。可能な値:失敗データタイプ：文字列 | | sys_created_by | 変更セットレコードを作成したエンティティのSys_id。データタイプ：文字列 | | sys_id | 新しい変更セットのSys_id。データタイプ：文字列 | | タイトル | アプリケーションに関連付けられた変更セットのタイトル。通常、システムによって自動生成されます。データタイプ：文字列 | [ ] ### cURL 要求次の例は、App Service1 CDM アプリケーションに関連付けられた変更セットを作成する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'username':'password' 変更セットが正常に作成された場合の応答を次に示します。 // Example of a successful response { "result": { "sys_id": "42748779c370301054c1582e1340ddcd", "number": "Chset-8", "title": "admin2021-06-18 10:06:46", "description": null, "committed_at": "", "committed_by": null, "sys_created_by": "admin", "state": "open", "publish_option": "publish_none", "auto_validate": false, "snapshot_name": null, "snapshot_description": null, "cdm_application": "App%20Service1" } } // Example of an error response { "error": { "message": "Error: Unexpected error occurred in create request.Error:Application not found", "detail": "" }, "status": "failure" } ### cURL 要求次の例は、共有ライブラリ「javalib」の変更セットを作成する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' 応答： ``` ``` ## CdmChangesetsApi - PUT /sn_cdm/changesets/commit {#ariaid-title11} 指定された変更セットを更新してコミットします。システムはアプリケーションを更新して、変更セット内の構成データへの変更を保持します。変更セットの状況が \[コミット済み\] に変更されます。その後、変更セットの影響を受ける各展開可能項目のスナップショットが生成されます。このエンドポイントは、コミット要求の ID を返します。この ID を使用して [CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/C8Oqr5tu7yOmassGzieamQ#chngsets-GET-commit-status "指定された変更セットコミット要求の現在のステータスを返します。") エンドポイントを呼び出し、変更セットコミットの現在のステータスを取得します。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/{changeset_id}/commit デフォルト URL: /api/sn_cdm/changesets/{changeset_id}/commit 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#chngsets-PUT-commit__entry__2}{#chngsets-PUT-commit__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 55. パスパラメーター] {#chngsets-PUT-commit__entry__6}{#chngsets-PUT-commit__autoValidate-changeset-entry}{#chngsets-PUT-commit__changesetNumber-changeset-entry} | 名前 | 説明 | |-|-| | autoValidate | コミット中に作成されたスナップショットが検証されているかどうかを示すフラグ。つまり、関連するポリシーがスナップショットに対して実行されるかどうかを示します。有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。データタイプ：ブーリアンデフォルト値：false | | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | publishOption | 関連付けられた構成済みスナップショットの公開オプション。有効な値： * publish_none:スナップショットを公開しません。 * publish_valid:コミット後に検証に合格したスナップショットのみを公開します。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | [表 : 56. クエリパラメーター] {#chngsets-PUT-commit__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 57. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#chngsets-PUT-commit__entry__18}{#chngsets-PUT-commit__accept-JSON-only-entry-RESTAPI}{#chngsets-PUT-commit__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 58. 要求ヘッダー] {#chngsets-PUT-commit__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 59. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#chngsets-PUT-commit__entry__28}{#chngsets-PUT-commit__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。エラー:\<エラーメッセージ\> 渡した changeset_id パラメーターが正しいことを検証します。このエンドポイントにアクセスするために必要なロールがあることを確認してください。 | | 500 | 内部サーバーエラー:無効なブール値。 autoValidateパラメーターを渡した場合は、それがブール値であることを確認します。 | [表 : 60. ステータスコード] ### 応答本文のパラメーター {#chngsets-PUT-commit__id_cjx_1yy_ztb__entry__2} | 名前 | 説明 | |-|-| | commit_id | コミット要求のSys_id。コミット要求のステータスを確認するために [CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id}](https://servicenow-prod.fluidtopics.net/C8Oqr5tu7yOmassGzieamQ#chngsets-GET-commit-status "指定された変更セットコミット要求の現在のステータスを返します。") エンドポイントを呼び出すときに、この ID を使用します。データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | コミットのステータス。エラーが発生した場合にのみ返されます。可能な値:失敗データタイプ：文字列 | [ ] {#chngsets-PUT-commit__id_cjx_1yy_ztb} ### cURL 要求次のコード例は、このエンドポイントを使用して変更セットを更新する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \ --request PUT \ --header "Accept:application/json" \ --user 'username':'password' 結果を返します: { "result": { "commit_id": "cca8190f53141110a1d3ddeeff7b129e" } }