CdmPoliciesApi

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：30分

    • CdmPoliciesApi は、構成データ管理 (CDM) での展開可能項目のポリシーマッピングの管理を可能にするエンドポイントを提供します。展開可能項目に適切にマッピングされたポリシーは、展開可能項目のスナップショットの検証時に実行されます。

    この API のエンドポイントにアクセスするには、次のいずれかのロールが必要です。
    • スクリプト化された REST CDM ビュー ACL
    • スクリプト化された REST CDM 管理者 ACL

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

    ポリシーマッピングの詳細については、「 展開可能項目へのポリシーのマッピング」を参照してください。

    CdmPoliciesApi - DELETE /sn_cdm/policies/mappings

    指定されたポリシーの展開可能項目へのマッピングを削除します。

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

    URL 形式

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

    デフォルトの URL：/api/sn_cdm/policies/mappings

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

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

    データタイプ：文字列
    表 : 2. クエリパラメーター
    名前 説明
    appName 必須です。ポリシーへのマッピングを削除する 構成データ管理 (CDM) アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    deployableName 必須です。ポリシーへのマッピングを削除する CDM 展開可能項目の名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    policyName 必須です。関連付けられたポリシーの名前。ポリシー [sn_pace_policy] テーブルにあります。

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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。渡された policyName パラメーターが無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    error 処理中にエラーが発生した場合は、エラーに関する詳細。

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

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

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

    データタイプ：文字列

    cURL 要求

    次のコード例は、ポリシーマッピングを削除する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?deployableName=Development_1&policyName=testALPolicy1&appName=testApp" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    マッピングが正常に削除された場合、HTTP ステータスコード以外の応答は返されません。

    None - results defined by the HTTP status code

    CdmPoliciesApi - GET /sn_cdm/policies/mappings/inputs/resolved

    展開可能項目の指定されたポリシーマッピングの解決済み入力を返します。

    ポリシーマッピングの詳細については、「 展開可能項目へのポリシーのマッピング 」および 「構成データの検証と修正」を参照してください。

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

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/policies/mappings/inputs/resolved

    デフォルトの URL：/api/sn_cdm/policies/mappings/inputs/resolved

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

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

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    appName 必須です。解決済みのポリシー入力を返す展開可能項目に関連付けられた 構成データ管理 (CDM) アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    deployableName 必須です。解決済みのポリシーを返す CDM 展開可能ファイルの名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    policyName 必須です。関連付けられたポリシーの名前。ポリシー [sn_pace_policy] テーブルにあります。

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

    ヘッダー

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

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

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    400 要求が正しくありません。渡された policyName パラメーターが無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    result 指定されたポリシーマッピングのすべての解決済み入力の名前と値のペアのリスト。

    例：{"input_name": "user_1", "input_password": "" }

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

    cURL 要求

    次の例は、このエンドポイントを使用して解決済みのポリシー入力を取得する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/resolved?policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": { 
    "key1": "someVal", 
    "additionalDeployablesInput": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]" 
  } 
}

    CdmPoliciesApi - POST /sn_cdm/policies/mappings

    指定されたポリシーを展開可能項目にマッピングします。

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

    URL 形式

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

    デフォルトの URL：/api/sn_cdm/policies/mappings

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

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

    データタイプ：文字列
    表 : 14. クエリパラメーター
    名前 説明
    appName 必須です。ポリシーをマッピングする 構成データ管理 (CDM) アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    deployableName 必須です。ポリシーをマッピングする CDM 展開可能項目の名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    policyName 必須です。関連付けられたポリシーの名前。ポリシー [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    returnFields 応答の一部として返すフィールドのリスト。sys_id、sys_updated_by、state などのレコード列名を渡します。

    データタイプ：アレイ

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

    ヘッダー

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

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

    ステータスコード

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

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

    応答本文のパラメーター

    名前 説明
    説明 マッピングの説明。

    データタイプ：文字列
    ドキュメント ドキュメントの sys_Id。

    データタイプ：文字列
    document_ref ノードに関連付けられた document_ref レコードの詳細。

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

    "document_ref": {
  "link": "String",
  "value": "String"
}
    document_ref.link テーブル REST API を使用してポリシーにマッピングされた展開可能レコードをクエリーするための呼び出し構文。

    PaCE は、このフィールドを使用して、ポリシーにマッピングされた展開可能項目への参照を格納します。

    データタイプ：文字列
    document_ref.sys_id ポリシーにマッピングされた展開可能レコードの sys_id。

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

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

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

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

    データタイプ：文字列
    例外 マッピングの実行中に例外が発生した場合は、例外レコードへのリンク。

    データタイプ：文字列
    exception_allowed ポリシーで例外が許可されるかどうかを示すフラグ。
    可能な値：
    • true：例外は許可されます。
    • false:例外は許可されません。

    データタイプ：ブーリアン
    input_status 入力のステータス。
    可能な値：
    • invalid
    • valid

    データタイプ：文字列
    last_updated_by ポリシーマッピングを最後に更新したユーザーの詳細。

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

    "last_updated_by": {
  "link": "String",
  "value": "String"
}
    last_updated_by.link テーブル REST API を使用してユーザーレコードをクエリーするための呼び出し構文。

    データタイプ：文字列
    last_updated_by.sys_id ユーザーレコードの Sys_id。ユーザー [sys_user] テーブルにあります。

    データタイプ：文字列
    number マッピングを識別する一意の番号。この値は、人間が判読可能なマッピングの識別子を提供します。

    データタイプ：文字列
    policy マッピングに関連付けられたポリシーレコードの詳細。

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

    "policy": {
  "link": "String",
  "value": "String"
}
    policy.link テーブル REST API を使用してポリシーにマッピングされたポリシーレコードをクエリーするための呼び出し構文。

    データタイプ：文字列
    policy.sys_id ポリシーレコードの sys_id。ポリシー [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    reason 現在のステータスの理由の説明。

    データタイプ：文字列
    state マッピングの現在のステータス。
    可能な値：
    • active
    • inactive

    データタイプ：文字列
    sys_class_name ポリシーマッピングのテーブル名。

    データタイプ：文字列
    sys_created_by マッピングを作成したユーザーの名前。

    データタイプ：文字列
    sys_created_on マッピングが作成された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss
    sys_id マッピングの sys_id。ポリシーマッピング [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    sys_updated_by マッピングを更新したユーザーの名前。

    データタイプ：文字列
    sys_updated_on マッピングが最後に更新された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss

    cURL 要求

    このコード例は、特定のポリシーを展開可能項目にマッピングする方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings?appName=testApp&deployableName=Development_1&policyName=testALPolicy1" \ 
--request POST \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": { 
    "exception": null, 
    "reason": null, 
    "exception_allowed": "--", 
    "document": "0be34a531b501110636e0fe0604bcb21", 
    "input_status": "valid", 
    "description": null, 
    "sys_updated_on": "2022-06-30 14:07:37", 
    "sys_class_name": "sn_cdm_pace_policy_mapping", 
    "sys_id": "ea24469f1b101110636e0fe0604bcbed", 
    "number": "MAP0001001", 
    "last_updated_by": { 
      "value": "48630e131b501110636e0fe0604bcb53", 
      "link": "https://instance.servicenow.com/api/now/table/sys_user/48630e131b501110636e0fe0604bcb53" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:07:37", 
    "document_ref": { 
      "value": "0be34a531b501110636e0fe0604bcb21", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_deployable/0be34a531b501110636e0fe0604bcb21" 
    }, 
    "state": "active", 
    "sys_created_by": "admin", 
    "policy": { 
      "value": "12a3c2531b501110636e0fe0604bcb9b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_policy/12a3c2531b501110636e0fe0604bcb9b" 
    } 
  } 
}

    CdmPoliciesApi - PUT /sn_cdm/policies/mappings/inputs/additional-deployables

    構成データ管理 (CDM) ポリシーマッピングの additionalDeployablesInput 入力変数を更新します。

    additionalDeployablesInput 入力変数には、既存のポリシーマッピングに割り当てることができる追加の展開可能項目が含まれています。マッピング入力に似ていますが、固有のアレイ構造を持っています。

    ポリシーマッピングの詳細については、「 展開可能項目へのポリシーのマッピング」を参照してください。

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

    URL 形式

    バージョニングされた URL：/api/sn_cdm/{api_version}/policies/mappings/inputs/additional-deployables

    デフォルトの URL：/api/sn_cdm/policies/mappings/inputs/additional-deployables

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

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

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    additionalDeployables 必須です。additionalDeployablesInput 入力変数に追加する展開可能項目のリスト。

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

    "additionalDeployables": [
  {
    "appName": "String", 
    "deployableName": "String"
  }
]
    additionalDeployables.appName 必須です。展開可能項目が関連付けられている CDM アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    additionalDeployables.deployableName 必須です。additionalDeployablesInput 入力変数に追加する CDM 展開可能項目の名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    appName 必須です。additionalDeployablesInput 入力変数を更新する CDM アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    deployableName 必須です。additionalDeployablesInput 入力変数を更新する CDM 展開可能項目の名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    policyName 必須です。関連付けられたポリシーの名前。ポリシー [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    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 要求が正しくありません。渡された policyName パラメーターが無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    io_definition 関連付けられた PaCE IO 定義レコードの詳細。

    PaCEの詳細については、「Policy as Code Engine (PaCE)」を参照してください。

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

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Table REST API を使用してこの PaCE IO 定義レコードをクエリするための呼び出し構文。

    データタイプ：文字列
    io_definition.value PaCE IO 定義レコードのSys_id。IO マッピング [sn_pace_io_mapping] テーブルにあります。

    データタイプ：文字列
    is_unused マッピング入力変数が未使用かどうかを示すフラグ。
    可能な値：
    • true:関連付けられたマッピング入力変数は現在使用されていません。
    • false：関連付けられたマッピング入力変数は現在使用されています。

    データタイプ：ブール
    mapped_value マッピング入力変数の現在の値。

    データタイプ：オブジェクトのアレイまたは文字列
    policy_mapping PaCEポリシーマッピングレコードの詳細。

    PaCEの詳細については、「Policy as Code Engine (PaCE)」を参照してください。

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

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link テーブル REST API を使用してポリシーマッピングレコードをクエリーするための呼び出し構文。

    データタイプ：文字列
    policy_mapping.value PaCEポリシーマッピングレコードのSys_id。ポリシーマッピング [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    sys_created_by マッピング入力変数を作成したユーザーの名前。

    データタイプ：文字列
    sys_created_on マッピング入力変数が作成された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss
    sys_id 関連付けられたマッピングレコードの sys_id。IO マッピング [sn_pace_io_mapping] テーブルにあります。

    データタイプ：文字列
    sys_updated_by マッピング入力変数を更新したユーザーの名前。

    データタイプ：文字列
    sys_updated_on マッピング入力変数が最後に更新された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss

    cURL 要求

    次の例は、additionalDeployablesInput 入力変数に展開可能項目を追加する方法を示しています。

    curl "https://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs/additional-deployables?additionalDeployables=%5B%7B%22appName%22%3A%20%22testApp%22%2C%20%22deployableName%22%3A%22Development_2%22%7D%5D&policyName=testALPolicy1&deployableName=Development_1&appName=testApp" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'admin':'admin

    返される結果：

    { 
  "result": { 
    "sys_id": "6bb746171b501110636e0fe0604bcb1c", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "ameya", 
    "sys_created_on": "2022-06-30 14:23:15", 
    "io_definition": { 
      "value": "4d0b061b1b501110636e0fe0604bcb2f", 
      "link": "https://instance.servicenow.com/api/now/table/sn_pace_io_definition/4d0b061b1b501110636e0fe0604bcb2f" 
    }, 
    "mapped_value": "[{\"id\":\"e7e34a531b501110636e0fe0604bcba9\",\"label\":\"testApp-Development_2\"}]", 
    "sys_updated_on": "2022-06-30 14:53:21", 
    "sys_created_by": "ameya", 
    "is_unused": false 
  } 
}

    CdmPoliciesApi - PUT /sn_cdm/policies/mappings/inputs

    構成データ管理 (CDM) ポリシーマッピングの指定された入力変数を更新します。

    オプションマッピングの詳細については、「展開可能項目へのポリシーのマッピング」を参照してください。

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

    URL 形式

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

    デフォルトの URL：/api/sn_cdm/policies/mappings/inputs

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

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

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    appName 必須です。ポリシーマッピングの入力を更新する CDM アプリケーションの名前。CDM アプリケーション [sn_cdm_application] テーブルにあります。

    データタイプ：文字列
    deployableName 必須です。ポリシーマッピングの入力を更新する CDM 展開可能項目の名前。CDM 展開可能項目 [sn_cdm_deployable] テーブルにあります。

    データタイプ：文字列
    inputName 必須です。更新する入力変数の名前。使用可能な入力変数は、IO マッピング [sn_pace_io_mapping] テーブルで定義されます。

    データタイプ：文字列
    inputValue 必須です。入力変数に割り当てる値。

    データタイプ：入力変数によって異なります。データタイプは IO マッピング [sn_pace_io_mapping] テーブルにあります。
    policyName 必須です。関連付けられたポリシーの名前。ポリシー [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    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 要求が正しくありません。渡された policyName パラメーターが無効です。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター

    名前 説明
    io_definition 関連付けられた PaCE IO 定義レコードの詳細。

    PaCEの詳細については、「Policy as Code Engine (PaCE)」を参照してください。

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

    "io_definition": {
  "link": "String",
  "value": "String"
}
    io_definition.link Table REST API を使用してこの PaCE IO 定義レコードをクエリするための呼び出し構文。

    データタイプ：文字列
    io_definition.value PaCE IO 定義レコードのSys_id。IO マッピング [sn_pace_io_mapping] テーブルにあります。

    データタイプ：文字列
    is_unused マッピング入力変数が未使用かどうかを示すフラグ。
    可能な値：
    • true:関連付けられたマッピング入力変数は現在使用されていません。
    • false：関連付けられたマッピング入力変数は現在使用されています。

    データタイプ：ブール
    mapped_value マッピング入力変数の現在の値。

    データタイプ：オブジェクトのアレイまたは文字列
    policy_mapping PaCEポリシーマッピングレコードの詳細。

    PaCEの詳細については、「Policy as Code Engine (PaCE)」を参照してください。

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

    "policy_mapping": {
  "link": "String",
  "value": "String"
}
    policy_mapping.link テーブル REST API を使用してポリシーマッピングレコードをクエリーするための呼び出し構文。

    データタイプ：文字列
    policy_mapping.value PaCEポリシーマッピングレコードのSys_id。ポリシーマッピング [sn_pace_policy] テーブルにあります。

    データタイプ：文字列
    sys_created_by マッピング入力変数を作成したユーザーの名前。

    データタイプ：文字列
    sys_created_on マッピング入力変数が作成された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss
    sys_id 関連付けられたマッピングレコードの sys_id。IO マッピング [sn_pace_io_mapping] テーブルにあります。

    データタイプ：文字列
    sys_updated_by マッピング入力変数を更新したユーザーの名前。

    データタイプ：文字列
    sys_updated_on マッピング入力変数が最後に更新された日時。

    データタイプ：文字列

    形式：yyyy-mm-dd hh:mm:ss

    cURL 要求

    次の例は、testALPolicy に関連付けられた key1 入力変数を更新する方法を示しています。

    curl "http://instance.servicenow.com/api/sn_cdm/policies/mappings/inputs?policyName=testALPolicy1&appName=testApp&inputValue=value1&inputName=key1&deployableName=Development_1" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    返される結果：

    { 
  "result": { 
    "sys_id": "631b861b1b501110636e0fe0604bcb6f", 
    "policy_mapping": { 
      "value": "6bb746171b501110636e0fe0604bcb1b", 
      "link": "https://instance.servicenow.com/api/now/table/sn_cdm_pace_policy_mapping/6bb746171b501110636e0fe0604bcb1b" 
    }, 
    "sys_updated_by": "admin", 
    "sys_created_on": "2022-06-30 14:38:00", 
    "io_definition": { 
      "value": "fe1b061b1b501110636e0fe0604bcb90", 
      "link": "https://instance.servicenow.comm/api/now/table/sn_pace_io_definition/fe1b061b1b501110636e0fe0604bcb90" 
    }, 
    "mapped_value": "someVal", 
    "sys_updated_on": "2022-06-30 14:39:21", 
    "sys_created_by": "admin", 
    "is_unused": false 
  } 
}