CdmVersionApi

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

Release

australia

ft:locale

ja-JP

ft:publication_title

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

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

CdmVersionApi

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：23分

CdmVersionApi は、共有ライブラリの共有コンポーネントの構成データ管理 (CDM) でバージョン (スナップショット) を公開、非公開、およびエクスポートできるようにするエンドポイントを提供します。

スナップショットを公開してエクスポートできるようにすると、継続的インテグレーションと継続的デリバリ (CICD) パイプラインが関連する共有コンポーネントとライブラリにアクセスして使用できるようになります。エクスポーターは、公開されたスナップショットでのみ実行できます。スナップショットが不要になった場合は、スナップショットを非公開にすることで、スナップショットが実行可能かどうかに関する混乱を軽減できます。

この API にアクセスするには、次のいずれかのロールが必要です。

スクリプト済み REST CDM ビュー ACL (sn_cdm.cdm.viewer)
スクリプト済み REST CDM エディター ACL (sn_cdm.cdm_editor)

さらに、この API をインスタンスで使用するには、構成データ管理 (CDM) プラグインをアクティブ化する必要があります。

スナップショットの詳細については、「スナップショットの表示」を参照してください。

CdmVersionApi - GET /sn_cdm/versions/export

指定された公開バージョンの指定された共有ライブラリ内の指定された共有コンポーネントの構成データを返します。

このエンドポイントにアクセスするには、CDM エディターロールが必要です。

URL 形式

バージョニングされた URL: /api/sn_cdm/{api_version}/versions/export

デフォルト URL: /api/sn_cdm/versions/export

注:

使用可能なバージョンは、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

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

表 : 2. クエリパラメーター
名前	説明
dataFormat	必須です。構成データの形式。有効な値： csv ini json properties 生 xml YAML データタイプ：文字列
パスワードを解読	エンコードされたパスワード値を表示するか復号化されたパスワード値を表示するかを示すフラグ。有効な値： true:パスワードを復号化し、復号化された値を表示します。 false:暗号化されたパスワード値を表示します。デフォルト値：false
sharedComponentName	必須です。構成データをエクスポートする共有コンポーネントの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
sharedLibraryName	必須です。構成データを返すコンポーネントが含まれている共有ライブラリの名前。指定するアプリケーションでは、タイプフィールドが「shared_library」に設定されている必要があります。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
代替変数	変数に従うかどうかを示すフラグ。変数の追跡については、構成データの検証と修正を参照してください。有効な値： true:変数に従います。 false:変数に従いません。デフォルト：true

表 : 3. 要求本文のパラメーター
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされているタイプ: application/json application/xml text/xml デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。次のいずれかの問題が発生している可能性があります。共有ライブラリはアクティブではありません。共有コンポーネントがアクティブではありません。バージョンは公開されていません。呼び出しにパラメーターがありません。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
result	指定された形式の構成データ。
エラー	処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	エラーに関する追加情報。データタイプ：文字列
error.message	要求の処理中に生成されたエラーメッセージ。データタイプ：文字列
status	要求のエラーステータス。可能な値:失敗データタイプ：文字列

cURL 要求

次のコード例は、「JavaLib」共有ライブラリの「jdk8」コンポーネントの構成データをエクスポートする方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/shared_libraries/components/exports?sharedLibraryName=JavaLib&componentName=jdk8 
--request POST \  
--header "Accept:application/json" \   
--user 'username':'password'

応答：

{  
"result": {  
    "sharedComponentA": { "cdi": "val" } 
 }  
}

CdmVersionApi - PUT /sn_cdm/versions/publish

指定された共有ライブラリで共有コンポーネントのバージョンを公開します。

このエンドポイントにアクセスするには、CDM エディターロールが必要です。

注:

スナップショットとバージョンは、この実装の意味において同義語です。

URL 形式

バージョニングされた URL: /api/sn_cdm/{api_version}/versions/publish

デフォルト URL: /api/sn_cdm/versions/publish

注:

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

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

表 : 8. クエリパラメーター
名前	説明
name	必須です。公開する共有コンポーネントのバージョンの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
returnFields	応答の一部として返す CDM スナップショット [sn_cdm_snapshot] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非システムフィールドを返します。
sharedComponentName	必須です。公開する共有コンポーネントの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
sharedLibraryName	必須です。指定されたコンポーネントが存在する共有ライブラリの名前。関連レコードのタイプフィールドは「shared_library」に設定する必要があります。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]

