CdmSnapshotApi

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/publish

公開を中止された指定のスナップショットを公開します。

スナップショットを公開する前に、検証する必要があります。CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/publish エンドポイントを使用してスナップショットを検証するか、コミット時に自動的に検証されるようにできます。スナップショットを公開するには、展開可能項目をサービスに接続する必要があります。また、スナップショットが既に公開されている場合、要求は失敗します。

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/{snapshot_id}/publish

注:

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

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

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

表 : 2. クエリパラメーター
名前	説明
なし

表 : 3. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

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

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)


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

cURL 要求

次の例は、sys_id が 3a168d9dc342301054c1582e1340dd68 のスナップショットを公開する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/publish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

以下は、公開要求に対する成功応答と失敗応答の両方を示しています。

// Example of a successful response
{ 
  "" 
}

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

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/unpublish

以前に公開されたスナップショットの公開を中止します。

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/{snapshot_id}/unpublish

注:

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

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

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

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

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

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

ステータスコード

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

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

応答本文のパラメーター (JSON または XML)


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

cURL 要求

次の例は、sys_id が 3a168d9dc342301054c1582e1340dd68 のスナップショットの公開を中止する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/unpublish"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

以下は、公開中止要求に対する成功応答と失敗応答の両方を示しています。

// Example of a successful response
{ 
  "" 
}

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

CdmSnapshotAPI - POST /sn_cdm/snapshots/{snapshot_id}/publish

公開を中止された指定のスナップショットを検証します。

検証は非同期プロセスとして実行されます。このエンドポイントを呼び出すと、検証プロセスの開始のみが行われます。この呼び出しから返される結果は、検証自体の結果ではなく、検証プロセスが開始されたかどうかに限られます。スナップショットが検証されたかどうかを確認するには、テーブル API を使用してスナップショットを特定し、その検証ステータスを確認します。

注:

公開されたスナップショットは検証できません。

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/{snapshot_id}/validate

注:

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

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

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

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

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

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

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

ステータスコード

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

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。指定されたスナップショットは既に公開されているか、見つけることができません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)


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

cURL 要求

次の例は、sys_id が 3a168d9dc342301054c1582e1340dd68 のスナップショットを検証する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/3a168d9dc342301054c1582e1340dd68/validate"\ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \
--user 'username':'password'

以下は、検証要求に対する成功応答と失敗応答の両方を示しています。

// Example of a successful response
{ 
  "" 
}

// Example of an error response
{
  "error": {
    "message": "Invalid Snapshot id:test",
    "detail": ""
  },
  "status": "failure"
}

CdmSnapshotApi - PUT /sn_cdm/snapshots/publish

公開を中止された指定のスナップショットを公開します。

スナップショットを公開する前に、検証する必要があります。CdmSnapshotApi - PUT /sn_cdm/snapshots/validate エンドポイントを使用してスナップショットを検証するか、コミット時に自動的に検証されるようにできます。スナップショットを公開するには、展開可能項目をサービスに接続する必要があります。また、スナップショットが既に公開されている場合、要求は失敗します。

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

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/publish

注:

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

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

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

表 : 20. クエリパラメーター
名前	説明
appName	必須です。スナップショットを作成する構成データ管理 (CDM) アプリケーションの名前。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
deployableName	必須です。スナップショットを作成する CDM 展開可能項目の名前。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
名前	必須です。スナップショットの名前。データタイプ：文字列テーブル:CDM スナップショット [sn_cdm_snapshot]
returnFields	応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。データタイプ：アレイデフォルト：エンドポイントによって決定されるすべてのフィールド

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

ヘッダー

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

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

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

ステータスコード

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

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

応答本文のパラメーター


[Name (名前)]	説明
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	テーブル REST API を使用してこの展開可能レコードをクエリするための呼び出し構文。データタイプ：文字列
cdm_deployable_id.value	展開可能レコードの sys_id。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
changeset_id	スナップショットに関連付けられた変更セットに関する詳細。データタイプ: オブジェクト `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	テーブル REST API を使用してこの変更セットレコードをクエリーするための呼び出し構文。データタイプ：文字列
changeset_id.value	変更セットレコードの一意の識別子。データタイプ：文字列テーブル:CDM 変更セット [sn_cdm_changeset]
説明	スナップショットの簡単な説明。データタイプ：文字列
error	処理中にエラーが発生した場合は、エラーに関する詳細。データタイプ：オブジェクト `"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 failed in_progress not_validated passed passed_with_exception requested データタイプ：文字列

cURL 要求

このコード例は、スナップショットを公開する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/publish?deployableName=Development_1&name=Development_1-v1.dpl&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

