CdmChangesetsApi

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：68分

    • CdmChangesetsApi は、変更セットの管理を可能にするエンドポイントを提供します。

    これらのエンドポイントを使用して、次のことができます。
    • 新しい変更セットの作成
    • 変更セットの展開
    • 変更セットのリストまたは個々の変更セットの取得
    • 変更セット内のノード変更の取得
    • 変更セットの影響を受けるアプリケーションまたは展開可能項目のリストの取得
    • 変更セットの削除
    • 指定された変更セットに関連付けられている共有コンポーネントのリストを返します。

    変更セット作成のエンドポイントでは、非同期キュー実装を使用します。このタイプの実装では、最初に変更セット作成要求エンドポイントを呼び出します。このエンドポイントは要求をキューに入れ、コミット識別子を返します。次に、このコミット識別子を使用して適切なステータスエンドポイントを呼び出して、作成要求のステータスを取得します。

    この API にアクセスするには、次のいずれかのロールが必要です。
    • スクリプト化された REST CDM ビュー ACL (sn_cdm.cdm.viewer)
    • スクリプト化された REST CDM エディター ACL (sn_cdm.cdm_editor)

    また、この API をインスタンスで使用するには、構成データ管理 (CDM) プラグインを有効にする必要があります。

    変更セットの詳細については、「 CDM での変更セットとバージョン管理」を参照してください。

    CdmChangesetsApi - DELETE /sn_cdm/changesets

    指定された変更セットを削除します。

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

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets

    デフォルトの URL：/api/sn_cdm/changesets

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

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

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

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    changesetNumber 必須。
    関連する変更セットの一意の識別子 (「Chset-10」など)。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    表 : 3. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    なし

    cURL 要求

    次のコード例は、変更セットを削除する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?changesetNumber=Chset-760" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    変更セットが正常に削除された場合、HTTP ステータスコード以外の応答は返されません。

    None - results defined by the HTTP status code

    CdmChangesetsApi - GET /sn_cdm/changesets

    構成データ管理 (CDM) アプリケーションまたは指定された変更セットレコードに関連付けられたすべての変更セットを取得します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets

    デフォルトの URL：/api/sn_cdm/changesets

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

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

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

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    appName 必須です。変更セットを返す CDM アプリケーションの名前。これはアクティブなアプリケーションである必要があります。

    データタイプ：文字列

    テーブル:CDM アプリケーション [sn_cdm_application]
    番号 変更セット番号。

    この値を渡すと、指定された変更セットのみが返されます。appName パラメーターで指定された CDM アプリケーションに関連付けられている変更セットである必要があります。

    データタイプ：文字列

    デフォルト：なし - CDM アプリケーションに関連付けられたすべての変更セット、または state パラメーターで指定された変更セットを返します。

    テーブル:CDMChangeset [sn_cdm_changeset]
    状況 返す変更セットのステータス。指定されたステータスの指定された CDM アプリケーションに関連付けられた変更セットのみを返します。

    有効な値：

    • ブロック済み
    • 競合をチェックしています
    • コミットに失敗しました
    • コミット進行中
    • コミット済み
    • オープン

    データタイプ：文字列

    デフォルト：すべてのステータスのすべての変更セットを返します。
    表 : 9. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    auto_validate コミット時に作成された変更セットを検証するかどうかを示すフラグ。
    有効な値：
    • true：変更セットを検証します。
    • false:変更セットを検証しません。

    データタイプ：ブーリアン
    cdm_application 変更セットに関連付けられた CDM アプリケーションの詳細。

    データタイプ：オブジェクト

    "cdm_application": {
  "link": "String",
  "value": "String"
}
    cdm_application.link 関連付けられた CDM アプリケーションを取得するためのテーブル REST エンドポイントの呼び出しに使用するクエリ。

    データタイプ：文字列
    cdm_application.value 関連付けられた CDM アプリケーションの sys_id。

    データタイプ：文字列

    テーブル:CDM アプリケーション [sn_cdm_application]
    committed_at 変更セットが最後にコミットされた日時。

    データタイプ：文字列

    形式：YYYY-mm-DD hh:mm:ss
    committed_by 変更セットをコミットしたユーザーの詳細。

    データタイプ：オブジェクト

    "committed_by": {
  "link": "String",
  "value": "String"
}
    committed_by.link REST テーブル API を使用して変更セットをコミットしたユーザーのレコードを取得するための呼び出し。

    データタイプ：文字列
    committed_by.value 変更セットをコミットしたユーザーの sys_id。

    データタイプ：文字列
    説明 変更セットの目的の簡単な説明。

    データタイプ：文字列
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    last_conflict_detection_time 前回の競合検出が実行されてからの時間数。変更セットがコミットされるたびに、競合の検出が実行されます。

    データタイプ：数値

    単位：ミリ秒
    last_updated この変更セットを介して関連付けられた構成データが変更された日時。

    形式：YYYY-mm-DD hh:mm:ss

    データタイプ：文字列
    number 一意の変更セット番号。

    データタイプ：文字列
    publish_option
    関連付けられた構成済みスナップショットの公開オプション。
    有効な値：
    • publish_none:スナップショットを公開しません。
    • publish_valid：コミット後に検証に合格したスナップショットのみを公開します。

    スナップショットの公開の詳細については、「 スナップショットの公開または非公開」を参照してください。

    データタイプ：文字列

    デフォルト：publish_none
    state 変更セットの現在のステータス。

    可能な値：

    • ブロック済み
    • 競合をチェックしています
    • コミットに失敗しました
    • コミット進行中
    • コミット済み
    • オープン

    データタイプ：文字列
    sys_created_by 変更セットを作成したユーザーの名前。たとえば、able.tuter などです。

    データタイプ：文字列
    sys_created_on 変更セットが作成された日時。

    データタイプ：文字列

    形式：YYYY-mm-DD hh:mm:ss
    sys_id 変更セットの sys_id。

    データタイプ：文字列

    テーブル:CDMChangeset [sn_cdm_changeset]
    sys_updated_by 変更セットを最後に更新したユーザーのユーザー名。たとえば、able.tuter などです。

    データタイプ：文字列
    sys_updated_on 変更セットが最後に更新された日時。

    データタイプ：文字列

    形式：YYYY-mm-DD hh:mm:ss
    title 変更セットのタイトル。

    データタイプ：文字列

    cURL 要求

    このコード例は、特定の変更セットを取得する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets?appName=testApp&changesetNumber=Chset-946&state=committed" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": [ 
    { 
      "description": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "cdm_application": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_updated_on": "2022-06-29 13:09:47", 
      "title": "Auto generated for deletion of CDM Deployable Dep-12022-06-29 13:09:46", 
      "number": "Chset-946", 
      "sys_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "sys_updated_by": "admin", 
      "committed_at": "2022-06-29 13:09:46", 
      "sys_created_on": "2022-06-29 13:09:46", 
      "committed_by": { 
        "value": "6816f79cc0a8016401c5a33be04be441", 
        "link": "http://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441" 
      }, 
      "state": "committed", 
      "auto_validate": true, 
      "publish_option": "publish_none", 
      "last_conflict_detection_time": "1656508187450", 
      "sys_created_by": "admin", 
      "last_updated": "2022-06-29 13:09:46" 
    } 
  ] 
}

    CdmChangesetsApi - GET /sn_cdm/changesets

    指定された変更セット内のノード変更を取得します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/activity

    デフォルトの URL：/api/sn_cdm/changesets/activity

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

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

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

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    changesetNumber 必須。
    関連する変更セットの一意の識別子 (「Chset-10」など)。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    returnFields 応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。

    データタイプ：アレイ

    デフォルト：エンドポイントによって決定されるすべてのフィールド
    表 : 15. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    changeset_id 要求された変更セットの詳細。

    データタイプ：オブジェクト

    "changeset_id": {
  "link": "String",
  "value": "String"
}
    changeset_id.link 関連付けられた変更セットを取得するためのテーブル REST エンドポイントの呼び出しに使用するクエリ。

    データタイプ：文字列
    changeset_id.value 関連付けられた変更セットの sys_id。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    conflict 関連付けられた変更セットに競合があるかどうかを示すフラグ。
    有効な値：
    • true：競合が検出されました。
    • false：競合は見つかりませんでした。

    データタイプ：ブーリアン
    作成日時 ノードが作成された日時。

    形式：YYYY-mm-DD hh:mm:ss

    データタイプ：文字列
    created_by ノードを作成するユーザーのユーザー名。たとえば、able.tuter などです。

    データタイプ：文字列
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    name_path ノードパス名。

    データタイプ：文字列
    new_name ノードの現在の名前。

    データタイプ：文字列
    new_value ノードの現在の値。リーフノードとアレイリテラルに使用します。

    データタイプ：文字列
    old_name ノードの以前の名前。

    データタイプ：文字列
    old_value ノードの以前の値。リーフノードとアレイリテラルに使用します。

    データタイプ：文字列
    updated ノードが最後に更新された日時。

    形式：YYYY-mm-DD hh:mm:ss

    データタイプ：文字列
    updated_by ノードを最後に更新したユーザーのユーザー名。たとえば、able.tuter などです。

    データタイプ：文字列
    secure 関連付けられたリーフノードがセキュリティ保護されたかどうかを示すフラグ。
    有効な値：
    • true：ノードはセキュリティ保護されています。
    • false：ノードはセキュリティ保護されていません。

    データタイプ：ブーリアン
    type
    ノードタイプ。
    可能な値：
    • sn_cdm_node_collection
    • sn_cdm_node_component
    • sn_cdm_node_folder
    • sn_cdm_node_cdi
    • sn_cdm_node_variable

    データタイプ：文字列

    cURL 要求

    このコード例は、特定の変更セットのノード変更を取得する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/activity?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": [ 
    { 
      "sys_id": "ed5d6c0f53141110a1d3ddeeff7b1233", 
      "changeset_id": "955d6c0f53141110a1d3ddeeff7b1233", 
      "new_value": null, 
      "new_state": "Deleted", 
      "new_name": "Dep-1", 
      "new_type": "Deployable", 
      "new_encrypted": false, 
      "updated_on": "2022-06-29 13:09:46", 
      "updated_by": "admin", 
      "resolution_method": "", 
      "conflict": null, 
      "path": "deployables/Dep-1", 
      "created_by": null, 
      "created_on": null, 
      "old_value": null, 
      "old_state": "Superseded", 
      "old_name": "Dep-1", 
      "old_type": "Deployable", 
      "old_encrypted": false 
    } 
] 
}

    CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id}

    指定された変更セットのコミット要求の現在のステータスを返します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/commit-status/{commit_id}

    デフォルトの URL：/api/sn_cdm/changesets/commit-status/{commit_id}

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

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

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

    データタイプ：文字列
    commit_id ステータスを返すコミット要求の sys_id。

    この値は CdmChangesetsApi - POST /sn_cdm/changesets/{changeset_id}/commit エンドポイントによって返されます。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    commit_id 要求レコード sys_id をコミットします。エンドポイントに渡されるものと同じです。

    データタイプ：文字列
    errors アップロード中に発生したエラーの説明。

    データタイプ：文字列
    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：コミット後に検証に合格したスナップショットのみを公開します。

    スナップショットの公開の詳細については、「 スナップショットの公開または非公開」を参照してください。

    データタイプ：文字列

    デフォルト：publish_none
    output.snapshot_description 関連付けられたスナップショットの説明。

    データタイプ：文字列
    output.snapshot_name 関連付けられたスナップショットの名前。

    データタイプ：文字列
    output.state アップロードコンテンツのステータス。
    可能な値：
    • committed
    • completed
    • error
    • in_progress
    • new
    • ready

    データタイプ：文字列
    output.sys_created_by レコードを作成したエンティティの sys_id。

    データタイプ：文字列
    output.sys_id 変更セットを含むレコードの sys_id。

    データタイプ：文字列
    output.title アップロードの一部として作成された変更セットのタイトル。

    データタイプ：文字列
    processing_state コミット要求の現在の処理ステータス。
    可能な値：
    • NOT_PROCREED
    • PROCESSED

    データタイプ：文字列
    request_id 要求 ID。エンドポイントと commit_id に渡されるものと同じです。

    データタイプ：文字列
    state 指定されたコミットの現在のステータス。
    可能な値：
    • completed
    • error
    • in_progress
    • new
    • ready

    データタイプ：文字列

    テーブル:CDM 要求キュー [sn_cdm_request_queue] テーブルの state 列の値。
    type 要求のタイプ。
    可能な値：
    • commit
    • export
    • upload_and_commit

    データタイプ：文字列

    cURL 要求

    次の例は、このエンドポイントを呼び出して、指定されたコミットのステータスを取得する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit-status/bf506e69537c3010a1d3ddeeff7b12c0"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    成功応答とエラー応答の例を次に示します。

    