表 : 9. 要求本文のパラメーター
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされているタイプ: application/json application/xml text/xml デフォルト： application/json

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。公開中にエラーが発生しました。考えられる問題: バージョン名が見つかりません。コンポーネントバージョンは既に公開されています。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
cdm_application_id	スナップショットに関連付けられた CDM アプリケーションの詳細。データタイプ: オブジェクト `"cdm_application_id": { "link": "String", "value": "String" }`
cdm_application_id.link	REST テーブル API を使用して CDM アプリケーションレコードにアクセスするために使用する呼び出し。データタイプ：文字列
cdm_application_id.value	関連付けられた CDM アプリケーションレコードのSys_id。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
cdm_deployable_id	スナップショットに関連付けられた CDM 展開可能項目の詳細。データタイプ: オブジェクト `"cdm_deployable_id": { "link": "String", "value": "String" }`
cdm_deployable_id.link	Table REST API を使用してこの展開可能レコードをクエリするための呼び出し構文。データタイプ：文字列
cdm_deployable_id.value	展開可能レコードのSys_id。データタイプ：文字列テーブル:CDM 展開可能項目 [sn_cdm_deployable]
changeset_id	スナップショットに関連付けられた変更セットの詳細。データタイプ: オブジェクト `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	Table REST API を使用してこの変更セットレコードをクエリするための呼び出し構文。データタイプ：文字列
changeset_id.value	変更セットレコードの一意の識別子。データタイプ：文字列テーブル:CDM 変更セット [sn_cdm_changeset]
description	スナップショットの簡単な説明。データタイプ：文字列
エラー	処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	エラーに関する追加情報。データタイプ：文字列
error.message	要求の処理中に生成されたエラーメッセージ。データタイプ：文字列
last_published	スナップショットが最後に公開された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
last_validated	スナップショットが最後に検証された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
name	スナップショットの名前。データタイプ：文字列
number	スナップショットを識別する一意の番号。この値は、人間が判読できるマッピングの識別子を提供します。データタイプ：文字列
公開済み	スナップショットが公開されたかどうかを示すフラグ。可能な値： true:スナップショットが公開されました。 false:スナップショットは公開されませんでした。データタイプ：ブーリアン
sys_created_by	スナップショットを作成したユーザーの名前。データタイプ：文字列
sys_created_on	スナップショットが作成された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
sys_id	スナップショットのSys_id。データタイプ：文字列テーブル:CDM スナップショット [sn_cdm_snapshot]
sys_updated_by	スナップショットを更新したユーザーの名前。データタイプ：文字列
sys_updated_on	スナップショットが最後に更新された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
妥当性検証	スナップショットの現在の検証ステータス。可能な値： execution_error 失敗進行中 not_validated 合格 passed_with_exception 要求済みデータタイプ：文字列

cURL 要求

このコード例は、共有コンポーネント「Development」をバージョン名「Development-v1.shc」で公開する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/versions/publish?sharedLibraryName=LibraryJdk&componentName=Development&name=Development-v1.shc" \  
--request PUT\  
--header "Accept:application/json" \  
--user 'username':'password

応答：

{
  "result": {
    "changeset_id": {
      "value": "1a2bd15c7764a1109ac0cf0bbb5a99fc",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/1a2bd15c7764a1109ac0cf0bbb5a99fc"
    },
    "cdm_deployable_id": null,
    "cdm_shared_component_node_id": {
      "value": "fe2b155c7764a1109ac0cf0bbb5a995d",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/fe2b155c7764a1109ac0cf0bbb5a995d"
    },
    "cdm_shared_component_id": {
      "value": "362b155c7764a1109ac0cf0bbb5a9970",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_shared_component/362b155c7764a1109ac0cf0bbb5a9970"
    },
    "description": null,
    "cdm_application_id": {
      "value": "122bd15c7764a1109ac0cf0bbb5a99fa",
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/122bd15c7764a1109ac0cf0bbb5a99fa"
    },
    "published": true,
    "sys_updated_on": "2023-01-18 14:15:44",
    "last_published": "2023-01-18 09:53:37",
    "sequence_number": "1",
    "number": "SNAP0001110",
    "sys_id": "df2b155c7764a1109ac0cf0bbb5a9949",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-01-18 09:53:36",
    "name": "logonService-V2.1-v1.shc",
    "last_validated": "",
    "validation": "passed",
    "sys_created_by": "admin"
  }
}

CdmVersionApi - PUT /sn_cdm/versions/unpublish

指定された共有ライブラリで共有コンポーネントのバージョンを非公開にします。

このエンドポイントにアクセスするには、CDM エディターロールが必要です。

注:

スナップショットとバージョンは、この実装の意味において同義語です。

URL 形式

バージョニングされた URL: /api/sn_cdm/{api_version}/versions/publish

デフォルト URL: /api/sn_cdm/versions/publish

注:

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

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

表 : 14. クエリパラメーター
名前	説明
name	必須です。非公開にする共有コンポーネントのバージョンの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
returnFields	応答の一部として返す CDM スナップショット [sn_cdm_snapshot] テーブルのフィールドのカンマ区切りリスト。データタイプ：文字列デフォルト:すべての非システムフィールドを返します。
sharedComponentName	必須です。非公開にする共有コンポーネントの名前。データタイプ：文字列テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
sharedLibraryName	必須です。指定されたコンポーネントが存在する共有ライブラリの名前。関連レコードのタイプフィールドは「shared_library」に設定する必要があります。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]

表 : 15. 要求本文のパラメーター
名前	説明
なし

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされているタイプ: application/json application/xml text/xml デフォルト： application/json

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。非公開中にエラーが発生しました。考えられる問題: バージョン名が見つかりません。コンポーネントバージョンは既に公開されています。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター


名前	説明
cdm_application_id	スナップショットに関連付けられた CDM アプリケーションの詳細。データタイプ: オブジェクト `"cdm_application_id": { "link": "String", "value": "String" }`
cdm_application_id.link	REST テーブル API を使用して CDM アプリケーションレコードにアクセスするために使用する呼び出し。データタイプ：文字列
cdm_application_id.value	関連付けられた CDM アプリケーションレコードのSys_id。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
cdm_deployable_id	スナップショットに関連付けられた CDM 展開可能項目の詳細。データタイプ: オブジェクト `"cdm_deployable_id": { "link": "String", "value": "String" }`
cdm_deployable_id.link	Table REST API を使用してこの展開可能レコードをクエリするための呼び出し構文。データタイプ：文字列
cdm_deployable_id.value	展開可能レコードのSys_id。データタイプ：文字列テーブル:CDM 展開可能項目 [sn_cdm_deployable]
changeset_id	スナップショットに関連付けられた変更セットの詳細。データタイプ: オブジェクト `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	Table REST API を使用してこの変更セットレコードをクエリするための呼び出し構文。データタイプ：文字列
changeset_id.value	変更セットレコードの一意の識別子。データタイプ：文字列テーブル:CDM 変更セット [sn_cdm_changeset]
description	スナップショットの簡単な説明。データタイプ：文字列
エラー	処理中にエラーが発生した場合は、エラーの詳細。データタイプ: オブジェクト `"error": { "detail": "String", "message": "String" }`
error.detail	エラーに関する追加情報。データタイプ：文字列
error.message	要求の処理中に生成されたエラーメッセージ。データタイプ：文字列
last_published	スナップショットが最後に公開された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
last_validated	スナップショットが最後に検証された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
name	スナップショットの名前。データタイプ：文字列
number	スナップショットを識別する一意の番号。この値は、人間が判読できるマッピングの識別子を提供します。データタイプ：文字列
公開済み	スナップショットが公開されたかどうかを示すフラグ。可能な値： true:スナップショットが公開されました。 false:スナップショットは公開されませんでした。データタイプ：ブーリアン
sys_created_by	スナップショットを作成したユーザーの名前。データタイプ：文字列
sys_created_on	スナップショットが作成された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
sys_id	スナップショットのSys_id。データタイプ：文字列テーブル:CDM スナップショット [sn_cdm_snapshot]
sys_updated_by	スナップショットを更新したユーザーの名前。データタイプ：文字列
sys_updated_on	スナップショットが最後に更新された日時。データタイプ：文字列形式:yyyy-mm-dd hh:mm:ss
妥当性検証	スナップショットの現在の検証ステータス。可能な値： execution_error 失敗進行中 not_validated 合格 passed_with_exception 要求済みデータタイプ：文字列