返される結果：

 
{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": true, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}

CdmSnapshotApi - PUT /sn_cdm/snapshots/unpublish

以前に公開されたスナップショットの公開を中止します。

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/unpublish

注:

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

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

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

表 : 26. クエリパラメーター
名前	説明
appName	必須です。スナップショットを作成する構成データ管理 (CDM) アプリケーションの名前。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
deployableName	必須です。スナップショットを作成する CDM 展開可能項目の名前。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
名前	必須です。スナップショットの名前。データタイプ：文字列テーブル:CDM スナップショット [sn_cdm_snapshot]
returnFields	応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。データタイプ：アレイデフォルト：エンドポイントによって決定されるすべてのフィールド

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

ヘッダー

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

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

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

ステータスコード

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

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

応答本文のパラメーター


[Name (名前)]	説明
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	テーブル REST API を使用してこの展開可能レコードをクエリするための呼び出し構文。データタイプ：文字列
cdm_deployable_id.value	展開可能レコードの sys_id。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
changeset_id	スナップショットに関連付けられた変更セットに関する詳細。データタイプ: オブジェクト `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	テーブル REST API を使用してこの変更セットレコードをクエリーするための呼び出し構文。データタイプ：文字列
changeset_id.value	変更セットレコードの一意の識別子。データタイプ：文字列テーブル:CDM 変更セット [sn_cdm_changeset]
説明	スナップショットの簡単な説明。データタイプ：文字列
error	処理中にエラーが発生した場合は、エラーに関する詳細。データタイプ：オブジェクト `"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 failed in_progress not_validated passed passed_with_exception requested データタイプ：文字列

cURL 要求

このコード例は、スナップショットの公開を中止する方法を示しています。

返される結果：

CdmSnapshotApi - PUT /sn_cdm/snapshots/validate

公開を中止された指定のスナップショットを、マップされたポリシーに対して検証します。

検証は非同期プロセスとして実行されます。このエンドポイントを呼び出すと、検証プロセスの開始のみが行われます。この呼び出しから返される結果は、検証自体の結果ではなく、検証プロセスが開始されたかどうかに限られます。スナップショットが検証されたかどうかを確認するには、テーブル API を使用してスナップショットを特定し、その検証ステータスを確認します。

注:

公開されたスナップショットは検証できません。

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

URL 形式

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

デフォルトの URL：/api/sn_cdm/snapshots/validate

注:

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

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

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

表 : 32. クエリパラメーター
名前	説明
appName	必須です。スナップショットを作成する構成データ管理 (CDM) アプリケーションの名前。データタイプ：文字列テーブル:CDM アプリケーション [sn_cdm_application]
deployableName	必須です。スナップショットを作成する CDM 展開可能項目の名前。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
名前	必須です。スナップショットの名前。データタイプ：文字列テーブル:CDM スナップショット [sn_cdm_snapshot]
returnFields	応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。データタイプ：アレイデフォルト：エンドポイントによって決定されるすべてのフィールド

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

ヘッダー

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

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

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

ステータスコード

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

表 : 36. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。指定されたスナップショットは既に公開されているか、見つけることができません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター


[Name (名前)]	説明
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	テーブル REST API を使用してこの展開可能レコードをクエリするための呼び出し構文。データタイプ：文字列
cdm_deployable_id.value	展開可能レコードの sys_id。データタイプ：文字列テーブル:CDM 展開可能 [sn_cdm_deployable]
changeset_id	スナップショットに関連付けられた変更セットに関する詳細。データタイプ: オブジェクト `"changeset_id": { "link": "String", "value": "String" }`
changeset_id.link	テーブル REST API を使用してこの変更セットレコードをクエリーするための呼び出し構文。データタイプ：文字列
changeset_id.value	変更セットレコードの一意の識別子。データタイプ：文字列テーブル:CDM 変更セット [sn_cdm_changeset]
説明	スナップショットの簡単な説明。データタイプ：文字列
error	処理中にエラーが発生した場合は、エラーに関する詳細。データタイプ：オブジェクト `"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 failed in_progress not_validated passed passed_with_exception requested データタイプ：文字列

cURL 要求

このコード例は、スナップショットを検証する方法を示しています。

curl "http://instance.servicenow.com/api/sn_cdm/snapshots/validate?name=Development_1-v2.dpl&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

返される結果：

{ 
  "result": { 
    "changeset_id": { 
      "value": "d4b9446e53001110a1d3ddeeff7b126c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d4b9446e53001110a1d3ddeeff7b126c" 
    }, 
    "cdm_deployable_id": { 
      "value": "6dc517a953b70110a1d3ddeeff7b129b", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_deployable/6dc517a953b70110a1d3ddeeff7b129b" 
    }, 
    "description": null, 
    "cdm_application_id": { 
      "value": "62b517a953b70110a1d3ddeeff7b128c", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_application/62b517a953b70110a1d3ddeeff7b128c" 
    }, 
    "published": false, 
    "sys_updated_on": "2022-06-30 12:57:02", 
    "last_published": "2022-06-30 12:57:02", 
    "number": "SNAP0001002", 
    "sys_id": "9017fc2e53801110a1d3ddeeff7b12d7", 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-15 14:19:38", 
    "name": "Development_1-v2.dpl", 
    "last_validated": "2022-06-30 12:56:07", 
    "validation": "passed", 
    "sys_created_by": "admin" 
  } 
}