// Successful response 

{ 
  "result": { 
    "type": "commit", 
    "state": "completed", 
    "output": { 
      "sys_id": "4a4407e953124110da35ddeeff7b1235", 
      "number": "Chset-1207", 
      "title": "admin064407e953124110da35ddeeff7b1235", 
      "description": "A description of my changeset provided during creation", 
      "committed_at": "2022-03-17 22:19:33", 
      "committed_by": "6816f79cc0a8016401c5a33be04be441", 
      "sys_created_by": "admin", 
      "state": "committed", 
      "publish_option": "publish_none", 
      "auto_validate": false, 
      "snapshot_name": null, 
      "snapshot_description": null, 
      "cdm_application": "DemoApp", 
      "last_conflict_detection_time": null 
    }, 
    "processing_state": "PROCESSED", 
    "commit_id": "9cd583e953124110da35ddeeff7b128a" 
  } 
} 

 

// Example of an error response 

{ 
  "result": { 
    "state": "error", 
    "errors": "Invalid requestId '9cd583e953124110da35ddeeff7b128'", 
    "commit_id": "9cd583e953124110da35ddeeff7b128" 
  } 
}

    CdmChangesetsApi - GET /sn_cdm/changesets/impacted-deployables

    指定された変更セットに関連付けられている展開可能項目のリストを返します。

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

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/impacted-deployables

    デフォルトの URL：/api/sn_cdm/changesets/impacted-deployables

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

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

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

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    changesetNumber 必須。
    関連する変更セットの一意の識別子 (「Chset-10」など)。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    returnFields 応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。

    データタイプ：アレイ

    デフォルト：エンドポイントによって決定されるすべてのフィールド
    表 : 27. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 28. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 30. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    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]
    説明 生成された CDM 展開可能項目の説明。

    データタイプ：文字列
    environment_type 展開可能な環境タイプ。
    可能な値：
    • 開発
    • 本番
    • テスト

    データタイプ：文字列
    error 処理中にエラーが発生した場合にのみ返されます。

    データタイプ：オブジェクト

    "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 展開可能項目に対して作成されたスナップショットの数。

    データタイプ：数値 (整数)
    状況 展開可能項目の現在のステータス。
    可能な値：
    • active
    • deleted

    データタイプ：文字列
    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

    cURL 要求

    次のコード例は、指定された変更セットの影響を受ける展開可能項目を取得する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/impacted-deployables?changesetNumber=Chset-783" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": [ 
    { 
      "cmdb_ci": { 
        "value": "75c5d7a953b70110a1d3ddeeff7b12a2", 
        "link": "http://instance.servicenow.com/api/now/table/cmdb_ci_service_auto/75c5d7a953b70110a1d3ddeeff7b12a2" 
      }, 
      "cdi_count": "2", 
      "snapshot_version_counter": "3", 
      "description": null, 
      "sys_updated_on": "2022-06-29 16:19:05", 
      "environment_type": "Development", 
      "node": { 
        "value": "a1c517a953b70110a1d3ddeeff7b129b", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_node/a1c517a953b70110a1d3ddeeff7b129b" 
      }, 
      "sys_id": "6dc517a953b70110a1d3ddeeff7b129b", 
      "sys_updated_by": "admin", 
      "cdm_app": { 
        "value": "62b517a953b70110a1d3ddeeff7b128c", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
      }, 
      "sys_created_on": "2022-05-31 13:03:23", 
      "cdi_usage": "0.02", 
      "name": "Development_1", 
      "state": "active", 
      "sys_created_by": "admin" 
    } 
  ] 
}

    CdmChangesetsApi:/sn_cdm/changesets/impacted-shared-components を取得

    指定された変更セットに関連付けられている共有コンポーネントのリストを返します。

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

    URL 形式

    バージョニングされた URL: /api/sn_cdm/{api_version}/changesets/impacted-shared-components

    デフォルト URL: /api/sn_cdm/changesets/impacted-shared-components

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

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

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

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    changesetNumber 必須。
    関連する変更セットの一意の識別子 (「Chset-10」など)。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    returnFields 応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。

    データタイプ：アレイ

    デフォルト：エンドポイントによって決定されるすべてのフィールド
    表 : 33. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 34. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 36. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。渡された変更セットは存在しません。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    cdm_shared__library コンポーネントが存在する共有ライブラリのSys_id。

    データタイプ：文字列
    説明 CDM 共有コンポーネントの説明。

    データタイプ：文字列
    error 処理中にエラーが発生した場合にのみ返されます。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail 発生したエラーの詳細。

    データタイプ：文字列
    error.message エラーの概要を示すメッセージ。

    データタイプ：文字列
    名前 CDM 共有コンポーネントの名前。

    データタイプ：文字列
    node 共有コンポーネントノードのSys_id。

    データタイプ：文字列

    テーブル:CDM ノード [sn_cdm_node]
    node_main 共有コンポーネントノードレコードのmain_id Sys_id。

    データタイプ：文字列

    テーブル:CDM ノードメイン [sn_cdm_node_main]
    状況 共有コンポーネントの現在のステータス。
    可能な値：
    • active
    • deleted

    データタイプ：文字列
    sys_created_by CDM 共有コンポーネントを作成するユーザーのユーザー名。たとえば、able.tuter などです。

    データタイプ：文字列
    sys_created_on CDM 共有コンポーネントが作成された日時。

    形式：YYYY-mm-DD hh:mm:ss

    データタイプ：文字列
    sys_id 共有コンポーネントのSys_id。

    データタイプ：文字列

    テーブル:CDM 共有コンポーネント [sn_cdm_shared_component]
    sys_updated_by CDM 共有コンポーネントを最後に更新したユーザーの名前。たとえば、able.tuter などです。

    データタイプ：文字列
    sys_updated_on CDM 共有コンポーネントが最後に更新された日時。

    形式：YYYY-mm-DD hh:mm:ss

    データタイプ：文字列
    version_counter 共有コンポーネントに対して作成されたバージョンの数。

    データタイプ：整数

    cURL 要求

    次のコード例は、changeset = "Chset-20" の影響を受ける共有コンポーネントを取得する方法を示しています。

    curl "https://instance.servicenow.com/sn_cdm/changesets/impacted-shared-components?changesetNumber=Chset-20" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    応答：

    {
  "result": [
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "3cb945e097b3991052687b890353af0d",
      "sys_id": "34b945e097b3991052687b890353af20",
      "sys_updated_by": "john.jones",
      "node_main": "74b945e097b3991052687b890353af0d",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.1",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "b0b945e097b3991052687b890353af11",
      "sys_id": "30b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "f8b945e097b3991052687b890353af10",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "logonService-V2.2",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "6cb905e097b3991052687b890353afd3",
      "sys_id": "b4b945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "a4b905e097b3991052687b890353afd3",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.0",
      "state": "active",
      "sys_created_by": "john.jones"
    },
    {
      "version_counter": "1",
      "description": null,
      "cdm_shared_library": "acb905e097b3991052687b890353afcd",
      "sys_updated_on": "2022-12-12 20:28:49",
      "node": "e0b905e097b3991052687b890353aff1",
      "sys_id": "3cb945e097b3991052687b890353af21",
      "sys_updated_by": "john.jones",
      "node_main": "2cb905e097b3991052687b890353aff0",
      "sys_created_on": "2022-12-12 20:28:39",
      "name": "paymentService-V1.1",
      "state": "active",
      "sys_created_by": "john.jones"
    }
  ]
}

    CdmChangesetsApi - GET /sn_cdm/changesets/{changeset_id}/impacted-deployables

    指定された変更セットに関連付けられている展開可能項目のリストを返します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/{changeset_id}/impacted-deployables

    デフォルトの URL：/api/sn_cdm/changesets/{changeset_id}/impacted-deployables

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

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

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

    データタイプ：文字列
    changeset_id 処理する変更セットレコードの sys_id。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    表 : 38. クエリパラメーター
    名前 説明
    なし
    表 : 39. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 40. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 42. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    changeset_id 展開可能ノードに関連付けられた最後の変更セットの sys_id。

    データタイプ：文字列
    conflict 関連付けられた展開可能項目に競合があるかどうかを示すフラグ。
    可能な値：
    • 0：競合していません。
    • 1：競合しています - 詳細については、返される conflict_type の結果を参照してください。

    データタイプ：数値
    conflict_type 展開可能項目の競合のタイプ。
    可能な値：
    • corrupted_node
    • deleted_node
    • duplicated_node
    • incomplete_deleted_parent
    • incomplete_deleted_ref
    • incomplete_renamed_ref
    • invalid_include
    • orphaned_descendant
    • related_conflict
    • unlinked_include
    • unrenamed_include
    • updated_node

    データタイプ：文字列
    説明 展開可能ノードの説明。

    データタイプ：文字列
    effective_from ノードが有効になった時点のタイムスタンプ。ノードが作成された変更セットをコミットするまで、この値は null です。

    データタイプ：数値
    effective_to ノードが有効でなくなった時点のタイムスタンプ。この値が null の場合、ノードは新しいバージョンに置き換えられるまで有効なままです。

    データタイプ：数値
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    レベル アプリケーションレベル (0) から始まるノードの深度。

    データタイプ：数値
    linked_to コレクションおよびコンポーネント内の参照ノードの ID。

    たとえば、次のノードスニペットは、コレクション collA とコンポーネント compA の間のリンクを示しています。この例では、linkedTo 値は 1 です。

    { 
components : {compA:{} //MainId: 1}, 

Collections : { collA : {  
   compA :{} //Include, linkedTo: 1 
    } 
  } 
}

    データタイプ：文字列
    main_id 展開可能ノードの一意の識別子。この値は、ノードの作成時に生成され、展開可能ノードを識別するために使用されます。

    データタイプ：数値
    main_id_encoded mainId のエンコード値は、基数 57 の文字列表現を使用して結果を返します。

    データタイプ：文字列
    name 展開可能項目の名前。

    データタイプ：文字列
    node_classifier 開発、本番、テストなどのノード分類。

    次の形式を使用します。

    • /application/deployables/env:Development
    • /application/deployables/env:Production
    • /application/deployables/env:Test

    データタイプ：文字列
    position 展開可能ノードの位置。アレイにのみ適用されます。

    たとえば、アレイの場合、次のようになります。

    node1:{
  arrayNode: [{}, "literal1", "literal2", []] }

    {} は位置 1000 です。

    "literal1" は位置 2000 です。

    "literal2" は位置 3000 です。

    [] は位置 4000 です。

    データタイプ：数値
    previous_version 関連付けられた展開可能ノードの以前のバージョンの sys_id。

    データタイプ：文字列
    restricted_to 関連付けられた展開可能ノードへのアクセスが許可されているユーザーの sys_id のリスト。すべてのグループが展開可能項目にアクセスできる場合、この値は null です。

    データタイプ：文字列

    テーブル:CDM 制限付きグループ [sn_cdm_restricted_groups]
    secure_value CDI または変数の安全な値。リーフノードとアレイリテラルについてのみ返されます。これは value で返される結果と同じですが、暗号化されています。

    データタイプ：文字列
    status 展開可能ノードのステータスまたは失敗した要求のステータス。
    可能な値：
    • deleted
    • failure (エンドポイント呼び出しが失敗した場合に渡されます。)
    • new
    • superseded
    • updated
    • valid

    データタイプ：文字列
    system_folder 関連付けられたフォルダーがシステムフォルダーかどうかを示すフラグ。
    可能な値：
    • 0：システムフォルダーではありません。
    • 1：システムフォルダーです。

    データタイプ：数値
    sys_id 影響を受ける展開可能項目の sys_id。

    データタイプ：文字列
    type ノードタイプ (sn_cdm_node_deployable など)。この値により、ノードがコンポーネント、構成データアイテム (CDI)、または展開可能のいずれであるかを判断できます。この値は、ノードの作成時に生成されます。

    データタイプ：文字列
    value CDI または変数の値。リーフノードとアレイリテラルについてのみ返されます。この情報が暗号化されている場合は、secure_value の結果で返されます。

    たとえば、このノードが CDI nodeA:{cdi1: 1} である場合、value の返される結果は 1 です。node1: {arrayNode: [{}, "literal1", "literal2", []]} などのアレイノードの場合、value の返される結果は literal1 です。

    データタイプ：文字列

    cURL 要求

    次の例は、sys_id が bf506e69537c3010a1d3ddeeff7b12c0 である変更セットに関連付けられている展開可能項目を要求する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/bf506e69537c3010a1d3ddeeff7b12c0/impacted-deployables"\ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    このエンドポイントの成功応答とエラー応答の両方を次に示します。

    // Successful response
{
  "result": [
    {
      "sys_id": "833527a953924110da35ddeeff7b12c1",
      "type": "sn_cdm_node_deployable",
      "main_id": "150",
      "main_id_encoded": "&M",
      "node_path": "!&@!&D!&M",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Development",
      "position": null,
      "restricted_to": null,
      "changeset_id": "cb3527a953924110da35ddeeff7b12c0",
      "previous_version": "e8946f6953924110da35ddeeff7b1264",
      "effective_from": "1647563806950",
      "effective_to": null,
      "name": "Development_1",
      "description": "dev deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    },
    {
      "sys_id": "a245e7a953924110da35ddeeff7b1223",
      "type": "sn_cdm_node_deployable",
      "main_id": "153",
      "main_id_encoded": "&P",
      "node_path": "!&@!&D!&P",
      "level": 2,
      "status": "valid",
      "node_classifier": "/application/deployables/env:Test",
      "position": null,
      "restricted_to": null,
      "changeset_id": "ea45e7a953924110da35ddeeff7b1222",
      "previous_version": "9505ef6953924110da35ddeeff7b121a",
      "effective_from": "1647563821422",
      "effective_to": null,
      "name": "Test_1",
      "description": "test deployable decription",
      "value": null,
      "secure_value": null,
      "system_folder": "0",
      "linked_to": null,
      "conflict": "0",
      "conflict_type": null
    }
  ]
} 

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

    CdmChangesetsApi - POST /sn_cdm/changesets/{changeset_id}/commit

    指定された変更セットをコミットします。コミットされると、変更セットは関連付けられたインスタンス内の CDM テーブルに保持されます。

    アプリケーションが更新され、変更は変更セット内の構成データに保持されます。変更セットのステータスが [コミット済み] に変更されます。次に、変更セットの影響を受ける各展開可能項目のスナップショットが生成されます。

    このエンドポイントにより、コミット要求の ID が返されます。この ID を使用して CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id} エンドポイントを呼び出し、変更セットのコミットの現在のステータスを取得します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

    デフォルトの URL：/api/sn_cdm/changesets/{changeset_id}/commit

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

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

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

    データタイプ：文字列
    changeset_id 処理する変更セットレコードの sys_id。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    表 : 44. クエリパラメーター
    名前 説明
    autoValidate コミット時に作成されたスナップショットが検証されるかどうか、つまり、関連付けられたポリシーがスナップショットに対して実行されるかどうかを示すフラグ。
    有効な値：
    • true：スナップショットを検証します。
    • false：スナップショットを検証しません。

    デフォルト値：false
    publishOption 関連付けられた構成スナップショットの公開オプション。
    有効な値：
    • publish_none：スナップショットを公開しません。
    • publish_valid：コミット後に検証に合格したスナップショットのみを公開します。
    注:
    このオプションは、 autoCommit パラメーターの値が true の場合にのみ使用できます。

    スナップショットの公開の詳細については、「 スナップショットの公開または非公開」を参照してください。

    データタイプ：文字列

    デフォルト：publish_none
    表 : 45. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 46. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 47. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 48. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。エラー：<エラーメッセージ>

    渡した changeset_id パラメーターが正しいことを検証します。

    このエンドポイントにアクセスするために必要なロールがあることを確認してください。
    500 内部サーバーエラー「エラー：無効なブール値。」

    autoValidate パラメーターを渡した場合は、それがブール値であることを確認します。

    応答本文のパラメーター

    [Name (名前)] 説明
    commit_id コミット要求の sys_id。

    この ID は、 CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id} エンドポイントを呼び出してコミット要求のステータスを確認するときに使用します。

    データタイプ：文字列
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    status コミットのステータス。エラーが発生した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    次の例は、このエンドポイントを呼び出して変更セットレコードをコミットする方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/29e24001533030104bacddeeff7b120c/commit?publishOption=publish_valid"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    変更セットのコミット要求が成功した場合の応答を次に示します。

    // Successful response
{ 
  "result": { 
    "commit_id": "64b5f79f5379301096edddeeff7b12eb" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in commit request.Error:Failed to insert request in queue",
    "detail": ""
  },
  "status": "failure"
}

    CdmChangesetsApi - POST /sn_cdm/changesets/create

    指定された CDM アプリケーションまたは共有ライブラリの新しい変更セットをオープンステータスで作成します。

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

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/create/

    デフォルトの URL：/api/sn_cdm/changesets/create/

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

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

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

    データタイプ：文字列
    表 : 50. クエリパラメーター
    名前 説明
    appName 必須。この変更セットに関連付ける CDM アプリケーションまたは共有ライブラリの名前。これは、アクティブなアプリケーションまたは共有ライブラリである必要があります。

    データタイプ：文字列
    説明 変更セットの説明。他のユーザーが変更セットの目的を理解できるような説明を入力します。

    データタイプ：文字列

    デフォルト：なし
    returnFields 応答の一部として返す CDM 変更セット [sn_cdm_changeset] テーブル内のフィールドのカンマ区切りリスト。

    データタイプ：文字列
    表 : 51. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 52. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 53. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 54. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。エラー：<エラーメッセージ>

    指定された CDM アプリケーションまたは共有ライブラリが存在し、アクティブ状態であることを確認します。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    auto_validate

    自動検証が実行されたかどうかを示すフラグ。

    可能な値：
    • true:自動検証が実行されました。
    • false:自動検証が実行されていません。

    データタイプ：ブーリアン
    cdm_application 変更セットに関連付けられた CDM アプリケーションの詳細。

    データタイプ: オブジェクト

    "cdm_application": { 
  "link": "String",
  "value": "String"
}
    例: {"value": "<sysId>", "link": "http://localhost:8081/api/now/table/*'}"
    cdm_application.link 関連する CDM アプリケーションの URL。

    データタイプ：文字列
    cdm_application.value 関連付けられた CDM アプリケーションの sys_id。

    データタイプ：文字列
    committed_at 変更セットが関連付けられたリポジトリにコミットされた日時。

    データタイプ：文字列
    committed_by 変更セットを作成したエンティティの sys_id。

    データタイプ：文字列
    説明 エンドポイントが呼び出されたときに渡された変更セットの説明。

    データタイプ：文字列
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    last_conflict_detection_time 前回競合の検出が実行されたとき。

    データタイプ：数値

    単位：ミリ秒
    番号 新しい変更セットの一意の識別子。

    データタイプ：文字列
    publish_option
    関連付けられた構成済みスナップショットの公開オプション。
    有効な値：
    • publish_none:スナップショットを公開しません。
    • publish_valid：コミット後に検証に合格したスナップショットのみを公開します。

    スナップショットの公開の詳細については、「 スナップショットの公開または非公開」を参照してください。

    データタイプ：文字列

    デフォルト：publish_none
    snapshot_description 変更セットに関連付けられたスナップショットの説明。

    データタイプ：文字列
    state 変更セット作成のステータス。
    可能な値：
    • ブロック済み
    • 競合をチェックしています
    • コミットに失敗しました
    • コミット進行中
    • コミット済み
    • オープン

    データタイプ：文字列
    status 変更セット作成のステータス。エラーが発生した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列
    sys_created_by 変更セットレコードを作成したエンティティの sys_id。

    データタイプ：文字列
    sys_id 新しい変更セットの sys_id。

    データタイプ：文字列
    title アプリケーションに関連付けられた変更セットのタイトル。通常はシステムによって自動生成されます。

    データタイプ：文字列

    cURL 要求

    次の例は、App Service1 CDM アプリケーションに関連付けられた変更セットを作成する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?appName=App%20Service1&description=Sample%20Description \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

    変更セットの作成が成功した場合の応答を次に示します。

    // Example of a successful response
{   
"result": { 
    "sys_id": "42748779c370301054c1582e1340ddcd",
    "number": "Chset-8",
    "title": "admin2021-06-18 10:06:46",
    "description": null,
    "committed_at": "",
    "committed_by": null,
    "sys_created_by": "admin",
    "state": "open",
    "publish_option": "publish_none",
    "auto_validate": false,
    "snapshot_name": null,
    "snapshot_description": null,
    "cdm_application": "App%20Service1" 
  } 
}

// Example of an error response
{
  "error": {
    "message": "Error: Unexpected error occurred in create request.Error:Application not found",
    "detail": ""
  },
  "status": "failure"
}

    cURL 要求

    次の例は、共有ライブラリ「javalib」の変更セットを作成する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/create?sharedLibraryName=javalib&description=description of changeset" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    応答：

    CdmChangesetsApi - PUT /sn_cdm/changesets/commit

    指定された変更セットを更新してコミットします。

    アプリケーションが更新され、変更は変更セット内の構成データに保持されます。変更セットのステータスが [コミット済み] に変更されます。次に、変更セットの影響を受ける各展開可能項目のスナップショットが生成されます。

    このエンドポイントにより、コミット要求の ID が返されます。この ID を使用して CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id} エンドポイントを呼び出し、変更セットのコミットの現在のステータスを取得します。

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/changesets/{changeset_id}/commit

    デフォルトの URL：/api/sn_cdm/changesets/{changeset_id}/commit

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

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

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

    データタイプ：文字列
    表 : 56. クエリパラメーター
    名前 説明
    autoValidate コミット中に作成されたスナップショットが検証されるかどうか、つまり関連するポリシーがスナップショットに対して実行されるかどうかを示すフラグ。
    有効な値：
    • true：スナップショットを検証します。
    • false:スナップショットを検証しません。

    データタイプ：ブーリアン

    デフォルト値：false
    changesetNumber 必須。
    関連する変更セットの一意の識別子 (「Chset-10」など)。

    データタイプ：文字列

    テーブル:CDM 変更セット [sn_cdm_changeset]
    publishOption
    関連付けられた構成済みスナップショットの公開オプション。
    有効な値：
    • publish_none:スナップショットを公開しません。
    • publish_valid：コミット後に検証に合格したスナップショットのみを公開します。

    スナップショットの公開の詳細については、「 スナップショットの公開または非公開」を参照してください。

    データタイプ：文字列

    デフォルト：publish_none
    表 : 57. 要求本文パラメーター
    名前 説明
    なし

    ヘッダー

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

    表 : 58. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。application/json のみをサポートします。
    Content-Type 要求本文のデータ形式。application/json のみをサポートします。
    表 : 59. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 60. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。エラー：<エラーメッセージ>

    渡した changeset_id パラメーターが正しいことを検証します。

    このエンドポイントにアクセスするために必要なロールがあることを確認してください。
    500 内部サーバーエラー：無効なブール値。

    autoValidate パラメーターを渡した場合は、それがブール値であることを確認します。

    応答本文のパラメーター

    [Name (名前)] 説明
    commit_id コミット要求の sys_id。

    この ID は、 CdmChangesetsApi - GET /sn_cdm/changesets/commit-status/{commit_id} エンドポイントを呼び出してコミット要求のステータスを確認するときに使用します。

    データタイプ：文字列
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

    データタイプ：オブジェクト

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail エラーに関する追加情報。

    データタイプ：文字列
    error.message 要求の処理を試行中に生成されたエラーメッセージ。

    データタイプ：文字列
    status コミットのステータス。エラーが発生した場合にのみ返されます。

    可能な値：failure

    データタイプ：文字列

    cURL 要求

    次のコード例は、このエンドポイントを使用して変更セットを更新する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/changesets/commit?changesetNumber=Chset-146" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": { 
    "commit_id": "cca8190f53141110a1d3ddeeff7b129e" 
  } 
}