cURL 要求

次のコード例は、「OracleG-Library-10」共有ライブラリから「paymentService-V1」共有コンポーネントを非公開にする方法を示しています。

curl "https://instance-name.service-now.com/api/sn_cdm/versions/unpublish?sharedLibraryName=OracleG-Library-10&sharedComponentName=paymentService-V1.1&name=paymentService-V1.1-v1.shc" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

応答：

{
  "result": {
    "changeset_id": {
      "value": "1a2bd15c7764a1109ac0cf0bbb5a99fc",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_changeset/1a2bd15c7764a1109ac0cf0bbb5a99fc"
    },
    "cdm_deployable_id": null,
    "cdm_shared_component_node_id": {
      "value": "fe2b155c7764a1109ac0cf0bbb5a995d",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_node/fe2b155c7764a1109ac0cf0bbb5a995d"
    },
    "cdm_shared_component_id": {
      "value": "362b155c7764a1109ac0cf0bbb5a9970",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_shared_component/362b155c7764a1109ac0cf0bbb5a9970"
    },
    "description": null,
    "cdm_application_id": {
      "value": "122bd15c7764a1109ac0cf0bbb5a99fa",
      "link": "http://192.168.0.129:8080/api/now/table/sn_cdm_application/122bd15c7764a1109ac0cf0bbb5a99fa"
    },
    "published": false,
    "sys_updated_on": "2023-01-18 14:15:44",
    "last_published": "2023-01-18 09:53:37",
    "sequence_number": "1",
    "number": "SNAP0001110",
    "sys_id": "df2b155c7764a1109ac0cf0bbb5a9949",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-01-18 09:53:36",
    "name": "logonService-V2.1-v1.shc",
    "last_validated": "",
    "validation": "passed",
    "sys_created_by": "admin"
  }
}