--- 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 --- # CdmSharedLibraryApi # CdmSharedLibraryApi {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：55分 CdmSharedLibraryApi は、共有ライブラリと共有コンポーネントを作成および管理できるようにするエンドポイントを提供します。また、共有コンポーネントの構成データをアップロードおよびエクスポートできるエンドポイントもあります。これらの API をインスタンスで使用できるようにするには、構成データ管理この API をアクティブ化する必要があります (CDM) プラグイン。さらに、この API にアクセスするには、次のいずれかのロールが必要です。 * CDM エディターロール * CDM admin ロール共有ライブラリと共有コンポーネントの詳細については、「 [アプリケーション間でのコンポーネントの共有 --- コンポーネントライブラリ](https://www.servicenow.com/docs/access?context=cdm-component-libraries&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。 ## CdmSharedLibraryApi - 削除 /sn_cdm/shared_libraries {#ariaid-title2} 指定された名前の共有ライブラリを削除します。このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 {#sl-DELETE-shared_libs__section_evn_zmx_dwb} バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries デフォルト URL: /api/sn_cdm/shared_libraries 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-DELETE-shared_libs__entry__2}{#sl-DELETE-shared_libs__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#sl-DELETE-shared_libs__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#sl-DELETE-shared_libs__entry__10} | 名前 | 説明 | |-|-| | name | 必須です。削除する共有ライブラリの名前。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-DELETE-shared_libs__entry__14}{#sl-DELETE-shared_libs__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 4. 要求ヘッダー] {#sl-DELETE-shared_libs__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-DELETE-shared_libs__entry__22}{#sl-DELETE-shared_libs__entry-200-status-code}{#sl-DELETE-shared_libs__entry-400-status-code}{#sl-DELETE-shared_libs__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#sl-DELETE-shared_libs__entry__30} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコード例は、共有ライブラリ「javalib」を削除する方法を示しています。 curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name='javalib'\ --request DELETE\ --header "Accept:application/json" \ --user 'username':'password' 応答： "" ## CdmSharedLibraryApi - 削除 /sn_cdm/shared_libraries/components {#ariaid-title3} 指定された共有コンポーネントを指定されたライブラリから削除します。このエンドポイントにアクセスするには、CDM エディターロールが必要です。注: コンポーネントは、現在使用されていない場合にのみ削除できます。また、関連付けられた共有ライブラリがアクティブでない場合は、コンポーネントを削除できません。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries/components デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-DELETE-shared_libs-comps__entry__2}{#sl-DELETE-shared_libs-comps__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 7. パスパラメーター] {#sl-DELETE-shared_libs-comps__entry__6} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。コンポーネントに関連付けられている変更セットの番号。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | name | 必須です。削除する共有コンポーネントの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | sharedLibraryName | 必須です。削除するコンポーネントが配置されている共有ライブラリの名前。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 8. クエリパラメーター] {#sl-DELETE-shared_libs-comps__entry__14} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-DELETE-shared_libs-comps__entry__18}{#sl-DELETE-shared_libs-comps__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 10. 要求ヘッダー] {#sl-DELETE-shared_libs-comps__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-DELETE-shared_libs-comps__entry__26}{#sl-DELETE-shared_libs-comps__entry-200-status-code}{#sl-DELETE-shared_libs-comps__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。考えられる問題: * 共有ライブラリが存在しません。 * 共有ライブラリはアクティブではありません。 * 共有コンポーネントは使用中です。削除できません。 * ユーザーは共有コンポーネントの削除を制限されています。 {#sl-DELETE-shared_libs-comps__ul_x5v_4vp_dwb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター {#sl-DELETE-shared_libs-comps__entry__34} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコード例は、「javalib」共有ライブラリのコンポーネント「TestComponent」を削除する方法を示しています。 curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components?sharedLibraryName='javalib&changesetNumber='chset-8'&name='TestComponent'\ --request DELETE\ --header "Accept:application/json" \ --user 'username':'password' 応答： "" ## CdmSharedLibraryApi - GET /sn_cdm/shared_libraries/upload-status/{upload-id} {#ariaid-title4} 指定された共有ライブラリアップロード要求の現在のステータスを返します。
### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries/upload-status/{upload-id} デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-GET-shared_libs-upload-status__entry__2}{#sl-GET-shared_libs-upload-status__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | upload-id | ステータスが返されるアップロード要求のSys_id。この値は、さまざまな CdmSharedLibrary アップロード要求エンドポイントによって返されます。データタイプ：文字列 | [表 : 13. パスパラメーター] {#sl-GET-shared_libs-upload-status__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#sl-GET-shared_libs-upload-status__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-GET-shared_libs-upload-status__entry__16}{#sl-GET-shared_libs-upload-status__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 16. 要求ヘッダー] {#sl-GET-shared_libs-upload-status__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-GET-shared_libs-upload-status__entry__24}{#sl-GET-shared_libs-upload-status__entry-200-status-code}{#sl-GET-shared_libs-upload-status__entry-400-status-code}{#sl-GET-shared_libs-upload-status__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#sl-GET-shared_libs-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", "sharedLibraryName": "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 | 一意の変更セット識別値 (Chset-124 など)。データタイプ：文字列 | | output.publish_option | 関連するアップロード呼び出しで渡された公開オプションの値。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列 | | output.sharedLibraryName | 元のアップロード呼び出しで渡された共有ライブラリの名前。データタイプ：文字列 | | output.snapshot_description | 関連付けられたスナップショットの説明。データタイプ：文字列 | | output.snapshot_name | 関連付けられたスナップショットの名前。データタイプ：文字列 | | output.state | アップロードのステータス。可能な値： * COMPLETED:アップロードが完了しました。 * EXPIREDERROR:アップロード要求の処理中にエラーが発生しました。ジョブが 15 分以上実行され、システムによって終了されました。 * IN_PROGRESS:アップロードが進行中です。 * 新規:処理はまだ開始されていません。 * READY:要求がキューに入れられました。データタイプ：文字列 | | output.sys_created_by | レコードを作成したエンティティのSys_id。データタイプ：文字列 | | output.sys_id | 変更セットを含むレコードのSys_id。データタイプ：文字列 | | output.title | アップロードの一部として作成された変更セットのタイトル。データタイプ：文字列 | | processing_state | アップロード要求の現在の処理ステータス。可能な値:処理済みデータタイプ：文字列 | | 状況 | アップロード要求の現在のステータス。可能な値： * 完了 * エラー | | type | アップロード要求のタイプ。可能な値:upload_and_commit データタイプ：文字列 | | upload_id | アップロードされた構成ペイロードを含むレコードのSys_id。データタイプ：文字列 | [ ] ### cURL 要求このコード例は、upload-id 0d91d9891b2b19109524cae0604bcbe6 のステータスを要求する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/upload-status/0d91d9891b2b19109524cae0604bcbe6" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 応答： // Successful response { "result": { "type": "upload_and_commit", "state": "completed", "output": { "sys_id": "0002ea107768a1109ac0cf0bbb5a9963", "number": "Chset-457", "title": "admin8802ea107768a1109ac0cf0bbb5a9962", "description": null, "committed_at": "", "committed_by": null, "sys_created_by": "admin", "state": "open", "publish_option": "publish_none", "auto_validate": false, "snapshot_name": null, "snapshot_description": null, "cdm_application": "OracleG-Library-15", "last_conflict_detection_time": null }, "processing_state": "PROCESSED", "upload_id": "00b226547768a1109ac0cf0bbb5a99f2" } } // Error response { "result": { "type": "upload_and_commit", "state": "error", "output": "Error: Application with sys_id 87fb1ecb1be3111050fc21b0604bcb95 is in State Deleted. No data can be modified on deleted applications", "processing_state": "PROCESSED", "upload_id": "fcdfaf7f1b88211050fc21b0604bcb79" } } ## CdmSharedLibraryApi - POST /sn_cdm/shared_libraries {#ariaid-title5} 指定した名前で新しい共有ライブラリを作成します。このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries デフォルト URL: /api/sn_cdm/shared_libraries 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-POST-shared_libs__entry__2}{#sl-POST-shared_libs__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 19. パスパラメーター] {#sl-POST-shared_libs__entry__6}{#sl-POST-shared_libs__appName-userGroupIds-entry} | 名前 | 説明 | |-|-| | description | 共有ライブラリの説明。データタイプ：文字列デフォルト：空 | | name | 必須です。作成する共有ライブラリの名前。この名前は、すべての CDM アプリケーションとライブラリで一意である必要があります。データタイプ：文字列 | | returnFields | 応答の一部として返されるフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非システムフィールドが返されます。テーブル:CDM アプリケーション \[sn_cdm_application\] | | userGroupId | 関連する共有ライブラリを編集できるユーザーグループのsys_idsリスト (カンマ区切り)。適切なロールを持つすべてのユーザーが、共有ライブラリを表示できます。データタイプ：文字列デフォルト:CDM エディターロールを持つすべてのユーザーが、共有ライブラリ内のデータを編集できます。テーブル： Group \[sys_user_group\] | [表 : 20. クエリパラメーター] {#sl-POST-shared_libs__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-POST-shared_libs__entry__20}{#sl-POST-shared_libs__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 22. 要求ヘッダー] {#sl-POST-shared_libs__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-POST-shared_libs__entry__28}{#sl-POST-shared_libs__entry-200-status-code}{#sl-POST-shared_libs__entry-400-status-code}{#sl-POST-shared_libs__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター {#sl-POST-shared_libs__entry__36} | 名前 | 説明 | |-|-| | \<フィールド\> | 要求されたフィールド。データタイプ:変数テーブル:CDM アプリケーション \[sn_cdm_application\] | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコード例は、このエンドポイントを呼び出して、ライブラリにアクセスできるすべてのユーザーグループで共有ライブラリ Java11Lib を作成する方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries?name=Java11Lib&description=The%20new%20java%20library" \ --request POST \ --header "Accept:application/json" \ --user 'userName':'password 応答： { "result": { "sdlc_component": null, "cdi_count": "0", "available": false, "description": "Description of LibraryA", "managed_by_group": null, "sys_updated_on": "2023-01-18 11:34:43", "type": "shared_library", "node": { "value": "d852b15877a4a1109ac0cf0bbb5a99aa", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/d852b15877a4a1109ac0cf0bbb5a99aa" }, "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e", "sys_updated_by": "admin", "node_main": { "value": "1852b15877a4a1109ac0cf0bbb5a99aa", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa" }, "sys_created_on": "2023-01-18 11:34:43", "cdi_usage": "0", "name": "LibraryA", "last_committed_changeset": { "value": "9052b15877a4a1109ac0cf0bbb5a99aa", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/9052b15877a4a1109ac0cf0bbb5a99aa" }, "state": "active", "sys_created_by": "admin" } } ## CdmSharedLibraryApi - POST /sn_cdm/shared_libraries/components {#ariaid-title6} 指定されたライブラリの下に指定された共有コンポーネントを作成します。このエンドポイントにアクセスするには、CDM エディターロールが必要です。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries/components デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-POST-shared_libs-comps__entry__2}{#sl-POST-shared_libs-comps__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 25. パスパラメーター] {#sl-POST-shared_libs-comps__entry__6}{#sl-POST-shared_libs-comps__changesetNumber-changeset-entry} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの一意の識別子 (「Chset-10」など)。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | description | 共有コンポーネントの説明。データタイプ：文字列 | | name | 必須です。共有ライブラリに作成する共有コンポーネントの名前。この名前は一意である必要があります。データタイプ：文字列 | | returnFields | 応答の一部として返す CDM ノード \[sn_cdm_node\] テーブル内のフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非内部フィールドが返されます。 | | sharedLibraryName | 必須です。コンポーネントを作成する共有ライブラリの名前。このライブラリは既に存在し、アクティブステータスである必要があります。データタイプ：文字列 | [表 : 26. クエリパラメーター] {#sl-POST-shared_libs-comps__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 27. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-POST-shared_libs-comps__entry__22}{#sl-POST-shared_libs-comps__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 28. 要求ヘッダー] {#sl-POST-shared_libs-comps__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-POST-shared_libs-comps__entry__30}{#sl-POST-shared_libs-comps__entry-200-status-code}{#sl-POST-shared_libs-comps__entry-400-status-code}{#sl-POST-shared_libs-comps__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター {#sl-POST-shared_libs-comps__entry__38}{#sl-POST-shared_libs-comps__cdm_apps-error-entry}{#sl-POST-shared_libs-comps__cdm_apps-error_detail-entry}{#sl-POST-shared_libs-comps__cdm_apps-error_message-entry} | 名前 | 説明 | |-|-| | \<要求されたフィールド\> | 要求されたフィールド。データタイプ:多様テーブル:CDM ノード \[sn_cdm_node\] | | エラー | 処理中にエラーが発生した場合のみ返されます。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | 発生したエラーの詳細。データタイプ：文字列 | | error.message | エラーの概要を示すメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコード例では、共有ライブラリ「javalib」の下に「SharedComponent」という名前のコンポーネントを格納しています。 curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='Chset-9'&name='SharedComponent'\ --request POST\ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": { "changeset_id": { "value": "ca7e6a501b202110636e0fe0604bcb71", "link": "https://instance.servicenow.com/api/now/table/sn_cdm_changeset/ca7e6a501b202110636e0fe0604bcb71" }, "node_path": "!2!3!:", "description": null, "sys_updated_on": "2023-01-18 16:04:52", "type": "sn_cdm_node_shared_component", "sys_class_name": "sn_cdm_node", "sys_id": "6d2072901b602110636e0fe0604bcbec", "sys_updated_by": "admin", "previous_version": null, "sys_created_on": "2023-01-18 16:04:52", "value": null, "effective_from": null, "linked_to": null, "sys_created_by": "admin", "restricted_to": null, "linked_to_version": null, "level": "2", "conflict_type": null, "main_id": "19", "effective_to": null, "secure_value": null, "node_classifier": "/shared_library/shared_components", "main_id_encoded": ":", "name": "testSharedComponent", "position": null, "reason_for_conflict": null, "system_folder": false, "status": "new", "conflict": false } } ## CdmSharedLibraryApi:POST /sn_cdm/shared_libraries/uploads/components {#ariaid-title7} 共有ライブラリーと共有コンポーネントを作成および管理できます。このエンドポイントは、CDM ノード \[sn_cdm_node\] テーブルに共有コンポーネントノードを作成し、CDM 共有コンポーネント \[sn_cdm_shared_component\] テーブルに共有コンポーネントレコードを作成します。このエンドポイントにアクセスするには、CDM エディターロールが必要です。注: デフォルトでは、コンテンツアップロードの最大サイズは 2MB です。このデフォルトを変更するには、sn_cdm.max_allowed_upload_file_size プロパティを更新します。注: このアップロードメソッドを使用してノードを変更することはできません。別の [CdmSharedLibraryApi:POST /sn_cdm/shared_libraries/uploads/components/file](https://servicenow-prod.fluidtopics.net/cB9og7gwunGDEzRmsP7G_A#csl-POST-shared_libs-upld-comp-file "共有ライブラリの components フォルダーの下にある構成データモデル (CDM) の一部としてファイルをアップロードします。") 方法を使用してノードを変更します。 ### URL 形式バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries/uploads/components デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-POST-shared_libs-uploads-comp__entry__2}{#sl-POST-shared_libs-uploads-comp__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 31. パスパラメーター] {#sl-POST-shared_libs-uploads-comp__entry__6} | 名前 | 説明 | |-|-| | autoCommit | changesetNumberパラメーターで識別された変更セットがアップロード後にデータモデルにコミットされるかどうかを示すフラグ。有効な値： * true:アップロード後に変更セットがコミットされます。 * false:アップロード後に変更セットはコミットされません。データタイプ：ブーリアンデフォルト値：false | | autoDelete | アップロードコンテンツの一部ではない既存のノードを、処理の完了後に削除するかどうかを示すフラグ。有効な値： * true:既存のノードを自動的に削除します。 * false:既存のノードを自動的に削除しません。データタイプ：ブーリアンデフォルト値：false | | changesetNumber | 必須です。Chset-102 など、アプリケーションに関連付けられた変更セットを一意に識別する文字列。この変更セットは「オープン」ステータスである必要があります。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | dataFormat | 必須です。構成データの形式。有効な値： * csv * ini * json * properties * 生 * xml * YAML データタイプ：文字列 | | deleteRedundantOverrides | 冗長な値が存在する上書きを作成するかどうかを示すフラグ。有効な値： * true:冗長な値が存在する場合、上書きは作成されません。 * false:冗長な値が存在する場合は、上書きを続行します。デフォルト：true | | 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:指定されたデータ形式が属性をサポートしている場合、入力データの属性はすべてアップロードに含まれます。 {#sl-POST-shared_libs-uploads-comp__ul_egn_4q4_1yb} データタイプ：ブーリアンデフォルト値：false | | namePath | 構成データをアップロードするターゲットノードのパス。このパスは、コンポーネント、コレクション、または展開可能フォルダーに対する相対パスです (呼び出されるエンドポイントによって異なります)。次のいずれかの形式で名前パスを渡すことができます。たとえば、 `ノード testApp/deployables/Development1/cdi1` の名前パスを定義するには、次のようにします。 * バックスラッシュ形式: testApp/deployables/Development1/cdi1 注: ノード名にバックスラッシュ ("/") が含まれている場合、この形式は使用できません。 * 置換文字を含むバックエンド名のパス: testApp deployables Development1 cdi1 * アレイ: \['testApp','deployables','Development1','cdi1'\] {#sl-POST-shared_libs-uploads-comp__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。データタイプ：文字列 | | publishOption | 関連付けられた構成済みスナップショットの公開オプション。有効な値： * publish_new_and_unpublish_old:コミット後に作成された新しいスナップショットを公開し、既存のスナップショットを非公開にします。 * publish_none:スナップショットを公開しません。スナップショットの公開の詳細については、「 [スナップショットの公開または非公開](https://www.servicenow.com/docs/access?context=cdm-snapshot-publish&version=australia&pubname=australia-it-service-management&ft:locale=en-US)」を参照してください。データタイプ：文字列デフォルト値:publish_none | | sharedLibraryName | 必須です。作成または管理する共有ライブラリの名前。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 32. クエリパラメーター] {#sl-POST-shared_libs-uploads-comp__entry__28}{#sl-POST-shared_libs-uploads-comp__cdm_apps-var_up_data-entry} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。これは、クエリパラメーターの dataFormat パラメーターで定義された形式の任意のデータにすることができます。 | [表 : 33. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-POST-shared_libs-uploads-comp__id_fyp_pmb_fwb__entry__2}{#sl-POST-shared_libs-uploads-comp__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。サポートされているタイプ: text/plain および application/x-www-form-urlencoded。デフォルト： text/plain | [表 : 34. 要求ヘッダー] {#sl-POST-shared_libs-uploads-comp__id_fyp_pmb_fwb} {#sl-POST-shared_libs-uploads-comp__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-POST-shared_libs-uploads-comp__entry__42}{#sl-POST-shared_libs-uploads-comp__entry-200-status-code}{#sl-POST-shared_libs-uploads-comp__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。アップロード要求が却下されました。考えられる問題: * 構成ペイロードのサイズが、デフォルトで許容される最大値 (2MB) を超えています。 * コールに必須パラメーターがありません。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター {#sl-POST-shared_libs-uploads-comp__entry__50} | 名前 | 説明 | |-|-| | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | upload_id | アップロード要求のSys_id。この ID を使用してエンドポイントを呼び出し、アップロードのステータスを取得します。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次の例は、構成データをプレーンテキストにして Demo_App1631126164773 と呼ばれる共有ライブラリをアップロードする方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/sharedlibrary/component/upload?namePath=%2FSettings%2FdbSettings&dataFormat=json&appName=Demo_App1631126164773&changesetNumber=Chset-8&autoCommit=false&publishOption=publish_none&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 response { "result": { "upload_id": "ec1f71f45322301096edddeeff7b12b3" } } // Error response { "error": { "message": "Size of uploaded data:6853632.0(bytes) is greater than max allowed upload limit of 2097152.0(bytes)", "detail": "" }, "status": "failure" } ## CdmSharedLibraryApi:POST /sn_cdm/shared_libraries/uploads/components/file {#ariaid-title8} 共有ライブラリの components フォルダーの下にある構成データモデル (CDM) の一部としてファイルをアップロードします。 ### URL 形式 {#csl-POST-shared_libs-upld-comp-file__section_abk_fyr_byb} バージョニングされた URL: /api/sn_cdm/{api_version}shared_libraries/uploads/components/file デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#csl-POST-shared_libs-upld-comp-file__entry__2}{#csl-POST-shared_libs-upld-comp-file__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 37. パスパラメーター] {#csl-POST-shared_libs-upld-comp-file__table_hxt_rmm_2yb__entry__2} | | | |-|-| | 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'\] {#csl-POST-shared_libs-upld-comp-file__cdm_apps-namePath-ul} 注: 指定されたパスに指定されたコンポーネントが存在しない場合、指定されたパスにコンポーネントが自動的に作成され、データがアップロードされます。データタイプ：文字列 | | sharedLibraryName | 必須です。削除するコンポーネントが配置されている共有ライブラリの名前。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | [表 : 38. クエリパラメーター] {#csl-POST-shared_libs-upld-comp-file__table_hxt_rmm_2yb} {#csl-POST-shared_libs-upld-comp-file__table_j22_fgm_2yb__entry__2} | 名前 | 説明 | |-|-| | 変数アップロードデータ | アップロードする構成データ。デフォルトでは、アップロードするファイルサイズは 5 MB に制限されています。アップロードファイルのサイズとタイプを調整する方法については、こちらを参照してください [Now Support article](https://support.servicenow.com/kb?id=kb_article_view&sysparm_article=KB0718101). データタイプ:文字列/ストリーム | [表 : 39. 要求本文パラメーター (XML または JSON)] {#csl-POST-shared_libs-upld-comp-file__table_j22_fgm_2yb} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#csl-POST-shared_libs-upld-comp-file__entry__26}{#csl-POST-shared_libs-upld-comp-file__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | | Content-Type | コンテンツアップロードするファイルのタイプ。例:application/zip、text/plain、application/json。 | [表 : 40. 要求ヘッダー] {#csl-POST-shared_libs-upld-comp-file__entry__32} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコード {#csl-POST-shared_libs-upld-comp-file__section_mtw_2vr_byb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#csl-POST-shared_libs-upld-comp-file__id_cdq_fft_byb__entry__2}{#csl-POST-shared_libs-upld-comp-file__entry-200-status-code}{#csl-POST-shared_libs-upld-comp-file__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。アップロード要求が却下されました。考えられる問題: * 構成ペイロードのサイズが許容最大値 (デフォルトでは 2 MB) を超えています。 * コールに必須パラメーターがありません。 {#csl-POST-shared_libs-upld-comp-file__ul_kmn_gkh_psb} | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 42. ステータスコード] {#csl-POST-shared_libs-upld-comp-file__id_cdq_fft_byb} ### 応答本文のパラメーター (JSON または XML) {#csl-POST-shared_libs-upld-comp-file__section_sbq_2bx_1yb} {#csl-POST-shared_libs-upld-comp-file__id_af3_kft_byb__entry__2}{#csl-POST-shared_libs-upld-comp-file__cdm_apps-stat-error}{#csl-POST-shared_libs-upld-comp-file__cdm_apps-stat-error_detail-row}{#csl-POST-shared_libs-upld-comp-file__cdm_apps-stat-error_messaage-row}{#csl-POST-shared_libs-upld-comp-file__cdm_apps-stat-error_status-row}{#csl-POST-shared_libs-upld-comp-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 "指定された構成データのアップロード要求の現在のステータスを返します。") エンドポイントを呼び出し、アップロードのステータスを取得します。データタイプ：文字列 | [ ] {#csl-POST-shared_libs-upld-comp-file__id_af3_kft_byb} ### cURL 要求次の呼び出しは、共有ライブラリのコンポーネントフォルダーにプレーンテキストファイルをアップロードする方法を示しています。 curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/uploads/components/file?autoValidate=true&sharedLibraryName=sharedLibA &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" } ## CdmSharedLibraryApi - PUT /sn_cdm/shared_libraries {#ariaid-title9} 共有ライブラリ情報を更新します。このエンドポイントを使用して、共有ライブラリの名前、説明、ステータス、およびライブラリにアクセスできるユーザーグループを更新します。このエンドポイントにアクセスするには、CDM admin ロールが必要です。 ### URL 形式 {#sl-PUT-shared_libs__section_thy_4hj_dwb} バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries デフォルト URL: /api/sn_cdm/shared_libraries 注: 使用可能なバージョン [は、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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-PUT-shared_libs__entry__2}{#sl-PUT-shared_libs__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 43. パスパラメーター] {#sl-PUT-shared_libs__entry__6} | 名前 | 説明 | |-|-| | name | 必須です。更新する共有ライブラリの名前。データタイプ：文字列テーブル:CDM アプリケーション \[sn_cdm_application\] | | newAvailableState | 共有ライブラリのステータスを示すフラグ。有効な値： * true:共有ライブラリはアクティブです。 * false:共有ライブラリは非アクティブです。このライブラリにアクセスできるユーザーはいません。デフォルト：true | | 新しい説明 | 共有ライブラリの説明が更新されました。データタイプ：文字列 | | newName | 共有ライブラリーの新しい名前。データタイプ：文字列 | | newUserGroupId | 関連する共有ライブラリにアクセスできるユーザーグループのsys_idsのカンマ区切りリスト。データタイプ：文字列テーブル： Group \[sys_user_group\] | | returnFields | 応答の一部として返す CDM アプリケーション \[sn_cdm_application\] テーブル内のフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非システムフィールドが返されます。 | [表 : 44. クエリパラメーター] {#sl-PUT-shared_libs__entry__20} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文のパラメーター] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-PUT-shared_libs__entry__24}{#sl-PUT-shared_libs__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 46. 要求ヘッダー] {#sl-PUT-shared_libs__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-PUT-shared_libs__entry__32}{#sl-PUT-shared_libs__entry-200-status-code}{#sl-PUT-shared_libs__entry-400-status-code}{#sl-PUT-shared_libs__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター {#sl-PUT-shared_libs__entry__40} | 名前 | 説明 | |-|-| | \<フィールド\> | 要求されたフィールド。データタイプ:変数テーブル:CDM アプリケーション \[sn_cdm_application\] | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコード例は、共有ライブラリ Java11Lib に対してこのエンドポイントを呼び出し、ライブラリ名と説明を更新する方法を示しています。 curl "http://instance.servicenow.com/sn_cdm/shared_libraries?name=' javalib'&newName='NewLibraryName'&newDescription='new%20description%20of%20library'\ --request PUT\ --header "Accept:application/json" \ --user 'username':'password' 応答： { "result": { "sdlc_component": null, "cdi_count": "0", "available": true, "description": "Set new description", "managed_by_group": null, "sys_updated_on": "2023-01-18 11:51:14", "type": "shared_library", "node": { "value": "021635dc77a4a1109ac0cf0bbb5a9952", "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/021635dc77a4a1109ac0cf0bbb5a9952" }, "sys_id": "185235dc77a4a1109ac0cf0bbb5a994e", "sys_updated_by": "admin", "node_main": { "value": "1852b15877a4a1109ac0cf0bbb5a99aa", "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node_main/1852b15877a4a1109ac0cf0bbb5a99aa" }, "sys_created_on": "2023-01-18 11:34:43", "cdi_usage": "0", "name": "LibraryA", "last_committed_changeset": { "value": "4a1635dc77a4a1109ac0cf0bbb5a9951", "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/4a1635dc77a4a1109ac0cf0bbb5a9951" }, "state": "active", "sys_created_by": "admin" } } ## CdmSharedLibraryApi - PUT /sn_cdm/shared_libraries/components {#ariaid-title10} 指定された共有コンポーネントの名前と説明を更新します。このエンドポイントにアクセスするには、CDM エディターロールが必要です。注: 名前の変更は、コンポーネントのスナップショットが一度もインポートされていない場合など、コンポーネントが使用されたことがない場合にのみ許可されます。名前変更のシナリオは、主に新しいコンポーネントを作成するときにタイプミスを修正するためのものです。 ### URL 形式 {#sl-PUT-shared_libs-comps__section_nff_yxj_dwb} バージョニングされた URL: /api/sn_cdm/{api_version}/shared_libraries/components デフォルト URL: /api/sn_cdm/shared_libraries/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 をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#sl-PUT-shared_libs-comps__entry__2}{#sl-PUT-shared_libs-comps__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 49. パスパラメーター] {#sl-PUT-shared_libs-comps__entry__6} | 名前 | 説明 | |-|-| | changesetNumber | 必須です。関連する変更セットの名前。データタイプ：文字列テーブル:CDM 変更セット \[sn_cdm_changeset\] | | name | 必須です。更新する共有コンポーネントの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント \[sn_cdm_shared_component\] | | newName | 必須です。共有コンポーネントの更新された名前。データタイプ：文字列 | | 新しい説明 | 共有コンポーネントの説明が更新されました。データタイプ：文字列デフォルト：空 | | returnFields | 応答の一部として返す CDM 共有コンポーネント \[sn_cdm_shared_component\] テーブル内のフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非システムフィールドが返されます。 | [表 : 50. クエリパラメーター] {#sl-PUT-shared_libs-comps__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#sl-PUT-shared_libs-comps__entry__22}{#sl-PUT-shared_libs-comps__cdm_apps-sl_req_headers-accept-entry} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされているタイプ: * application/json * application/xml * text/xml デフォルト： application/json | [表 : 52. 要求ヘッダー] {#sl-PUT-shared_libs-comps__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#sl-PUT-shared_libs-comps__entry__30}{#sl-PUT-shared_libs-comps__entry-200-status-code}{#sl-PUT-shared_libs-comps__entry-400-status-code}{#sl-PUT-shared_libs-comps__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター {#sl-PUT-shared_libs-comps__entry__38} | 名前 | 説明 | |-|-| | \<フィールド\> | CDM 共有コンポーネント \[sn_cdm_shared_component\] テーブルから要求されたフィールド。データタイプ:変数 | | エラー | 処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト "error": { "detail": "String", "message": "String" } | | error.detail | エラーに関する追加情報。データタイプ：文字列 | | error.message | 要求の処理中に生成されたエラーメッセージ。データタイプ：文字列 | | status | 要求のエラーステータス。可能な値:失敗データタイプ：文字列 | [ ] ### cURL 要求次のコードサンプルは、コンポーネント SharedComponentTest の説明を更新する方法を示しています。 curl "http://instance.servicenow.com/sn_cdm/shared_libraries/components/?sharedLibraryName=javalib&changeSetNumber='chset-9'&name='SharedComponentTest'&newDescription='The shared component description'\ --request POST\ --header "Accept:application/json" \ --user 'username':'password 応答： { "result": { "changeset_id": { "value": "5c33311077e4a1109ac0cf0bbb5a9902", "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/5c33311077e4a1109ac0cf0bbb5a9902" }, "node_path": "!(1!(2!(3", "description": "Changing the description only", "sys_updated_on": "2023-01-18 12:09:05", "type": "sn_cdm_node_shared_component", "sys_class_name": "sn_cdm_node", "sys_id": "9953f99077a4a1109ac0cf0bbb5a99ec", "sys_updated_by": "admin", "previous_version": null, "sys_created_on": "2023-01-18 11:39:09", "value": null, "effective_from": null, "linked_to": null, "sys_created_by": "admin", "restricted_to": null, "linked_to_version": null, "level": "2", "conflict_type": null, "main_id": "183", "effective_to": null, "secure_value": null, "node_classifier": "/shared_library/shared_components", "main_id_encoded": "(3", "name": "sharedComponentName", "position": null, "reason_for_conflict": null, "system_folder": false, "status": "new", "conflict": false } }