--- 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 --- # CdmApplicationsApi # CdmApplicationsApi {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：155分 CdmApplicationsAPI は、DevOps コンフィグ ワークスペース UI にあるコンポーネント、コレクション、展開可能項目、およびコンポーネント変数フォルダーに構成データを uploadzoominsoftware.io/utah-devops/ できるようにするエンドポイントを提供します。また、展開可能な構成データを DevOps パイプラインにエクスポートし、共有コンポーネントと共有アプリケーションを管理できるようにするエンドポイントもあります。 エクスポートエンドポイントとアップロードエンドポイントでは、非同期キューイングの実装が使用されます。このタイプの実装では、最初に目的のエクスポートまたはアップロード要求エンドポイントを呼び出します。これらのエンドポイントは要求をキューに入れ、要求識別子を返します。次に、この要求識別子を使用して、アップロード用とエクスポート用の適切なステータスエンドポイントを呼び出し、アップロード/エクスポートのステータスを取得します。エクスポート要求の場合、エクスポートが完了したら、エクスポートのコンテンツを要求することもできます。 この API は、アプリケーションレコードの簡単な取得を実行するエンドポイントを提供しません。これらのレコードを取得するには、 [テーブル](https://servicenow-prod.fluidtopics.net/PGmiQS3PYaFpQEwlEzsYfg#c_TableAPI "テーブル API には、既存のテーブルで作成、読み取り、更新、および削除 (CRUD) 操作を実行できるエンドポイントが用意されています。") API を使用します。 この API にアクセスするには、次のいずれかのロールが必要です。 * スクリプト済み REST CDM ビュー ACL (sn_cdm.cdm.viewer) * スクリプト済み REST CDM エディター ACL (sn_cdm.cdm_editor) さらに、この API をインスタンスで使用するには、 構成データ管理 (CDM) プラグインをアクティブ化する必要があります。 構成データ管理とDevOps コンフィグワークスペース UI の詳細については、「[構成データのアップロード](https://www.servicenow.com/docs/access?context=cdm-upload-process&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 共有コンポーネントと共有ライブラリの詳細については、「 [アプリケーション間でのコンポーネントの共有 --- コンポーネントライブラリ](https://www.servicenow.com/docs/access?context=cdm-component-libraries&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 ## CdmApplicationsApi - 削除 /sn_cdm/applications/deployables {#ariaid-title2} 指定された構成データ管理 (CDM) 展開可能項目を削除します。 このエンドポイントの呼び出し元には、CDM admin ロールが必要です。 ### URL 形式 {#apps-DELETE-applications-deploys__section_tqf_h2n_qtb} バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-DELETE-applications-deploys__entry__2}{#apps-DELETE-applications-deploys__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 1. パスパラメーター] {#apps-DELETE-applications-deploys__entry__6} | 名前 | 説明 | |-|-| | appName | 必須です。展開可能項目が関連付けられている CDM アプリケーションの名前。 データタイプ：文字列 テーブル:CDM 展開可能項目 \[sn_cdm_deployable\] | | name | 削除する展開可能項目の名前。 データタイプ：文字列 テーブル:CDM 展開可能項目 \[sn_cdm_deployable\] | [表 : 2. クエリパラメーター] {#apps-DELETE-applications-deploys__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-DELETE-applications-deploys__entry__16}{#apps-DELETE-applications-deploys__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 4. 要求ヘッダー] {#apps-DELETE-applications-deploys__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-DELETE-applications-deploys__entry__24}{#apps-DELETE-applications-deploys__entry-200-status-code}{#apps-DELETE-applications-deploys__entry-400-status-code}{#apps-DELETE-applications-deploys__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター {#apps-DELETE-applications-deploys__entry__32} | 名前 | 説明 | |-|-| | なし | | [ ] ### cURL 要求 次のコード例は、展開可能項目を削除する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ --request DELETE \ --header "Accept:application/json" \ --user 'username':'password1' 展開可能項目が正常に削除された場合、HTTP ステータスコード以外の応答は返されません。 None - results defined by the HTTP status code ## CdmApplicationsApi - 削除 /sn_cdm/applications/shared_components {#ariaid-title3} 指定された 構成データ管理 (CDM) アプリケーションから共有コンポーネント使用参照を削除します。 このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 {#apps-DELETE-shared_components__section_lbh_bp1_fwb} バージョニングされた URL: /api/sn_cdm/{api_version}/applications/shared_components デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-DELETE-shared_components__entry__2}{#apps-DELETE-shared_components__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 7. パスパラメーター] {#apps-DELETE-shared_components__entry__6}{#apps-DELETE-shared_components__changesetNumber-changeset-entry} | 名前 | 説明 | |-|-| | appName | 必須です。指定された共有コンポーネントの関連付けを削除するアプリケーションの名前。指定するアプリケーションでは、タイプフィールドが「shared_library」に設定されている必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | changesetNumber | 必須です。 関連する変更セットの一意の識別子 (「Chset-10」など)。 データタイプ：文字列 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | sharedComponentName | 必須です。指定されたアプリケーションから削除する共有コンポーネントの一意の名前。 データタイプ：文字列 テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | [表 : 8. クエリパラメーター] {#apps-DELETE-shared_components__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-DELETE-shared_components__entry__18}{#apps-DELETE-shared_components__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 10. 要求ヘッダー] {#apps-DELETE-shared_components__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-DELETE-shared_components__entry__26}{#apps-DELETE-shared_components__entry-200-status-code}{#apps-DELETE-shared_components__entry-400-status-code}{#apps-DELETE-shared_components__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター {#apps-DELETE-shared_components__entry__34} | 名前 | 説明 | |-|-| | result | 空。HTTP ステータスコードは、呼び出しの結果を示します。 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | [ ] ### cURL 要求 次のコード例は、「App1」アプリケーションから「paymentService-V1.1」共有コンポーネントを削除する方法を示しています。 curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?appName=App1&sharedComponentName=paymentService-V1.1&changesetNumber=Chset-25" \ --request DELETE \ --header "Accept:application/json" \ --user 'username':'password' 応答： "" ## CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/content {#ariaid-title4} 指定された構成データエクスポート要求に関連付けられたコンテンツを返します。 [CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-deploy-exports-status "指定された構成データエクスポート要求の現在のステータスを返します。") エンドポイントから完全な応答を受信した後にのみ、このエンドポイントを呼び出してください。エクスポートが完了する前にこのエンドポイントを呼び出すと、400 ステータスエラーが返されます。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/content デフォルト URL: /api/sn_cdm/applications/deployables/exports/{export_id}/content 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-GET-deploy-exports-content__entry__2}{#apps-GET-deploy-exports-content__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | export_id | 構成データを返すエクスポート要求の一意の識別子。この値は、 [CdmApplicationsApi - POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-deploy-exports "指定されたアプリケーションの現在のスナップショットと 1 つ以上の展開可能項目を CDM エクスポーターキャッシュ [sn_cdm_exporter_cache] テーブルにエクスポートする要求を送信します。") エンドポイントによって返されます。 | [表 : 13. パスパラメーター] {#apps-GET-deploy-exports-content__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#apps-GET-deploy-exports-content__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-GET-deploy-exports-content__entry__16}{#apps-GET-deploy-exports-content__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 16. 要求ヘッダー] {#apps-GET-deploy-exports-content__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-GET-deploy-exports-content__entry__24}{#apps-GET-deploy-exports-content__entry-200-status-code}{#apps-GET-deploy-exports-content__entry-400-status-code}{#apps-GET-deploy-exports-content__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#apps-GET-deploy-exports-content__entry__32} | 名前 | 説明 | |-|-| | エラー | エクスポート中に発生したエラーの説明。 データタイプ：文字列 | | export_id | エクスポート要求 ID。エンドポイントに渡されたものと同じです。 データタイプ：文字列 | | exporter_result | 指定された構成データエクスポートの内容。 データタイプ： * JSON オブジェクト:要求でデータを JSON 形式でエクスポートする場合。 * 文字列:要求が他の形式でデータをエクスポートする場合。 {#apps-GET-deploy-exports-content__ul_xk1_2j1_psb} | | request_id | エクスポート要求 ID。エンドポイントに渡されたものと同じです。 データタイプ：文字列 | | 状況 | 指定されたエクスポートの現在のステータス。 可能な値： * 完了 * エラー * 進行中 * 新規 * ready データタイプ：文字列 テーブル:CDM 要求キュー \[sn_cdm_request_queue\] テーブルの \[ステータス\] 列。 | [ ] ### cURL 要求 次の例では、ID が 3ab14a7d53b1301096edddeeff7b12f のエクスポート要求の構成データを要求します。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/content" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 次に、考えられる返される結果を示します。 // Successful completion of the export request { "result": { "export_id": "3ab14a7d53b1301096edddeeff7b12f" "exporter_result": "DEP1.COMP.cdi_1=cdi-1-value" } } // Response when an incorrect export_id is passed. Note: Status code is 200. { "result": { "request_id": "3ab14a7d53b1301096edddeeff7b12e", "state": "error", "errors": "Invalid requestId '3ab14a7d53b1301096edddeeff7b12fe'", "export_id": "3ab14a7d53b1301096edddeeff7b12e" } } ## CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status {#ariaid-title5} 指定された構成データエクスポート要求の現在のステータスを返します。 [CdmApplicationsApi - POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-deploy-exports "指定されたアプリケーションの現在のスナップショットと 1 つ以上の展開可能項目を CDM エクスポーターキャッシュ [sn_cdm_exporter_cache] テーブルにエクスポートする要求を送信します。")エンドポイントを使用してエクスポート要求を行います。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables/exports/{export_id}/status デフォルト URL: /api/sn_cdm/applications/deployables/exports/{export_id}/status 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-GET-deploy-exports-status__entry__2}{#apps-GET-deploy-exports-status__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | export_id | ステータスを返すエクスポート要求のSys_id。この値は、 [CdmApplicationsApi - POST /sn_cdm/applications/deployables/exports](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-deploy-exports "指定されたアプリケーションの現在のスナップショットと 1 つ以上の展開可能項目を CDM エクスポーターキャッシュ [sn_cdm_exporter_cache] テーブルにエクスポートする要求を送信します。") エンドポイントによって返されます。 | [表 : 19. パスパラメーター] {#apps-GET-deploy-exports-status__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#apps-GET-deploy-exports-status__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-GET-deploy-exports-status__entry__16}{#apps-GET-deploy-exports-status__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#apps-GET-deploy-exports-status__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-GET-deploy-exports-status__entry__24}{#apps-GET-deploy-exports-status__entry-200-status-code}{#apps-GET-deploy-exports-status__entry-400-status-code}{#apps-GET-deploy-exports-status__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#apps-GET-deploy-exports-status__entry__32} | 名前 | 説明 | |-|-| | エラー | エクスポート中に発生したエラーの説明。 データタイプ：文字列 | | export_id | エクスポート要求 ID。エンドポイントに渡されたものと同じです。 データタイプ：文字列 | | exporter_result | 関連するエラーの詳細。 データタイプ: オブジェクト | | exporter_result.errors | エクスポート中に発生したエラーの説明。 データタイプ：アレイ | | exporter_result.execution_id | エクスポーター実行レコードの一意の識別子。 データタイプ：文字列 テーブル:CDM エクスポーターの実行 \[sn_cdm_exporter_execution\] | | exporter_result.state | 指定されたエクスポートの現在のステータス。 可能な値： * complete * エラー * 進行中 * 新規 {#apps-GET-deploy-exports-status__ul_k3z_32r_ssb} データタイプ：文字列 テーブル:CDM エクスポーターの実行 \[sn_cdm_exporter_execution\] | | request_id | エクスポート要求 ID。エンドポイントに渡されたものと同じです。 データタイプ：文字列 | | 状況 | 指定されたエクスポートの現在のステータス。 可能な値： * 完了 * エラー * 進行中 * 新規 * ready データタイプ：文字列 テーブル:CDM 要求キュー \[sn_cdm_request_queue\] テーブルの \[ステータス\] 列。 | [ ] ### cURL 要求 次の例では、ID 3ab14a7d53b1301096edddeeff7b12f のエクスポートのステータスを要求します。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports/3ab14a7d53b1301096edddeeff7b12f/status" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 考えられる結果は次のとおりです。 // Successful completion of the export request { "result": { "state": "completed", "export_id": "3ab14a7d53b1301096edddeeff7b12f0" } } // Response when an incorrect export_id is passed. Note: Status code is 200. { "result": { "request_id": "3ac8e1b05311301096edddeeff7b123c", "state": "error", "errors": "Invalid requestId '3ac8e1b05311301096edddeeff7b123c'", "export_id": "3ac8e1b05311301096edddeeff7b123c" } } // Response when the export encounters an error. The exporter_result array contains the error information. Note: Status code is 200. { "result": { "state": "completed", "export_id": "24536c3353f9301096edddeeff7b12b1", "exporter_result": { "execution_id": "81536c3353f9301096edddeeff7b129e", "state": "failure", "errors": [ "Snapshot 'SNA-001-published-non_compliant' has not passed validation. All snapshots of deployable '/ApplicationA/deployables/DEP3' are required to pass validation" ] } } } ## CdmApplicationsApi - GET /sn_cdm/applications/shared_components {#ariaid-title6} 指定されたアプリケーションで使用される共有コンポーネントのリストを返します。新しいバージョンが利用可能な共有コンポーネントのみを返すように指定することもできます。 このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/shared_components デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-GET-shared_components__entry__2}{#apps-GET-shared_components__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 25. パスパラメーター] {#apps-GET-shared_components__entry__6} | 名前 | 説明 | |-|-| | appName | 必須です。共有コンポーネントのリストを返すアプリケーションの名前。アプリケーションの \[タイプ\] フィールドは shared_library に設定する必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | withUpdatesOnly | 新しい更新バージョンが利用可能な共有コンポーネントのみを返すかどうかを示すフラグ。 有効な値： * true:新しい更新バージョンが利用可能な共有コンポーネントのみを返します。 * false:指定されたアプリケーションで使用されるすべての共有コンポーネントを返します。 デフォルト値：false | [表 : 26. クエリパラメーター] {#apps-GET-shared_components__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 27. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-GET-shared_components__entry__16}{#apps-GET-shared_components__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 28. 要求ヘッダー] {#apps-GET-shared_components__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-GET-shared_components__entry__24}{#apps-GET-shared_components__entry-200-status-code}{#apps-GET-shared_components__entry-400-status-code}{#apps-GET-shared_components__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター {#apps-GET-shared_components__entry__32} | 名前 | 説明 | |-|-| | currentVersion | CDM アプリケーションの現在のバージョン。 データタイプ:数値 (整数) | | currentVersionName | 現在使用されている共有コンポーネントバージョンの名前。 データタイプ：文字列 | | description | 共有コンポーネントの説明。 データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | name | 共有コンポーネントの一意の名前。 データタイプ：文字列 | | sharedLibraryName | 共有コンポーネントが属する共有ライブラリの名前。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | updateVersionName | 更新可能な共有コンポーネントバージョンの名前。 データタイプ：文字列 | [ ] ### cURL 要求 次のコード例は、このエンドポイントを呼び出して、「App1」で使用される新しいバージョンの共有コンポーネントを取得する方法を示しています。 curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?updatesOnly=true&appName=App1" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": [ { "name": "Component_Name", "description": "", "sharedLibraryName": "Shared Library", "currentVersion": "2", "currentVersionName": "Component_A-v2.shc", "updateVersionName": "Component_A-v3.shc" } ] } ## CdmApplicationsApi - GET /sn_cdm/applications/shared_libraries/components/applications {#ariaid-title7} 指定されたライブラリ内にある共有コンポーネントと、共有コンポーネントを使用するアプリケーションのマップを返します。 このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/shared_libraries/components/applications デフォルト URL: /api/sn_cdm/applications/shared_libraries/components/applications 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-GET-shared_libs-comp-apps__entry__2}{#apps-GET-shared_libs-comp-apps__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 31. パスパラメーター] {#apps-GET-shared_libs-comp-apps__entry__6} | 名前 | 説明 | |-|-| | sharedComponentName | 必須です。マップに含める共有コンポーネントの名前。 データタイプ：文字列 テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | sharedLibraryName | 必須です。マップに含める共有ライブラリの名前。指定するアプリケーションでは、タイプフィールドが「shared_library」に設定されている必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 32. クエリパラメーター] {#apps-GET-shared_libs-comp-apps__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 33. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-GET-shared_libs-comp-apps__entry__16}{#apps-GET-shared_libs-comp-apps__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 34. 要求ヘッダー] {#apps-GET-shared_libs-comp-apps__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-GET-shared_libs-comp-apps__entry__24}{#apps-GET-shared_libs-comp-apps__entry-200-status-code}{#apps-GET-shared_libs-comp-apps__entry-400-status-code}{#apps-GET-shared_libs-comp-apps__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター {#apps-GET-shared_libs-comp-apps__entry__32} | 名前 | 説明 | |-|-| | description | 共有コンポーネントを使用するアプリケーションの説明 データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | managed_by_group | アプリケーションを管理できるグループsys_idsのカンマ区切りリスト。 データタイプ：文字列 | | name | コンポーネントを使用するアプリケーションの一意の名前。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | sys_id | 共有コンポーネントを利用するアプリケーションのSys_id。 データタイプ：文字列 | [ ] ### cURL 要求 次のコード例は、このエンドポイントを呼び出して、「paymentService-V1.1」共有コンポーネントを使用する「OracleG-Library-10」共有ライブラリ内のアプリケーションを示すマップを取得する方法を示しています。 curl "https://instance-name.service-now.com/api/sn_cdm/applications/shared_libraries/components/applications?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": { "component_name": [ { "name": "App Name", "description": "desc", "managed_by_group": null, "sys_id": "4e7808bb1b371110636e0fe0604bcb08" }, { "name": "Config App", "description": "desc", "managed_by_group": null, "sys_id": "55a75cfb1b771110636e0fe0604bcb5c" }, { "name": "Database App", "description": "desc", "managed_by_group": null, "sys_id": "2eb7503f1b771110636e0fe0604bcb06" } ] } } ## CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id} {#ariaid-title8} 指定された構成データのアップロード要求の現在のステータスを返します。 ### URL 形式 {#apps-GET-upload-status__section_isc_fy3_psb} バージョニングされた URL: /api/sn_cdm/{api_version}/applications/upload-status/{upload_id} デフォルト URL: /api/sn_cdm/applications/upload-status/{upload_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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-GET-upload-status__entry__2}{#apps-GET-upload-status__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | | upload_id | ステータスが返されるアップロード要求のSys_id。この値は、さまざまな CdmApplication アップロード要求エンドポイントによって返されます。 | [表 : 37. パスパラメーター] {#apps-GET-upload-status__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#apps-GET-upload-status__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 39. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-GET-upload-status__entry__16}{#apps-GET-upload-status__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 40. 要求ヘッダー] {#apps-GET-upload-status__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-GET-upload-status__entry__24}{#apps-GET-upload-status__entry-200-status-code}{#apps-GET-upload-status__entry-400-status-code}{#apps-GET-upload-status__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#apps-GET-upload-status__entry__32} | 名前 | 説明 | |-|-| | エラー | アップロード中に発生したエラーの説明。 データタイプ：文字列 | | 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 注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。 | | output.snapshot_description | 関連付けられたスナップショットの説明。 データタイプ：文字列 | | output.snapshot_name | 関連付けられたスナップショットの名前。 データタイプ：文字列 | | output.state | アップロードコンテンツのステータス。 可能な値： * blocked * checking_for_conflict * commit_failed * commit_in_progress * コミット済み * open {#apps-GET-upload-status__ul_qhn_w4p_psb} データタイプ：文字列 | | output.sys_created_by | レコードを作成したエンティティのSys_id。 データタイプ：文字列 | | output.sys_id | 変更セットを含むレコードのSys_id。 データタイプ：文字列 | | output.title | アップロードの一部として作成された変更セットのタイトル。 データタイプ：文字列 | | processing_state | アップロード要求の現在の処理ステータス。 可能な値： * NOT_PROCESSED * 処理済み {#apps-GET-upload-status__ul_gmt_2pp_psb} データタイプ：文字列 | | 状況 | アップロード要求の現在のステータス。 可能な値： * 完了 * エラー * 進行中 * 新規 * ready {#apps-GET-upload-status__ul_ozn_bv5_xsb} | | type | アップロード要求のタイプ。 可能な値： * commit * upload_and_commit {#apps-GET-upload-status__ul_l5m_x55_xsb} データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、ID 5560a6895326301096edddeeff7b1230 のアップロードのステータスを要求する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/upload-status/5560a6895326301096edddeeff7b1230" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 考えられる結果は次のとおりです。 // Successful completion of the upload request { "result": { "type": "upload_and_commit", "state": "completed", "output": { "sys_id": "be681dc95362301096edddeeff7b12ba", "number": "Chset-102", "title": "admin2021-09-10 08:09:07", "description": null, "committed_at": "2021-09-10 20:23:37", "committed_by": "6816f79cc0a8016401c5a33be04be441", "sys_created_by": "admin", "state": "committed", "publish_option": "publish_none", "auto_validate": false, "snapshot_name": null, "snapshot_description": null, "cdm_application": "Demo_App1631126164773", "last_conflict_detection_time": "1631305417894" }, "processing_state": "PROCESSED", "upload_id": "5560a6895326301096edddeeff7b1230" } } // Response when an incorrect upload_id is passed. Note: Status code is 200. { "result": { "state": "error", "errors": "Invalid requestId '5560a6895326301096edddeeff7b1240'", "upload_id": "5560a6895326301096edddeeff7b1240" } } // Response when the upload encounters an error. The exporter_result array contains the error information. Note: Status code is 200. { "result": { "type": "upload_and_commit", "state": "error", "output": "Error encountered during execution of request.\nError: Node 'dbSettings' of type 'sg_cdm_node_component' cannot create child 'dbSettings' of type 'sg_cdm_node_folder'", "processing_state": "PROCESSED", "upload_id": "272f8a415326301096edddeeff7b1232" } } ## CdmApplicationsApi:POST /sn_cdm/applications/deployables {#ariaid-title9} 新しい展開可能項目を作成し、指定された 構成データ管理 (CDM) アプリケーションに自動的に接続します。 開発、テスト、本番の 3 つの環境タイプのいずれかに対して展開可能項目を作成できます。 このエンドポイントにアクセスするには、発信者に CDM admin ロールが必要です。 複数の展開可能項目を作成する必要がある場合は、 [CdmApplicationsApi - POST /sn_cdm/applications/deployables/create](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-deploy-create "1 つ以上の新しい展開可能項目を作成します。") エンドポイントを使用します。 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables デフォルト URL: /api/sn_cdm/applications/deployables ### サポートされている要求パラメーター {#apps-POST-applications-deploys__entry__2}{#apps-POST-applications-deploys__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 43. パスパラメーター] {#apps-POST-applications-deploys__entry__6}{#apps-POST-applications-deploys__cdm_apps-envType-entry}{#apps-POST-applications-deploys__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | appName | 必須です。展開可能項目に関連付ける既存のアクティブな CDM アプリケーションの名前。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | 環境タイプ | 必須です。 展開可能項目の環境タイプ。 有効な値 (大文字と小文字を区別): * 開発 * 本番 * テスト 注: 展開可能な環境タイプは、作成後に変更できません。 データタイプ：文字列 | | name | 必須です。CDM 展開可能項目の名前。 255 文字を超えることはできません。デフォルトで許可される文字は、0-9、A-Z、a-z、_,-,.,%、$、whitespace、:、# です。 データタイプ：文字列 最大長:255 文字 許容文字:0 から 9、A-Z、a-z、_、-, ., %、$、whitespace、:、および# | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。 データタイプ：アレイ デフォルト:エンドポイントによって決定されたすべてのフィールド | [表 : 44. クエリパラメーター] {#apps-POST-applications-deploys__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-applications-deploys__entry__20}{#apps-POST-applications-deploys__accept-JSON-only-entry-RESTAPI}{#apps-POST-applications-deploys__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 46. 要求ヘッダー] {#apps-POST-applications-deploys__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-applications-deploys__entry__30}{#apps-POST-applications-deploys__entry-200-status-code}{#apps-POST-applications-deploys__entry-400-status-code}{#apps-POST-applications-deploys__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター {#apps-POST-applications-deploys__id_dkr_tdn_qtb__entry__2}{#apps-POST-applications-deploys__cdm_app_link-app-entry}{#apps-POST-applications-deploys__cdm_app_value-app-entry}{#apps-POST-applications-deploys__cdm_apps-error-entry}{#apps-POST-applications-deploys__cdm_dep-sys_created_by-row}{#apps-POST-applications-deploys__cdm_deps-sys_created_on-row}{#apps-POST-applications-deploys__cdm_dep-sys_updated_by-row}{#apps-POST-applications-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 | [ ] {#apps-POST-applications-deploys__id_dkr_tdn_qtb} ### cURL 要求 次のコード例は、展開可能項目を作成して CDM アプリケーションに関連付ける方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables?name=Dep-1&returnFields=name%2Csys_id%2Cstate&appName=testApp&envType=Test" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password1' 結果を返します: { "result": [ { "cmdb_ci": { "value": "f5b9e00b53901110a1d3ddeeff7b12b8", "link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8" }, "cdi_count": "0", "snapshot_version_counter": "0", "description": null, "sys_updated_on": "2022-06-29 12:53:57", "environment_type": "Test", "node": { "value": "7db9e00b53901110a1d3ddeeff7b12b6", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/7db9e00b53901110a1d3ddeeff7b12b6" }, "sys_id": "39b9e00b53901110a1d3ddeeff7b12b7", "sys_updated_by": "admin", "cdm_app": { "value": "62b517a953b70110a1d3ddeeff7b128c", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" }, "sys_created_on": "2022-06-29 12:53:57", "cdi_usage": "0", "name": "Dep-2", "state": "active", "sys_created_by": "admin" } ] } ## CdmApplicationsApi - POST /sn_cdm/applications/deployables/create {#ariaid-title10} 1 つ以上の新しい展開可能項目を作成します。 次の 2 つのタイプの展開可能項目のいずれかを作成できます。 * アプリケーションモデル (CI サービス) に手動で接続する必要がある展開可能項目。 * 動的に作成された新しいアプリケーションモデル (CI サービス) に自動的に接続される展開可能項目。 開発、テスト、本番の 3 つの環境タイプのいずれかに対して展開可能項目を作成できます。 複数の展開可能項目を作成する場合、自動生成される展開可能項目の名前はパターン「 `DeployableType_Number`」に従います。ここで、 `Number` は新しい展開可能項目の作成に基づいて実行中のシーケンス番号です。たとえば、エンドポイント呼び出しで `Test` タイプの 3 つの展開可能項目を作成すると、それらの名前は Test_1、Test_2、および Test_3 になります。その後、エンドポイントを再度呼び出し、別のテスト展開可能項目を作成すると、その自動生成名は Test_4 になります。これらの番号は、展開可能項目が削除されても再利用されません。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables/create デフォルト URL: /api/sn_cdm/applications/deployables/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-deploy-create__entry__2}{#apps-POST-deploy-create__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 49. パスパラメーター] {#apps-POST-deploy-create__entry__6}{#apps-POST-deploy-create__cdm_apps-envType-entry} | 名前 | 説明 | |-|-| | appSysId | 必須です。展開可能項目に関連付けるアクティブな CDM アプリケーションのSys_id。 データタイプ：文字列 | | 自動接続 | 必須です。新しく作成された展開可能項目を動的に生成されたアプリケーションモデルに自動的に接続するかどうかを決定するフラグ。 有効な値： * true:新しく作成された展開可能項目を動的に生成されたアプリケーションモデルに接続します。 * false:展開可能項目を作成するだけです。これらの展開可能項目は、UI を使用してアプリケーションモデルに手動でマッピングする必要があります。 {#apps-POST-deploy-create__ul_gdp_vwr_xsb} データタイプ：ブーリアン | | 環境タイプ | 必須です。 展開可能項目の環境タイプ。 有効な値 (大文字と小文字を区別): * 開発 * 本番 * テスト 注: 展開可能な環境タイプは、作成後に変更できません。 データタイプ：文字列 | | 数量 | 必須です。作成する展開可能項目の数。 データタイプ：数値 | [表 : 50. クエリパラメーター] {#apps-POST-deploy-create__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-deploy-create__entry__20}{#apps-POST-deploy-create__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-create__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 52. 要求ヘッダー] {#apps-POST-deploy-create__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-deploy-create__entry__30}{#apps-POST-deploy-create__entry-200-status-code}{#apps-POST-deploy-create__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター {#apps-POST-deploy-create__entry__36} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | result | 作成された展開可能項目のSys_ids。 データタイプ：アレイ | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、単一の展開可能項目を作成し、それを既存の CDM アプリケーションに関連付ける方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/create?envType=Production&appSysId=5e118055b712011054c1e5a6ce11a9d4&quantity=5&autoConnect=true" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'username':'password' この呼び出しに対する可能な応答 (成功とエラーの両方) を次に示します。 // Successful completion of the upload request { "result": [ "8ba43a3db7d6011054c1e5a6ce11a9a4", "93a47a3db7d6011054c1e5a6ce11a90d", "dba47a3db7d6011054c1e5a6ce11a91d", "6fa47a3db7d6011054c1e5a6ce11a921", "efa47a3db7d6011054c1e5a6ce11a925" ] } // Error response { "error": { "message": "Error: CDM Application with SysID 5e118055b712011054c1e5a6ce11a9d1 was not found. (sys_script_include.8cf0fbf453626010a1d3ddeeff7b12fe.script; line 211)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi - POST /sn_cdm/applications/deployables/exports {#ariaid-title11} 指定されたアプリケーションの現在のスナップショットと 1 つ以上の展開可能項目を CDM エクスポーターキャッシュ \[sn_cdm_exporter_cache\] テーブルにエクスポートする要求を送信します。 このエンドポイントは、要求の一意の識別子を返します。これを使用して、 [CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-deploy-exports-status "指定された構成データエクスポート要求の現在のステータスを返します。") エンドポイントを呼び出してエクスポートのステータスを取得します。エクスポートが完了したら、 [CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/content](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-deploy-exports-content "指定された構成データエクスポート要求に関連付けられたコンテンツを返します。") エンドポイントを使用して、関連するアプリケーションの構成データを取得できます。 スナップショットは、構成変更がコミットされた時点での展開可能項目の完全なデータモデルです。これには、含まれているコンポーネント、コレクション、変数、および展開可能項目固有の変数とオーバーライドが含まれます。展開可能項目の詳細については、「 [展開可能項目の作成と更新](https://www.servicenow.com/docs/access?context=cdm-deployable-define&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 注: スナップショットは、展開可能項目あたり 10,000 構成データアイテム (CDI) またはアプリケーションあたり 100,000 CDI を超えることはできません。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables/exports デフォルト URL: /api/sn_cdm/applications/deployables/exports 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-deploy-exports__entry__2}{#apps-POST-deploy-exports__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 55. パスパラメーター] {#apps-POST-deploy-exports__entry__6} | 名前 | 説明 | |-|-| | additionalDeployables | エクスポートするプライマリ以外の展開可能項目。 データタイプ：オブジェクトのアレイ "additionalDeployables": [ { "app_name": "String", "deployable_name": "String" } ] 例: `[{'app_name':'TestApp', "deployable_name:'DEP-1'}]` デフォルト:空のアレイ:\[\] | | additionalDeployables.app_name | アレイ additionalDeployables 指定されている場合は必須です。構成データをエクスポートする展開可能項目に関連付けられたアプリケーションの名前。 データタイプ：文字列 | | additionalDeployables.deployable_name | アレイ additionalDeployables 指定されている場合は必須です。構成データをエクスポートする非プライマリ展開可能項目の名前。 データタイプ：文字列 | | appName | 必須です。構成データをエクスポートするアプリケーションの名前。 データタイプ：文字列 | | args | カスタム引数のキーと値のペアを含む JSON オブジェクト。 データタイプ: オブジェクト | | dataFormat | エクスポートされたデータの出力形式。 有効な値 (大文字と小文字を区別): * ini * json * properties * raw (データは文字列形式で返されます) * xml * YAML データタイプ：文字列 デフォルト:json | | deployableName | 必須です。構成データをエクスポートする展開可能項目の名前。 データタイプ：文字列 | | exporterName | 必須です。スナップショットデータのエクスポートに使用するエクスポーターの名前。エクスポーターは実装者にとってカスタムです。カスタムエクスポーターの作成の詳細については、「 [カスタムエクスポーターの作成](https://www.servicenow.com/docs/access?context=cdm-exporter-create-custom&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 データタイプ：文字列 | | エクスポートの制限 | データのエクスポート時にエンドポイントがスナップショットを検証するかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 データタイプ：ブーリアン デフォルト値：false | | snapshotName | エクスポートするスナップショットの名前。これは、 deployableName または additionalDeployables.deployable_name パラメーターで指定された展開可能項目に関連付けられたスナップショット名の 1 つにすることができます。 デフォルト:エンドポイントは最新の公開済みスナップショットをエクスポートします。公開されたスナップショットがない場合、システムは「展開可能項目「{0}」の最新の公開済みスナップショットを見つけることができませんでした」というエラーをスローします | [表 : 56. クエリパラメーター] {#apps-POST-deploy-exports__entry__28} | 名前 | 説明 | |-|-| | なし | | [表 : 57. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-deploy-exports__entry__32}{#apps-POST-deploy-exports__accept-JSON-only-entry-RESTAPI}{#apps-POST-deploy-exports__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 58. 要求ヘッダー] {#apps-POST-deploy-exports__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 59. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-deploy-exports__entry__42}{#apps-POST-deploy-exports__entry-200-status-code}{#apps-POST-deploy-exports__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 考えられるエラーメッセージ: * エラー:必須パラメーター「appName」がありません * エラー:エクスポート要求を作成するために必要な権限がユーザーにありません * エラー:無効なブール値 (\)。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 60. ステータスコード] ### 応答本文のパラメーター {#apps-POST-deploy-exports__entry__50}{#apps-POST-deploy-exports__cdm_apps-stat-error}{#apps-POST-deploy-exports__cdm_apps-stat-error_detail-row}{#apps-POST-deploy-exports__cdm_apps-stat-error_messaage-row} | 名前 | 説明 | |-|-| | エラー | 発生したエラーの詳細。 データタイプ：アレイ "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | export_id | エクスポート要求の一意の識別子。エクスポート要求の現在のステータスを確認するために [CdmApplicationsApi - GET /sn_cdm/applications/deployables/exports/{export_id}/status](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-deploy-exports-status "指定された構成データエクスポート要求の現在のステータスを返します。") エンドポイントを呼び出すときに、この ID を使用します。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | [ ] ### cURL 要求 次の例では、exporter = exporter-1-primary_deployable を使用して、アプリケーション名 = TestAppA、展開可能項目名 = DEP の構成データのエクスポートを要求します。 curl "http://instance.servicenow.com/api/sn_cdm/applications/deployables/exports?appName=TestAppA&args=%7B%22arg_A_required%22%20%3A%20%22value%20A%22%7D&exporterName=exporter-1-primary_deployable&deployableName=DEP1" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'username':'password' エクスポート要求の一意の識別子を返します。 { "result": { "export_id": "64b5f79f5379301096edddeeff7b12eb" } } ## CdmApplicationsApi - POST /sn_cdm/applications/shared_components {#ariaid-title12} 指定された共有コンポーネントを、指定された変更セット内のアプリケーションに関連付けます。 このエンドポイントにアクセスするには、CDM admin ロールが必要です。 注: 指定する共有コンポーネントには、関連する公開バージョン (スナップショット) が必要です。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/shared_components デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-shared_components__entry__2}{#apps-POST-shared_components__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 61. パスパラメーター] {#apps-POST-shared_components__entry__6}{#apps-POST-shared_components__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | appName | 必須です。共有コンポーネントに関連付けるアプリケーションの名前。 データタイプ：文字列 | | changesetNumber | 必須です。コンポーネントに関連付けられた変更セットの一意の識別子。 データタイプ：文字列 | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。 データタイプ：アレイ デフォルト:エンドポイントによって決定されたすべてのフィールド | | sharedComponentName | 必須です。指定されたアプリケーションに関連付ける共有コンポーネントの名前。 データタイプ：文字列 テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | sharedLibraryName | 必須です。コンポーネントを作成する共有ライブラリの名前。共有ライブラリには、次のように定義された次のフィールドが必要です。 * ステータス = アクティブ * 利用可能 = true * タイプ = shared_library データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 62. クエリパラメーター] {#apps-POST-shared_components__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 63. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-shared_components__entry__22}{#apps-POST-shared_components__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 64. 要求ヘッダー] {#apps-POST-shared_components__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 65. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-shared_components__entry__30}{#apps-POST-shared_components__entry-200-status-code}{#apps-POST-shared_components__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。渡された変更セットは存在しません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 66. ステータスコード] ### 応答本文のパラメーター 応答フィールドは、要求の returnFields パラメーターで指定されたフィールドによって異なります。以下では、より重要なフィールドのいくつかについて説明します。 {#apps-POST-shared_components__entry__38}{#apps-POST-shared_components__changeset-node-editor-entry}{#apps-POST-shared_components__changeset_link-node-editor-entry}{#apps-POST-shared_components__changeset_value-node-editor-entry}{#apps-POST-shared_components__cdm_apps-error-entry}{#apps-POST-shared_components__cdm_apps-error_detail-entry}{#apps-POST-shared_components__cdm_apps-error_message-entry}{#apps-POST-shared_components__cdm_dep-sys_created_by-row}{#apps-POST-shared_components__cdm_deps-sys_created_on-row}{#apps-POST-shared_components__sys_id-node-editor-entry}{#apps-POST-shared_components__cdm_dep-sys_updated_by-row}{#apps-POST-shared_components__cdm_dep-sys_updated_on-row} | 名前 | 説明 | |-|-| | changeset_id | ノードに関連付けられた変更セットレコードの詳細。 データタイプ: オブジェクト "changeset_id": { "link": "String", "value": "String" } | | changeset_id.link | Table REST API を使用してこの変更セットレコードをクエリするための呼び出し構文。 データタイプ：文字列 | | changeset_id.value | 変更セットレコードの一意の識別子。 データタイプ：文字列 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | description | CDM ノードの説明。 データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合のみ返されます。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 発生したエラーの詳細。 データタイプ：文字列 | | error.message | エラーの概要を示すメッセージ。 データタイプ：文字列 | | linked_to | 共有コンポーネントに関連付けられているメインノードの ID。 データタイプ：文字列 | | linked_to_version | ノードに関連付けられた CDM スナップショットレコードの詳細。 データタイプ: オブジェクト "linked_to_version": { "link": "String", "value": "String" } | | linked_to_version.link | Table REST API を使用してこのバージョンレコードをクエリするための呼び出し構文。 データタイプ：文字列 | | linked_to_version.value | バージョンレコードのSys_id。 データタイプ：文字列 | | メイン | 関連付けられたスナップショットが公開されたかどうかを示すフラグ。 有効な値： * true:スナップショットが公開されました。 * false:スナップショットは公開されませんでした。 | | main_id | 新しく作成されたメインノードの一意の ID。 データタイプ：文字列 | | main_id_encoded | 新しく作成されたメインノードのエンコードされた ID。 データタイプ：文字列 | | name | CDM ノードの名前。 データタイプ：文字列 | | node | 共有コンポーネントノードのSys_id。 データタイプ：文字列 | | node_path | 共有コンポーネントの追加時に作成された新しいリンクノードへのパス。 データタイプ：文字列 | | status | ノードのステータス。 可能な値:新規 データタイプ：文字列 | | sys_created_by | CDM ノードを作成するユーザーのユーザー名。たとえば、able.tuter です。 データタイプ：文字列 | | sys_created_on | CDM ノードが作成された日時。 形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | sys_id | ノードのSys_id。 データタイプ：文字列 テーブル:CDM ノード \[sn_cdm_node\] | | sys_updated_by | CDM ノードを最後に更新したユーザーのユーザー名。たとえば、able.tuter です。 データタイプ：文字列 | | sys_updated_on | CDM ノードが最後に更新された日時。 形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | type | ノードタイプ。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、このエンドポイントを呼び出して、アプリケーション「App1」を「Chset-20」変更セット内の共有ライブラリ「OracleG-Library-10」の下にある共有コンポーネント「paymentService-V1.1」に関連付ける方法を示しています。 curl "https://instance.servicenow.com/api/sn_cdm/applications/shared_components?appName=App1&changesetNumber=Chset-20&sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": { "changeset_id": { "value": "74b7ff6fc33711100c257e2cc840dd6b", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/74b7ff6fc33711100c257e2cc840dd6b" }, "node_path": "!,0!,1!/D", "description": null, "sys_updated_on": "2022-12-22 17:07:29", "type": "sn_cdm_node_linked_shared_component", "sys_class_name": "sn_cdm_node", "sys_id": "ff8b37ebc3b711100c257e2cc840ddba", "sys_updated_by": "admin", "previous_version": null, "sys_created_on": "2022-12-22 17:07:29", "value": null, "effective_from": null, "linked_to": "210", "sys_created_by": "admin", "restricted_to": null, "linked_to_version": { "value": "581fc3e9c3b311100c257e2cc840dd17", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_snapshot/581fc3e9c3b311100c257e2cc840dd17" }, "level": "2", "conflict_type": null, "main_id": "483", "effective_to": null, "secure_value": null, "node_classifier": "/application/components", "main_id_encoded": "/D", "name": "LIB2_C", "position": null, "reason_for_conflict": null, "system_folder": false, "status": "new", "conflict": false } } ## CdmApplicationsApi:POST /sn_cdm/applications/uploads/components {#ariaid-title13} 指定されたアプリケーションの system components フォルダー内の特定のコンポーネントに渡された構成データをアップロードする要求を送信します。 このエンドポイントは、アップロード要求の ID を返します。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 注: デフォルトのアップロードコンテンツの最大サイズは 2 MB です。このデフォルトを変更するには、プロパティ sn_cdm.max_allowed_upload_file_size を更新します。 次の画像は、 ServiceNow DevOps コンフィグ UI を参照してコンポーネント構成データがアップロードされる場所の例を示しています。コンポーネントが dbComponent で、アプリケーションが paymentSvc であると仮定します。 注: このアップロード方法は、ノードの変更には使用できません。別の [CdmApplicationsApi:POST sn_cdm/applications/uploads/components/file](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-uploads_components_file "構成データモデル (CDM) の一部としてファイルをコンポーネントフォルダーにアップロードします。") 方法を使用してノードを変更します。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/uploads/components デフォルト URL: /api/sn_cdm/applications/uploads/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads-components__entry__2}{#apps-POST-uploads-components__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 67. パスパラメーター] {#apps-POST-uploads-components__id_plp_1vh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-appName-row}{#apps-POST-uploads-components__cdm_apps-autoCommit-row}{#apps-POST-uploads-components__cdm_apps-autoDelete-row}{#apps-POST-uploads-components__cdm_apps-autoValidate-row}{#apps-POST-uploads-components__cdm_apps-changesetNumber-row}{#apps-POST-uploads-components__cdm_apps-dataFormat-row}{#apps-POST-uploads-components__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-components__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-components__cdm_apps-deleteRedundantOverrides-row}{#apps-POST-uploads-components__cdm_apps-fileName-row}{#apps-POST-uploads-components__cdm_apps-fileNodeName-row}{#apps-POST-uploads-components__cdm_apps-identifierKeys-row}{#apps-POST-uploads-components__cdm_apps-ignoreAttributes-row}{#apps-POST-uploads-components__cdm_apps-namePath-row}{#apps-POST-uploads-components__cdm_apps-sharedLibraryName-row} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoDelete | アップロードコンテンツの一部ではない既存のノードを、処理の完了後に削除するかどうかを示すフラグ。 有効な値： * true:既存のノードを自動的に削除します。 * false:既存のノードを自動的に削除しません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | dataFormat | 必須です。構成データの形式。 有効な値： * csv * ini * json * properties * 生 * xml * YAML データタイプ：文字列 | | dataFormatAttributes | dataFormatパラメーターが csv に設定されている場合にのみサポートされます。CSV データ形式を定義する属性。詳細については、「[Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 データタイプ: オブジェクト "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | データにヘッダー行が含まれているかどうかを示すフラグ。 有効な値： * true:データにはヘッダー行が含まれています。データの最初の行がヘッダー行と見なされます。 * false:データにヘッダー行が含まれていません。dataFormatAttributes.headersパラメーターにヘッダー情報を渡す必要があります。 データタイプ：ブーリアン デフォルト値：false | | dataFormatAttributes.delimeter | データ内のフィールドを描写するために使用する文字。 データタイプ：文字列 デフォルト:カンマ "," | | dataFormatAttributes.headers | dataFormatAttributes.containsHeadersパラメーターが false の場合は必須です。ヘッダーを構成するデータのフィールド。これらのヘッダーは、JSON 形式の CDI のキー名に変換されます。ヘッダーの数は、レコードフィールドの数と一致する必要があります。 データタイプ：アレイ デフォルト:空のアレイ | | dataFormatAttributes.securedHeaders | 安全なフィールドであり、 CDM にアップロードされたデータで暗号化する必要があるデータ内のフィールド。保護されたヘッダーの名前は、ヘッダー属性またはデータファイル内のヘッダーの名前と一致する必要があります。これらのフィールドは、パスワード (双方向暗号化) タイプの列に格納されます。 注: フィールドは、この属性を使用してのみ保護できます。セキュリティで保護されたフィールドの保護を解除することはできません。 データタイプ：アレイ デフォルト:空のアレイ | | deleteRedundantOverrides | 冗長な値が存在する上書きを作成するかどうかを示すフラグ。 有効な値： * true:冗長な値が存在する場合、上書きは作成されません。 * false:冗長な値が存在する場合は、上書きを続行します。 デフォルト：true | | fileName | アップロードするファイルの名前。この名前は実際のファイル名とは異なるもので、ファイル拡張子を含めることができます。例:.txt/.scv/.jar。fileName 値は、ファイルのダウンロード時に適用されます。 データタイプ：文字列 | | ファイルのノード名 | ファイルノードの名前。このファイル名は、エクスポート時に構成データで使用されます。この名前にはファイル拡張子は不要で、ダウンロードにも影響しません。 データタイプ：文字列 | | identifierKeys | 同じノードを識別するために使用するアレイの子内のキーを示す名前のリスト。 たとえば、アップロードする場合: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] 次の既存モデルの場合: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] identifierKeys を [名前] に設定すると、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] それ以外の場合は、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] データタイプ：文字列のアレイ | | ignoreAttributes | 指定されたデータ形式が属性をサポートしているかどうかを示すフラグ (現在は XML のみ)。 有効な値： * true:指定されたデータ形式が属性をサポートしている場合、アップロード中に入力データの属性がスキップされます。 * false:指定されたデータ形式が属性をサポートしている場合、入力データの属性はすべてアップロードに含まれます。 {#apps-POST-uploads-components__ul_egn_4q4_1yb} データタイプ：ブーリアン デフォルト値：false | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | sharedLibraryName | 必須です。削除するコンポーネントが配置されている共有ライブラリの名前。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 68. クエリパラメーター] {#apps-POST-uploads-components__id_plp_1vh_psb} {#apps-POST-uploads-components__id_lx4_bvh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-var_up_data-entry} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。これは、クエリパラメーターの dataFormat パラメーターで定義された形式の任意のデータにすることができます。 | [表 : 69. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads-components__id_lx4_bvh_psb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-uploads-components__id_trg_k25_2wb__entry__2}{#apps-POST-uploads-components__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。サポートされているタイプ: text/plain および application/x-www-form-urlencoded。 デフォルト： text/plain | [表 : 70. 要求ヘッダー] {#apps-POST-uploads-components__id_trg_k25_2wb} {#apps-POST-uploads-components__entry__54} | ヘッダー | 説明 | |-|-| | なし | | [表 : 71. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads-components__id_vvq_4wh_psb__entry__2}{#apps-POST-uploads-components__entry-200-status-code}{#apps-POST-uploads-components__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads-components__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 72. ステータスコード] {#apps-POST-uploads-components__id_vvq_4wh_psb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads-components__id_b4z_nwh_psb__entry__2}{#apps-POST-uploads-components__cdm_apps-stat-error}{#apps-POST-uploads-components__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads-components__id_b4z_nwh_psb} ### cURL 要求 次の例は、アプリケーションDemo_App1631126164773のアップロード要求を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&autoValidate=false&autoDelete=true" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "{ \"dbIPAddress\": \"10.10.10.110\", \"dbPort\": \"8080\", \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\", \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\ "}" \ --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:POST sn_cdm/applications/uploads/components/file {#ariaid-title14} 構成データモデル (CDM) の一部としてファイルをコンポーネントフォルダーにアップロードします。 このメソッドを使用して、コンポーネントファイルノードにアップロードします。 ### URL 形式 バージョニングされた URL: POST /api/sn_cdm/{api_version}/applications/uploads/components/file デフォルト URL: POST /api/sn_cdm/applications/uploads/components/file 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads_components_file__table_rgl_tbt_byb__entry__2}{#apps-POST-uploads_components_file__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 73. パスパラメーター] {#apps-POST-uploads_components_file__table_rgl_tbt_byb} {#apps-POST-uploads_components_file__cdm_app-upload_query_parms-table__entry__2}{#apps-POST-uploads_components_file__publish_option-changeset-entry} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | fileName | アップロードするファイルの名前。この名前は実際のファイル名とは異なるもので、ファイル拡張子を含めることができます。例:.txt/.scv/.jar。fileName 値は、ファイルのダウンロード時に適用されます。 データタイプ：文字列 | | ファイルのノード名 | ファイルノードの名前。このファイル名は、エクスポート時に構成データで使用されます。この名前にはファイル拡張子は不要で、ダウンロードにも影響しません。 データタイプ：文字列 | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads_components_file__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | 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 注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。 | [表 : 74. クエリパラメーター] {#apps-POST-uploads_components_file__cdm_app-upload_query_parms-table} {#apps-POST-uploads_components_file__table_j22_fgm_2yb__entry__2} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。デフォルトでは、アップロードするファイルサイズは 5 MB に制限されています。アップロードファイルのサイズとタイプを調整する方法については、こちらを参照してください [Now Support article](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB0718101). データタイプ:文字列/ストリーム | [表 : 75. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads_components_file__table_j22_fgm_2yb} ### ヘッダー {#apps-POST-uploads_components_file__section_cxs_mvr_byb} {#apps-POST-uploads_components_file__table_bd2_pqs_byb__entry__2}{#apps-POST-uploads_components_file__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | アップロードするファイルのデータタイプ。サポートされているタイプ: application/zip、 text/plain、 application/json。 デフォルト： application/json | [表 : 76. 要求ヘッダー] {#apps-POST-uploads_components_file__table_bd2_pqs_byb} {#apps-POST-uploads_components_file__table_exs_mvr_byb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 77. 応答ヘッダー] {#apps-POST-uploads_components_file__table_exs_mvr_byb} ### ステータスコード {#apps-POST-uploads_components_file__section_mtw_2vr_byb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads_components_file__id_cdq_fft_byb__entry__2}{#apps-POST-uploads_components_file__entry-200-status-code}{#apps-POST-uploads_components_file__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads_components_file__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 78. ステータスコード] {#apps-POST-uploads_components_file__id_cdq_fft_byb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads_components_file__section_sbq_2bx_1yb} {#apps-POST-uploads_components_file__id_af3_kft_byb__entry__2}{#apps-POST-uploads_components_file__cdm_apps-stat-error}{#apps-POST-uploads_components_file__cdm_apps-stat-error_detail-row}{#apps-POST-uploads_components_file__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads_components_file__cdm_apps-stat-error_status-row}{#apps-POST-uploads_components_file__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads_components_file__id_af3_kft_byb} ### cURL 要求 次の例は、コンテンツをテキストファイルにアップロードする方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/file?autoValidate=true&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "This is sample content that will be uploaded to a plain text file."\ --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Could not find active application with name: 'testApp' of type application", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:POST /sn_cdm/applications/uploads/components/vars {#ariaid-title15} 指定されたアプリケーションの system components フォルダー内の vars フォルダーに渡された構成データをアップロードする要求を送信します。 次の画像は、 ServiceNow DevOps コンフィグ ワークスペース UI を参照してコンポーネントの変数構成データがアップロードされる場所の例を示しています。アプリケーションが paymentSvc であると仮定します。 注: デフォルトのアップロードコンテンツの最大サイズは 2 MB です。このデフォルトを変更するには、プロパティ sn_cdm.max_allowed_upload_file_size を更新します。 ### URL 形式 {#apps-POST-uploads-components-var__section_xgv_syh_psb} バージョニングされた URL: /api/sn_cdm/{api_version}/applications/uploads/components/vars デフォルト URL: /api/sn_cdm/applications/uploads/components/vars 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads-components-var__entry__2}{#apps-POST-uploads-components-var__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 79. パスパラメーター] {#apps-POST-uploads-components-var__id_ey4_w13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-dataFormat-row} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoDelete | アップロードコンテンツの一部ではない既存のノードを、処理の完了後に削除するかどうかを示すフラグ。 有効な値： * true:既存のノードを自動的に削除します。 * false:既存のノードを自動的に削除しません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | dataFormat | 必須です。構成データの形式。 有効な値： * ini * json * properties * 生 * xml * YAML データタイプ：文字列 | | deleteRedundantOverrides | 冗長な値が存在する上書きを作成するかどうかを示すフラグ。 有効な値： * true:冗長な値が存在する場合、上書きは作成されません。 * false:冗長な値が存在する場合は、上書きを続行します。 デフォルト：true | | fileName | アップロードするファイルの名前。この名前は実際のファイル名とは異なるもので、ファイル拡張子を含めることができます。例:.txt/.scv/.jar。fileName 値は、ファイルのダウンロード時に適用されます。 データタイプ：文字列 | | ファイルのノード名 | ファイルノードの名前。このファイル名は、エクスポート時に構成データで使用されます。この名前にはファイル拡張子は不要で、ダウンロードにも影響しません。 データタイプ：文字列 | | identifierKeys | 同じノードを識別するために使用するアレイの子内のキーを示す名前のリスト。 たとえば、アップロードする場合: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] 次の既存モデルの場合: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] identifierKeys を [名前] に設定すると、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] それ以外の場合は、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] データタイプ：文字列のアレイ | | ignoreAttributes | 指定されたデータ形式が属性をサポートしているかどうかを示すフラグ (現在は XML のみ)。 有効な値： * true:指定されたデータ形式が属性をサポートしている場合、アップロード中に入力データの属性がスキップされます。 * false:指定されたデータ形式が属性をサポートしている場合、入力データの属性はすべてアップロードに含まれます。 {#apps-POST-uploads-components-var__ul_egn_4q4_1yb} データタイプ：ブーリアン デフォルト値：false | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-components-var__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | sharedLibraryName | 必須です。削除するコンポーネントが配置されている共有ライブラリの名前。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 80. クエリパラメーター] {#apps-POST-uploads-components-var__id_ey4_w13_psb} {#apps-POST-uploads-components-var__id_x4h_y13_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-var_up_data-entry} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。これは、クエリパラメーターの dataFormat パラメーターで定義された形式の任意のデータにすることができます。 | [表 : 81. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads-components-var__id_x4h_y13_psb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-uploads-components-var__id_cvs_bmb_fwb__entry__2}{#apps-POST-uploads-components-var__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。サポートされているタイプ: text/plain および application/x-www-form-urlencoded。 デフォルト： text/plain | [表 : 82. 要求ヘッダー] {#apps-POST-uploads-components-var__id_cvs_bmb_fwb} {#apps-POST-uploads-components-var__entry__44} | ヘッダー | 説明 | |-|-| | なし | | [表 : 83. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads-components-var__id_dqr_z13_psb__entry__2}{#apps-POST-uploads-components-var__entry-200-status-code}{#apps-POST-uploads-components-var__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads-components-var__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 84. ステータスコード] {#apps-POST-uploads-components-var__id_dqr_z13_psb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads-components-var__id_pcq_1b3_psb__entry__2}{#apps-POST-uploads-components-var__cdm_apps-stat-error}{#apps-POST-uploads-components-var__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-components-var__cdm_apps-stat-error_status-row}{#apps-POST-uploads-components-var__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads-components-var__id_pcq_1b3_psb} ### cURL 要求 次の例は、アプリケーションDemo_App1631126164773の変数アップロード要求を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/components/vars?changesetNumber=Chset-102&autoValidate=false&autoDelete=true&publishOption=publish_none&appName=Demo_App1631126164773&namePath=%2FSettings%2FdbSettings&autoCommit=false&dataFormat=json" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "{ \"dbSettings\": { \"dbIPAddress\": \"10.10.10.110\", \"dbPort\": \"8080\", \"dbConnectionString\": \"username:password server1.xyz.com:8080 dbName_payments\", \"dbConnectionStringBackup\": \"username:password server2.xyz.com dbName_payments_backup\" } }" --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "d21f71f45322301096eccceaff7b1ce3" } } // Error response. Payload is too large. { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi - POST /sn_cdm/applications/uploads/collections {#ariaid-title16} 指定されたアプリケーションの \[システムコレクション\] フォルダー内の特定のコレクションに渡された構成データをアップロードする要求を送信します。 このエンドポイントは、アップロード要求の ID を返します。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 注: デフォルトのアップロードコンテンツの最大サイズは 2 MB です。このデフォルトを変更するには、プロパティ sn_cdm.max_allowed_upload_file_size を更新します。 次の画像は、 ServiceNow DevOps コンフィグ ワークスペース UI を参照して構成データがアップロードされる場所の例を示しています。コレクションが db0Release1.0 で、アプリケーションが paymentSvc であると仮定します。 注: このアップロード方法は、ノードの変更には使用できません。別の [CdmApplicationsApi:POST /sn_cdm/applications/uploads/collections/file](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-uploads_collections_file "構成データモデル (CDM) の collections フォルダーにファイルをアップロードします。") 方法を使用してノードを変更します。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/uploads/collections デフォルト URL: /api/sn_cdm/applications/uploads/collections 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads-collections__entry__2}{#apps-POST-uploads-collections__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 85. パスパラメーター] {#apps-POST-uploads-collections__id_ycw_c33_psb__entry__2}{#apps-POST-uploads-collections__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-collections__cdm_app-dataFormAtt_securedHeaders-entry} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoDelete | アップロードコンテンツの一部ではない既存のノードを、処理の完了後に削除するかどうかを示すフラグ。 有効な値： * true:既存のノードを自動的に削除します。 * false:既存のノードを自動的に削除しません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | collectionName | 必須です。アップロードされたペイロードを格納するコレクションの名前。 注: 指定された namePath がこのコレクションの下に存在しない場合、システムはこのコレクションの下にコンポーネントを自動的に作成し、構成コンテンツをアップロードします。たとえば、コレクション `collA` をアップロードする場合、パス `が compA/comp/compC` の場合、データは `/collA/collections/compa/compB/compC` の下にアップロードされます。 `compA` は存在しても `compB` と `compC` が存在しない場合、エンドポイントはこれらのコンポーネントを作成し、`compC` の下にデータをアップロードします。 データタイプ：文字列 | | dataFormat | 必須です。構成データの形式。 有効な値： * csv * ini * json * properties * 生 * xml * YAML データタイプ：文字列 | | dataFormatAttributes | dataFormatパラメーターが csv に設定されている場合にのみサポートされます。CSV データ形式を定義する属性。詳細については、「[Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 データタイプ: オブジェクト "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | データにヘッダー行が含まれているかどうかを示すフラグ。 有効な値： * true:データにはヘッダー行が含まれています。データの最初の行がヘッダー行と見なされます。 * false:データにヘッダー行が含まれていません。dataFormatAttributes.headersパラメーターにヘッダー情報を渡す必要があります。 データタイプ：ブーリアン デフォルト値：false | | dataFormatAttributes.delimeter | データ内のフィールドを描写するために使用する文字。 データタイプ：文字列 デフォルト:カンマ "," | | dataFormatAttributes.headers | dataFormatAttributes.containsHeadersパラメーターが false の場合は必須です。ヘッダーを構成するデータのフィールド。これらのヘッダーは、JSON 形式の CDI のキー名に変換されます。ヘッダーの数は、レコードフィールドの数と一致する必要があります。 データタイプ：アレイ デフォルト:空のアレイ | | dataFormatAttributes.securedHeaders | 安全なフィールドであり、 CDM にアップロードされたデータで暗号化する必要があるデータ内のフィールド。保護されたヘッダーの名前は、ヘッダー属性またはデータファイル内のヘッダーの名前と一致する必要があります。これらのフィールドは、パスワード (双方向暗号化) タイプの列に格納されます。 注: フィールドは、この属性を使用してのみ保護できます。セキュリティで保護されたフィールドの保護を解除することはできません。 データタイプ：アレイ デフォルト:空のアレイ | | deleteRedundantOverrides | 冗長な値が存在する上書きを作成するかどうかを示すフラグ。 有効な値： * true:冗長な値が存在する場合、上書きは作成されません。 * false:冗長な値が存在する場合は、上書きを続行します。 デフォルト：true | | ignoreAttributes | 指定されたデータ形式が属性をサポートしているかどうかを示すフラグ (現在は XML のみ)。 有効な値： * true:指定されたデータ形式が属性をサポートしている場合、アップロード中に入力データの属性がスキップされます。 * false:指定されたデータ形式が属性をサポートしている場合、入力データの属性はすべてアップロードに含まれます。 {#apps-POST-uploads-collections__ul_egn_4q4_1yb} データタイプ：ブーリアン デフォルト値：false | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-collections__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | [表 : 86. クエリパラメーター] {#apps-POST-uploads-collections__id_ycw_c33_psb} {#apps-POST-uploads-collections__id_afd_233_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-var_up_data-entry} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。これは、クエリパラメーターの dataFormat パラメーターで定義された形式の任意のデータにすることができます。 | [表 : 87. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads-collections__id_afd_233_psb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-uploads-collections__id_h4r_fmb_fwb__entry__2}{#apps-POST-uploads-collections__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。サポートされているタイプ: text/plain および application/x-www-form-urlencoded。 デフォルト： text/plain | [表 : 88. 要求ヘッダー] {#apps-POST-uploads-collections__id_h4r_fmb_fwb} {#apps-POST-uploads-collections__entry__48} | ヘッダー | 説明 | |-|-| | なし | | [表 : 89. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads-collections__id_szz_f33_psb__entry__2}{#apps-POST-uploads-collections__entry-200-status-code}{#apps-POST-uploads-collections__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads-collections__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 90. ステータスコード] {#apps-POST-uploads-collections__id_szz_f33_psb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads-collections__id_i55_g33_psb__entry__2}{#apps-POST-uploads-collections__cdm_apps-stat-error}{#apps-POST-uploads-collections__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-collections__cdm_apps-stat-error_status-row}{#apps-POST-uploads-collections__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads-collections__id_i55_g33_psb} ### cURL 要求 この例では、JSON 形式の dbSettings 設定日をアプリケーションDemo_App1631126164773の collections フォルダーにアップロードする方法を示します。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections?dataFormat=json&autoValidate=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&autoDelete=true&namePath=%2FSettings%2FdbSettings&collectionName=release-1.0&autoCommit=false&publishOption=publish_none" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "{ \"dbSettings\": { \"dbIPAddress\": \"10.10.10.110\", \"dbPort\": \"8080\", \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\", \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\" } }" \ --user 'username':'password' この呼び出しに対する可能な応答 (成功とエラーの両方) を次に示します。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:POST /sn_cdm/applications/uploads/collections/file {#ariaid-title17} 構成データモデル (CDM) の collections フォルダーにファイルをアップロードします。 ### URL 形式 {#apps-POST-uploads_collections_file__section_okl_mmr_byb} バージョニングされた URL: POST /api/sn_cdm/{api_version}/applications/uploads/collections/file デフォルト URL: POST /api/sn_cdm/applications/uploads/collections/file 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads_collections_file__section_elv_jht_byb} {#apps-POST-uploads_collections_file__table_rgl_tbt_byb__entry__2}{#apps-POST-uploads_collections_file__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 91. パスパラメーター] {#apps-POST-uploads_collections_file__table_rgl_tbt_byb} {#apps-POST-uploads_collections_file__cdm_app-upload_query_parms-table__entry__2}{#apps-POST-uploads_collections_file__publish_option-changeset-entry} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | collectionName | 必須です。アップロードされたペイロードを格納するコレクションの名前。 注: 指定された `namePath` がこのコレクションの下に存在しない場合、システムはこのコレクションの下にコンポーネントを自動的に作成し、構成コンテンツをアップロードします。たとえば、コレクション `collA` をアップロードする場合、パス `が compA/comp/compC` の場合、データは `/collA/collections/compa/compB/compC` の下にアップロードされます。`compA` は存在しても `compB` と `compC` が存在しない場合、エンドポイントはこれらのコンポーネントを作成し、`compC` の下にデータをアップロードします。 データタイプ：文字列 | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | fileName | アップロードするファイルの名前。この名前は実際のファイル名とは異なるもので、ファイル拡張子を含めることができます。例:.txt/.scv/.jar。fileName 値は、ファイルのダウンロード時に適用されます。 データタイプ：文字列 | | ファイルのノード名 | ファイルノードの名前。このファイル名は、エクスポート時に構成データで使用されます。この名前にはファイル拡張子は不要で、ダウンロードにも影響しません。 データタイプ：文字列 | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads_collections_file__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | 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 注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。 | [表 : 92. クエリパラメーター] {#apps-POST-uploads_collections_file__cdm_app-upload_query_parms-table} {#apps-POST-uploads_collections_file__table_j22_fgm_2yb__entry__2} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。デフォルトでは、アップロードするファイルサイズは 5 MB に制限されています。アップロードファイルのサイズとタイプを調整する方法については、こちらを参照してください [Now Support article](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB0718101). データタイプ:文字列/ストリーム | [表 : 93. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads_collections_file__table_j22_fgm_2yb} ### ヘッダー {#apps-POST-uploads_collections_file__table_enr_pqs_byb__entry__2}{#apps-POST-uploads_collections_file__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | コンテンツ アップロードするファイルのタイプ。例:application/zip、text/plain、application/json。 | [表 : 94. 要求ヘッダー] {#apps-POST-uploads_collections_file__table_enr_pqs_byb} {#apps-POST-uploads_collections_file__entry__36} | ヘッダー | 説明 | |-|-| | なし | | [表 : 95. 応答ヘッダー] ### ステータスコード {#apps-POST-uploads_collections_file__section_mtw_2vr_byb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads_collections_file__id_cdq_fft_byb__entry__2}{#apps-POST-uploads_collections_file__entry-200-status-code}{#apps-POST-uploads_collections_file__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads_collections_file__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 96. ステータスコード] {#apps-POST-uploads_collections_file__id_cdq_fft_byb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads_collections_file__section_fft_zht_byb} {#apps-POST-uploads_collections_file__table_gft_zht_byb__entry__2}{#apps-POST-uploads_collections_file__cdm_apps-stat-error}{#apps-POST-uploads_collections_file__cdm_apps-stat-error_detail-row}{#apps-POST-uploads_collections_file__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads_collections_file__cdm_apps-stat-error_status-row}{#apps-POST-uploads_collections_file__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads_collections_file__table_gft_zht_byb} ### cURL 要求 次の呼び出しは、プレーンテキストファイルを CDM コレクションフォルダーにアップロードします。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/collections/file?autoValidate=true&collectionName=collA&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "This is sample content that will be uploaded to a plain text file."\ --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Could not find active application with name: 'testApp' of type application", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:POST /sn_cdm/applications/uploads/deployables {#ariaid-title18} 指定されたアプリケーションの deployables システムフォルダー内にある特定の展開可能項目の構成コンテンツをアップロードする要求を送信します。 このエンドポイントは、アップロード要求の ID を返します。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 注: デフォルトのアップロードコンテンツの最大サイズは 2 MB です。このデフォルトを変更するには、プロパティ sn_cdm.max_allowed_upload_file_size を更新します。 次の画像は、 ServiceNow DevOps コンフィグ UI を参照して展開可能構成データがアップロードされる場所の例を示しています。展開可能項目が Development_1 で、アプリケーションが paymentSvc であると仮定します。 注: このアップロード方法は、ノードの変更には使用できません。別の [CdmApplicationsApi:POST /sn_cdm/applications/uploads/deployables/file](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-POST-uploads_deployables_file "構成データモデル (CDM) の deployables フォルダーにファイルをアップロードします。") 方法を使用してノードを変更します。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/uploads/deployables デフォルト URL: /api/sn_cdm/applications/uploads/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads-deployables__entry__2}{#apps-POST-uploads-deployables__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 97. パスパラメーター] {#apps-POST-uploads-deployables__entry__6}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_containsHeaders-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_delimeter-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_headers-entry}{#apps-POST-uploads-deployables__cdm_app-dataFormAtt_securedHeaders-entry}{#apps-POST-uploads-deployables__publish_option-changeset-entry} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoDelete | アップロードコンテンツの一部ではない既存のノードを、処理の完了後に削除するかどうかを示すフラグ。 有効な値： * true:既存のノードを自動的に削除します。 * false:既存のノードを自動的に削除しません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | dataFormat | 必須です。構成データの形式。 有効な値： * csv * ini * json * properties * 生 * xml * YAML データタイプ：文字列 | | dataFormatAttributes | dataFormatパラメーターが csv に設定されている場合にのみサポートされます。CSV データ形式を定義する属性。詳細については、「[Parsing of CSV files in CDM](https://www.servicenow.com/docs/access?context=cdm-parsing-csv-file&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 データタイプ: オブジェクト "dataFormatAttributes" { "containsHeader": Boolean, "delimeter": "String" "headers": [Array], "securedHeaders": [Array] } | | dataFormatAttributes.containsHeaders | データにヘッダー行が含まれているかどうかを示すフラグ。 有効な値： * true:データにはヘッダー行が含まれています。データの最初の行がヘッダー行と見なされます。 * false:データにヘッダー行が含まれていません。dataFormatAttributes.headersパラメーターにヘッダー情報を渡す必要があります。 データタイプ：ブーリアン デフォルト値：false | | dataFormatAttributes.delimeter | データ内のフィールドを描写するために使用する文字。 データタイプ：文字列 デフォルト:カンマ "," | | dataFormatAttributes.headers | dataFormatAttributes.containsHeadersパラメーターが false の場合は必須です。ヘッダーを構成するデータのフィールド。これらのヘッダーは、JSON 形式の CDI のキー名に変換されます。ヘッダーの数は、レコードフィールドの数と一致する必要があります。 データタイプ：アレイ デフォルト:空のアレイ | | dataFormatAttributes.securedHeaders | 安全なフィールドであり、 CDM にアップロードされたデータで暗号化する必要があるデータ内のフィールド。保護されたヘッダーの名前は、ヘッダー属性またはデータファイル内のヘッダーの名前と一致する必要があります。これらのフィールドは、パスワード (双方向暗号化) タイプの列に格納されます。 注: フィールドは、この属性を使用してのみ保護できます。セキュリティで保護されたフィールドの保護を解除することはできません。 データタイプ：アレイ デフォルト:空のアレイ | | deleteRedundantOverrides | 冗長な値が存在する上書きを作成するかどうかを示すフラグ。 有効な値： * true:冗長な値が存在する場合、上書きは作成されません。 * false:冗長な値が存在する場合は、上書きを続行します。 デフォルト：true | | deployableName | 必須です。アップロードされたペイロードを保存する展開可能項目の名前。 注: 指定された namePath がこの展開可能項目に存在しない場合、システムはこの展開可能項目の下にコンポーネントを自動的に作成し、構成コンテンツをアップロードします。 | | identifierKeys | 同じノードを識別するために使用するアレイの子内のキーを示す名前のリスト。 たとえば、アップロードする場合: [ {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] 次の既存モデルの場合: [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"} ] identifierKeys を [名前] に設定すると、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Sydney"}, {"name" : "Allan, "city" : "Paris"} ] それ以外の場合は、次の出力が生成されます。 [ {"name" : "Karen, "city" : "Manila"}, {"name" : "Allan, "city" : "Brussels"}, {"name" : "Allan, "city" : "Paris"}, {"name" : "Karen, "city" : "Sydney"} ] データタイプ：文字列のアレイ | | ignoreAttributes | 指定されたデータ形式が属性をサポートしているかどうかを示すフラグ (現在は XML のみ)。 有効な値： * true:指定されたデータ形式が属性をサポートしている場合、アップロード中に入力データの属性がスキップされます。 * false:指定されたデータ形式が属性をサポートしている場合、入力データの属性はすべてアップロードに含まれます。 {#apps-POST-uploads-deployables__ul_egn_4q4_1yb} データタイプ：ブーリアン デフォルト値：false | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads-deployables__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | 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 注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。 | [表 : 98. クエリパラメーター] {#apps-POST-uploads-deployables__id_njw_zv3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-var_up_data-entry} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。これは、クエリパラメーターの dataFormat パラメーターで定義された形式の任意のデータにすることができます。 | [表 : 99. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads-deployables__id_njw_zv3_psb} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-POST-uploads-deployables__id_ilq_dmb_fwb__entry__2}{#apps-POST-uploads-deployables__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。サポートされているタイプ: text/plain および application/x-www-form-urlencoded。 デフォルト： text/plain | [表 : 100. 要求ヘッダー] {#apps-POST-uploads-deployables__id_ilq_dmb_fwb} {#apps-POST-uploads-deployables__entry__52} | ヘッダー | 説明 | |-|-| | なし | | [表 : 101. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads-deployables__id_gty_cw3_psb__entry__2}{#apps-POST-uploads-deployables__entry-200-status-code}{#apps-POST-uploads-deployables__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads-deployables__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 102. ステータスコード] {#apps-POST-uploads-deployables__id_gty_cw3_psb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads-deployables__id_gcv_2w3_psb__entry__2}{#apps-POST-uploads-deployables__cdm_apps-stat-error}{#apps-POST-uploads-deployables__cdm_apps-stat-error_detail-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads-deployables__cdm_apps-stat-error_status-row}{#apps-POST-uploads-deployables__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads-deployables__id_gcv_2w3_psb} ### cURL 要求 次の例は、アプリケーションDemo_App1631126164773のアップロード要求を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables?deployableName=TST-1&autoValidate=false&dataFormat=json&autoDelete=false&changesetNumber=Chset-102&appName=Demo_App1631126164773&publishOption=publish_none&autoCommit=true&namePath=%2FSettings%2FdbSettings" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "{ \"dbIPAddress\": \"10.10.10.110\", \"dbPort\": \"8080\", \"dbConnectionString\": \"admin:admin server1.xyz.com:8080 dbName_payments\", \"dbConnectionStringBackup\": \"admin:admin server2.xyz.com dbName_payments_backup\" }" \ --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:POST /sn_cdm/applications/uploads/deployables/file {#ariaid-title19} 構成データモデル (CDM) の deployables フォルダーにファイルをアップロードします。 ### URL 形式 バージョニングされた URL: POST /api/sn_cdm/{api_version}/applications/uploads/deployables/file デフォルト URL: POST /api/sn_cdm/applications/uploads/deployables/file 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-POST-uploads_deployables_file__table_rgl_tbt_byb__entry__2}{#apps-POST-uploads_deployables_file__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 103. パスパラメーター] {#apps-POST-uploads_deployables_file__table_rgl_tbt_byb} {#apps-POST-uploads_deployables_file__cdm_app-upload_query_parms-table__entry__2}{#apps-POST-uploads_deployables_file__deployableName-policy-entry}{#apps-POST-uploads_deployables_file__publish_option-changeset-entry} | 名前 | 説明 | |-|-| | appName | 構成データに関連付けるアプリケーションの名前。このアプリケーションはアクティブステータスである必要があります。 データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。 有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。 データタイプ：ブーリアン デフォルト値：false | | autoValidate | コミット時に作成されたスナップショットが検証されているかどうかを示すフラグ。 有効な値： * true:スナップショットを検証します。 * false:スナップショットを検証しません。 注: このオプションは、 autoCommit パラメーターが true の場合にのみ使用できます。 データタイプ：ブーリアン デフォルト値：false | | changesetNumber | Chset-102 など、アプリケーションに関連付けられた [変更セット](https://www.servicenow.com/docs/access?context=cdm-changesets-version-control&version=australia&pubname=australia-it-service-management&ft:locale=en-US) を一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。 データタイプ：文字列 デフォルト:使用する変更セットを作成します。変更セットの詳細は、 [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") 結果の一部として返されます。 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | deployableName | 必須です。ポリシーをマッピングする CDM 展開可能項目の名前。 データタイプ：文字列 テーブル:CDM 展開可能項目 \[sn_cdm_deployable\] | | fileName | アップロードするファイルの名前。この名前は実際のファイル名とは異なるもので、ファイル拡張子を含めることができます。例:.txt/.scv/.jar。fileName 値は、ファイルのダウンロード時に適用されます。 データタイプ：文字列 | | ファイルのノード名 | ファイルノードの名前。このファイル名は、エクスポート時に構成データで使用されます。この名前にはファイル拡張子は不要で、ダウンロードにも影響しません。 データタイプ：文字列 | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。 次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#apps-POST-uploads_deployables_file__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。 データタイプ：文字列 | | 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 注: このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。 | [表 : 104. クエリパラメーター] {#apps-POST-uploads_deployables_file__cdm_app-upload_query_parms-table} {#apps-POST-uploads_deployables_file__table_j22_fgm_2yb__entry__2} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。デフォルトでは、アップロードするファイルサイズは 5 MB に制限されています。アップロードファイルのサイズとタイプを調整する方法については、こちらを参照してください [Now Support article](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB0718101). データタイプ:文字列/ストリーム | [表 : 105. 要求本文パラメーター (XML または JSON)] {#apps-POST-uploads_deployables_file__table_j22_fgm_2yb} ### ヘッダー {#apps-POST-uploads_deployables_file__section_cxs_mvr_byb} {#apps-POST-uploads_deployables_file__table_bd2_pqs_byb__entry__2}{#apps-POST-uploads_deployables_file__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | アップロードするファイルのデータタイプ。サポートされているタイプ: application/zip、 text/plain、 application/json。 デフォルト： application/json | [表 : 106. 要求ヘッダー] {#apps-POST-uploads_deployables_file__table_bd2_pqs_byb} {#apps-POST-uploads_deployables_file__table_exs_mvr_byb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 107. 応答ヘッダー] {#apps-POST-uploads_deployables_file__table_exs_mvr_byb} ### ステータスコード {#apps-POST-uploads_deployables_file__section_mtw_2vr_byb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-POST-uploads_deployables_file__id_cdq_fft_byb__entry__2}{#apps-POST-uploads_deployables_file__entry-200-status-code}{#apps-POST-uploads_deployables_file__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。 アップロード要求が却下されました。 考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#apps-POST-uploads_deployables_file__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 108. ステータスコード] {#apps-POST-uploads_deployables_file__id_cdq_fft_byb} ### 応答本文のパラメーター (JSON または XML) {#apps-POST-uploads_deployables_file__section_sbq_2bx_1yb} {#apps-POST-uploads_deployables_file__id_af3_kft_byb__entry__2}{#apps-POST-uploads_deployables_file__cdm_apps-stat-error}{#apps-POST-uploads_deployables_file__cdm_apps-stat-error_detail-row}{#apps-POST-uploads_deployables_file__cdm_apps-stat-error_messaage-row}{#apps-POST-uploads_deployables_file__cdm_apps-stat-error_status-row}{#apps-POST-uploads_deployables_file__cdm_apps-upload_id-row} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。 データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。 データタイプ：文字列 | | status | 要求のエラーステータス。 可能な値:失敗 データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用して [CdmApplicationsApi - GET /sn_cdm/applications/upload-status/{upload_id}](https://servicenow-prod.fluidtopics.net/Rm4xtCMIICj0MipG3DWvGg#apps-GET-upload-status "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。 データタイプ：文字列 | [ ] {#apps-POST-uploads_deployables_file__id_af3_kft_byb} ### cURL 要求 次の要求は、CDM アプリケーションの deployables フォルダーにプレーンテキストファイルをアップロードします。 curl "http://instance.servicenow.com/api/sn_cdm/applications/uploads/deployables/file?autoValidate=true&deployableName=depA&appName=testApp&namePath=testComponent%2FfilesFolder&fileName=testFileNodeName.txt&publishOption=publish_valid&changesetNumber=Chset-108&autoCommit=true&fileNodeName=testFile.txt" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:text/plain" \ --data "This is sample content that will be uploaded to a plain text file."\ --user 'username':'password' 次の返される結果は、この要求に対する成功した応答とエラー応答の両方を示しています。 // Successful completion of the upload request { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response. Payload is too large. { "error": { "message": "Could not find active application with name: 'testApp' of type application", "detail": "" }, "status": "failure" } ## CdmApplicationsApi:PUT /sn_cdm/applications/deployables {#ariaid-title20} 指定された変更セット内のアプリケーション内の指定された共有コンポーネントを更新します。 次のフィールドの更新を許可します。 * 名前 * 説明 * アプリケーションサービス\\ダイナミック CI グループ * 展開可能項目の識別子 {#apps-PUT-application_deployables__ul_dgk_lzh_qxb} このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/deployables デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-PUT-application_deployables__entry__2} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 109. パスパラメーター] {#apps-PUT-application_deployables__entry__6} | 名前 | 説明 | |-|-| | appName | 必須です。CDM アプリケーションの名前。 データタイプ：文字列 | | name | 必須です。CDM 展開可能項目の名前。 データタイプ：文字列 | | 新しい説明 | オプション。CDM 展開可能項目の説明。 データタイプ：文字列 | | 新しいサービス ID | オプション。目的のアプリケーションサービス/ダイナミック CI グループの ID。cURL 要求で、展開可能項目をサービスから切断するための `''` を指定します。 | | 新しい識別子 | オプション。展開可能項目の識別子。 データタイプ:選択肢 (開発/テスト/本番) | | newName | オプション。展開可能項目の新しい名前。 データタイプ：文字列 | | returnFields | オプション。応答の一部として返されるフィールドのカンマ区切りリスト。 | [表 : 110. クエリパラメーター] {#apps-PUT-application_deployables__entry__22} | 名前 | 説明 | |-|-| | なし | | [表 : 111. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-PUT-application_deployables__entry__26} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ:application/json | [表 : 112. 要求ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-PUT-application_deployables__entry__30} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 113. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#apps-PUT-application_deployables__entry__38} | 名前 | 説明 | |-|-| | sys_id | CDM 展開可能sys_Id。 | | name | CDM 展開可能項目の名前。 | | node | 展開可能ノードオブジェクト。 `{ 'value': '', 'link': 'http://localhost:8081/api/now/table/*'}` | | description | CDM 展開可能項目の説明。 | | 識別子 | 展開可能項目の識別子。 | | cmdb_ci | 展開可能項目に接続されているアプリサービスオブジェクト。 `{ 'value': '', 'link': 'http://localhost:8081/api/now/table/*'}` | | cmdb_app | CDM アプリケーションオブジェクト。 `{ 'value': '', 'link': 'http://localhost:8081/api/now/table/*'}` | | snapshot_version_counter | 展開可能項目に対して作成されたスナップショットの数。 | | cdi_count | この CDM 展開可能項目に含まれる CDI の数。 | | cdi_usage | CDI の使用率。 | | environment_type | 環境タイプ。可能な値： * 開発 * 本番 * テスト {#apps-PUT-application_deployables__ul_y2w_5c3_qxb} | | 状況 | アクティブまたは削除されたステータス . 可能な値： * アクティブ * 削除済み {#apps-PUT-application_deployables__ul_cth_wc3_qxb} | | sys_created_by | \ によって作成された CDM 展開可能項目。 | | sys_created_on | \ 形式の CDM 展開可能項目の作成タイムスタンプ。 | | sys_updated_by | CDM 展開可能項目は \ によって更新されました。 | | sys_updated_on | \ 形式のタイムスタンプによって更新された CDM 展開可能項目。 | [ ] ### cURL 要求 curl "http://localhost:8080/api/sn_cdm/applications/deployables?appName=testApp&name=Dep-1" \ --request PUT\ --header "Accept:application/json" \ --user 'cdm_admin':'password1!' 出力: { "result": { "identifier": "identiy1", "cmdb_ci": { "value": "f5b9e00b53901110a1d3ddeeff7b12b8", "link": "http://192.168.0.233:8080/api/now/table/cmdb_ci_service_auto/f5b9e00b53901110a1d3ddeeff7b12b8" }, "cdi_count": "3", "snapshot_version_counter": "1", "description": "cdcds", "sys_updated_on": "2022-07-27 13:40:13", "environment_type": "Test", "node": { "value": "30c00d4053015110a1d3ddeeff7b12bf", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_node/30c00d4053015110a1d3ddeeff7b12bf" }, "sys_id": "39b9e00b53901110a1d3ddeeff7b12b7", "sys_updated_by": "admin", "cdm_app": { "value": "62b517a953b70110a1d3ddeeff7b128c", "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" }, "sys_created_on": "2022-06-29 12:53:57", "cdi_usage": "0.03", "name": "Dep-2", "state": "active", "sys_created_by": "admin" } } ## CdmApplicationsApi:PUT /sn_cdm/applications/shared_components {#ariaid-title21} 指定された変更セット内のアプリケーション内の指定された共有コンポーネントを更新します。 このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 バージョニングされた URL: /api/sn_cdm/{api_version}/applications/shared_components デフォルト URL: /api/sn_cdm/applications/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#apps-PUT-shared_components__entry__2}{#apps-PUT-shared_components__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 114. パスパラメーター] {#apps-PUT-shared_components__entry__6}{#apps-PUT-shared_components__cdm_apps-returnFields-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。コンポーネントに関連付けられた変更セットの一意の識別子。 データタイプ：文字列 | | returnFields | 応答の一部として返されるフィールドのリスト。sys_id、sys_updated_by、ステータスなどのレコード列名を渡します。 データタイプ：アレイ デフォルト:エンドポイントによって決定されたすべてのフィールド | | sharedComponentName | 必須です。指定されたアプリケーションに関連付けられている共有コンポーネントの名前。 データタイプ：文字列 テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | sharedLibraryName | 必須です。コンポーネントが存在する共有ライブラリの名前。共有ライブラリには、次のように定義された次のフィールドが必要です。 * ステータス = アクティブ * 利用可能 = true * タイプ = shared_library データタイプ：文字列 テーブル:CDM アプリケーション \[sn_cdm_application\] | | version | 必須です。共有コンポーネントに関連付けられたバージョン名。 データタイプ：文字列 テーブル:CDM スナップショット \[sn_cdm_snapshot\] | [表 : 115. クエリパラメーター] {#apps-PUT-shared_components__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 116. 要求本文のパラメーター] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#apps-PUT-shared_components__entry__22}{#apps-PUT-shared_components__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 117. 要求ヘッダー] {#apps-PUT-shared_components__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 118. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#apps-PUT-shared_components__entry__30}{#apps-PUT-shared_components__entry-200-status-code}{#apps-PUT-shared_components__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。渡された変更セットは存在しません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 119. ステータスコード] ### 応答本文のパラメーター 応答フィールドは、要求の returnFields パラメーターで指定されたフィールドによって異なります。以下では、より重要なフィールドのいくつかについて説明します。 {#apps-PUT-shared_components__entry__38}{#apps-PUT-shared_components__changeset-node-editor-entry}{#apps-PUT-shared_components__changeset_link-node-editor-entry}{#apps-PUT-shared_components__changeset_value-node-editor-entry}{#apps-PUT-shared_components__cdm_apps-error-entry}{#apps-PUT-shared_components__cdm_apps-error_detail-entry}{#apps-PUT-shared_components__cdm_apps-error_message-entry}{#apps-PUT-shared_components__cdm_dep-sys_created_by-row}{#apps-PUT-shared_components__cdm_deps-sys_created_on-row}{#apps-PUT-shared_components__sys_id-node-editor-entry}{#apps-PUT-shared_components__cdm_dep-sys_updated_by-row}{#apps-PUT-shared_components__cdm_dep-sys_updated_on-row} | 名前 | 説明 | |-|-| | changeset_id | ノードに関連付けられた変更セットレコードの詳細。 データタイプ: オブジェクト "changeset_id": { "link": "String", "value": "String" } | | changeset_id.link | Table REST API を使用してこの変更セットレコードをクエリするための呼び出し構文。 データタイプ：文字列 | | changeset_id.value | 変更セットレコードの一意の識別子。 データタイプ：文字列 テーブル:CDM 変更セット \[sn_cdm_changeset\] | | description | CDM ノードの説明。 データタイプ：文字列 | | エラー | 処理中にエラーが発生した場合のみ返されます。 データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 発生したエラーの詳細。 データタイプ：文字列 | | error.message | エラーの概要を示すメッセージ。 データタイプ：文字列 | | linked_to | 共有コンポーネントに関連付けられているメインノードの ID。 データタイプ：文字列 | | linked_to_version | ノードに関連付けられた CDM スナップショットレコードの詳細。 データタイプ: オブジェクト "linked_to_version": { "link": "String", "value": "String" } | | linked_to_version.link | Table REST API を使用してこのバージョンレコードをクエリするための呼び出し構文。 データタイプ：文字列 | | linked_to_version.value | バージョンレコードのSys_id。 データタイプ：文字列 | | メイン | 関連付けられたスナップショットが公開されたかどうかを示すフラグ。 有効な値： * true:スナップショットが公開されました。 * false:スナップショットは公開されませんでした。 | | main_id | 新しく作成されたメインノードの一意の ID。 データタイプ：文字列 | | main_id_encoded | 新しく作成されたメインノードのエンコードされた ID。 データタイプ：文字列 | | name | CDM ノードの名前。 データタイプ：文字列 | | node | 共有コンポーネントノードのSys_id。 データタイプ：文字列 | | node_path | 共有コンポーネントの追加時に作成された新しいリンクノードへのパス。 データタイプ：文字列 | | status | ノードのステータス。 可能な値:新規 データタイプ：文字列 | | sys_created_by | CDM ノードを作成するユーザーのユーザー名。たとえば、able.tuter です。 データタイプ：文字列 | | sys_created_on | CDM ノードが作成された日時。 形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | sys_id | ノードのSys_id。 データタイプ：文字列 テーブル:CDM ノード \[sn_cdm_node\] | | sys_updated_by | CDM ノードを最後に更新したユーザーのユーザー名。たとえば、able.tuter です。 データタイプ：文字列 | | sys_updated_on | CDM ノードが最後に更新された日時。 形式:YYYY-mm-DD hh:mm:ss データタイプ：文字列 | | type | ノードタイプ。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、このエンドポイントを呼び出して、「Chset-20」変更セット内の共有ライブラリ「OracleG-Library-10」の下にある共有コンポーネント「paymentService-V1.1」でアプリケーション「App1」を更新する方法を示しています。 "https://instance-name.service-now.com/api/sn_cdm/applications/shared_components?sharedComponentName=paymentService-V1.1&sharedLibraryName=OracleG-Library-10&changesetNumber=Chset-20&versionName=sComp3-v2.shc&appName=App1" \ --request PUT \ --header "Accept:application/json" \ --user 'username':'password' 応答： "result": { "changeset_id": { "value": "7343d0f71b771110636e0fe0604bcb0b", "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_changeset/7343d0f71b771110636e0fe0604bcb0b" }, "node_path": "!2!3!&`", "description": null, "sys_updated_on": "2022-12-22 18:52:38", "type": "sn_cdm_node_linked_shared_component", "sys_class_name": "sn_cdm_node", "sys_id": "339314b71b771110636e0fe0604bcba3", "sys_updated_by": "admin", "previous_version": { "value": "a9ce80bf1b371110636e0fe0604bcb10", "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_node/a9ce80bf1b371110636e0fe0604bcb10" }, "sys_created_on": "2022-12-22 18:52:38", "value": null, "effective_from": null, "linked_to": "146", "sys_created_by": "admin", "restricted_to": null, "linked_to_version": { "value": "54115c371b771110636e0fe0604bcb77", "link": "https://instance-name.service-now.com/api/now/table/sn_cdm_snapshot/54115c371b771110636e0fe0604bcb77" }, "level": "2", "conflict_type": null, "main_id": "166", "effective_to": null, "secure_value": null, "node_classifier": "/application/components", "main_id_encoded": "&`", "name": "Component_A", "position": null, "reason_for_conflict": null, "system_folder": false, "status": "updated", "conflict": false }