サービステスト管理オープン API

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：220分

サービステスト管理オープン API は、サービステスト定義とサービステストを作成および取得するためのエンドポイントを提供します。

この API を使用して、外部システムと Now Platformの間のサービス問題管理情報を管理します。Service Test Management Open API は、TM Forum Service Problem Management API REST 仕様のServiceNow実装です。この実装は https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/ に基づいています。

この REST API は、通信環境内でサービステストを管理および実行するように設計されています。これにより、ユーザーはサービステストを定義、トリガー、監視して、サービスが品質とパフォーマンスの基準を満たしていることを確認できます。API は、テスト定義の作成と更新、テストの実行、テスト結果の取得、テストスケジュールの管理など、テスト管理の機能を提供します。

サービステスト管理オープン API には、カスタマーサービス問題管理 (com.sn_sprb_mgmt) プラグインと sn_sprb_mgmt.test_integrator ロールが必要です。この API は sn_sprb_mgmt 名前空間に属します。サービス問題管理の詳細については、以下を参照してください。このアプリケーションの詳細については、「 Customer Service Problem Management 」を参照してください。

サービステスト管理オープン API は、次のテーブルのデータを作成または更新します。

テスト実行 [sn_st_mgmt_test]
サービステスト定義 [sn_st_mgmt_test_definition]
テスト定義の特性 [sn_st_mgmt_test_definition_characteristic]
テスト特性 [sn_st_mgmt_test_characteristic]
仕様とテスト定義の関係 [sn_st_mgmt_test_definition_m2m]
テスト定義関係 [sn_st_mgmt_test_definition_rel]
テスト測定 [sn_st_mgmt_test_measure]
測定結果 [sn_st_mgmt_measure_consequence]
テスト測定定義 [sn_st_mgmt_test_measure_definition]
適用された結果 [sn_st_mgmt_applied_consequence]
しきい値ルール [sn_st_mgmt_threshold_rule]
しきい値ルール違反 [sn_st_mgmt_threshold_rule_violation]

サービステスト管理オープン API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest

すべてのサービステストのリストを取得します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

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

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメータ
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト [sn_st_mgmt_test] テーブルにあります。有効なフィールド：特性説明 endDateTime id mode 関連サービス startDateTime state testMeasure テスト仕様 validFor データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値最大値:100 デフォルト値：20
オフセット	レコードの取得を開始する開始インデックス。このパラメーターを使用して、小さくて管理しやすいチャンクに結果をページネーションします。最初のレコードのインデックスは 0 です。データタイプ：数値デフォルト：0
state	テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答で返されます。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されましたデータタイプ：文字列

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

ヘッダー

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

表 : 4. 要求ヘッダー
ヘッダー	説明
なし

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。たとえば、 `offset=2` と `limit=3` の場合、Content-Range ヘッダーの値は items `3 から 5` になります。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
リンク	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

表 : 6. ステータスコード
ステータスコード	Description (説明)
200	成功。要求が正常に処理されました。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

表 : 7. 応答本文パラメーター (XML または JSON)
名前	説明
特性	関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
href	サービステストへのハイパーリンク参照。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
mode	サービステストが実行されているモード。有効な値： ONDEMAND:サービステストを手動でトリガーします。積極的:サービステストを自動的にトリガーします。デフォルト:ONDEMAND
name	必須。サービステストの名前。データタイプ：文字列
関連サービス	必須。サービステストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.id	製品インベントリのSys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
relatedService.name	製品在庫の名前。データタイプ：文字列
startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
state	サービステストの現在のステータス。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されましたデータタイプ：文字列
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ：オブジェクトのアレイ `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.id	検定測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
testMeasure.Measure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定メトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ:オブジェクトのアレイ `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.tolerancePeriod.amount	結果を適用するまでの期間数。データタイプ：数値
testMeasure.ruleViolation.appliedConsequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。データタイプ:オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.repeatAction	2 回目の違反が発生したときに結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返します。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorExact	値が同一かどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorLower	値がしきい値を下回っているかどうかを確認するための演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComporatorUpper	値がしきい値を超えているかどうかをチェックするための演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルールの説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.name	しきい値ルールの名前。データタイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大値:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高 medium 低データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	ただちに結果やアクションをトリガーすることなく交差の発生が有効になる時間間隔を指定します。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	テスト測定のコンフォーマンスターゲット値の測定単位を指定します。データタイプ：文字列
testMeasure.value	検定測定値の値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	検定測定値の ID。データタイプ：文字列
testMeasure.value.name	検定測定値の名前。データタイプ：文字列
testMeasure.value.value	検定測定値の値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	必須。このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のsys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	サービステストの有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、インスタンス内の 2 つのサービステストに関する情報を取得します。

curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
--user 'username’: ‘password'

応答本文。

[
  {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/09d1f42e3be28210d140068aa4e45ae2",
    "id": "09d1f42e3be28210d140068aa4e45ae2",
    "description": "Service test",
    "endDateTime": "2025-01-31 15:05:43",
    "mode": "proactive",
    "name": "Speed Test TR0001002",
    "startDateTime": "2024-06-05 09:07:10",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "relatedService": {
      "id": "fa6d13f45b5620102dff5e92dc81c77f",
      "name": "Internet_VPLS_PI0000011"
    },
    "testSpecification": {
      "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
      "id": "7d3854864316c6500e51203d5fb8f2d8"
    },
    "characteristic": [],
    "testMeasure": [
      {
        "id": "61d1382e3be28210d140068aa4e45a2e",
        "accuracy": "0.0001",
        "captureDateTime": "",
        "captureMethod": "automatic",
        "metricDescription": "",
        "metricName": "Flow speed",
        "unitOfMeasure": "A second",
        "value": "3000",
        "ruleViolation": [
          {
            "id": "61d1382e3be28210d140068aa4e45a2f",
            "description": "This speed is greater than the target",
            "name": "tooMuchTraffic",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "",
            "conformanceTargetLower": "2500",
            "conformanceComparatorLower": "greater than",
            "appliedConsequence": [
              {
                "id": "65d1382e3be28210d140068aa4e45a31",
                "appliedAction": "sendWarning",
                "description": "send a warning to the system",
                "name": "sendWarning",
                "repeatAction": "0"
              }
            ]
          }
        ]
      }
    ]
  },
  {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/18682a2a3b2682107222bf9985e45a55",
    "id": "18682a2a3b2682107222bf9985e45a55",
    "description": "Service test",
    "endDateTime": "2025-01-31 15:05:43",
    "mode": "proactive",
    "name": "Speed Test TR0001012",
    "startDateTime": "2024-06-05 17:45:07",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "relatedService": {
      "id": "fa6d13f45b5620102dff5e92dc81c77f",
      "name": "Internet_VPLS_PI0000011"
    },
    "testSpecification": {
      "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
      "id": "7d3854864316c6500e51203d5fb8f2d8"
    },
    "characteristic": [
      {
        "id": "5c682a2a3b2682107222bf9985e45a5a",
        "name": "url",
        "valueType": "single_line_text",
        "value": "http://abc.com"
      }
    ],
    "testMeasure": [
      {
        "id": "7c686a2a3b2682107222bf9985e45a4d",
        "accuracy": "0.0001",
        "captureDateTime": "",
        "captureMethod": "automatic",
        "metricDescription": "",
        "metricName": "Flow speed",
        "unitOfMeasure": "A second",
        "value": "3000",
        "ruleViolation": [
          {
            "id": "38686a2a3b2682107222bf9985e45a4e",
            "description": "This speed is greater than the target",
            "name": "tooMuchTraffic",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "",
            "conformanceTargetLower": "2500",
            "conformanceComparatorLower": "greater than",
            "appliedConsequence": [
              {
                "id": "34686a2a3b2682107222bf9985e45a50",
                "appliedAction": "sendWarning",
                "description": "send a warning to the system",
                "name": "sendWarning",
                "repeatAction": "0"
              }
            ]
          }
        ]
      }
    ]
  }
]

サービステスト管理オープン API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

指定されたサービステストの ID に基づいてサービステストエンティティを取得します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

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

表 : 8. パスパラメーター
名前	説明
ID	必須。取得するサービステストのSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列

表 : 9. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト [sn_st_mgmt_test] テーブルにあります。有効なフィールド：特性説明 endDateTime id mode 関連サービス startDateTime state testMeasure テスト仕様 validFor データタイプ：文字列

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

ヘッダー

表 : 11. 要求ヘッダー
ヘッダー	説明
なし

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

ステータスコード

表 : 13. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

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


名前	説明
特性	関連付けられたサービステストの特性を説明するリスト。データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
href	サービステストへのハイパーリンク参照。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
mode	サービステストが実行されているモード。有効な値： ONDEMAND:サービステストを手動でトリガーします。積極的:サービステストを自動的にトリガーします。デフォルト:ONDEMAND
name	サービステストの名前。データタイプ：文字列
関連サービス	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.id	製品インベントリのsys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedService.name	プロダクトインベントリアイテムの名前。データタイプ：文字列
startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
state	サービステストのステータス。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されました
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.id	テスト測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルにあります。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定におけるメトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ：オブジェクトのアレイ `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	しきい値ルールに違反した場合に実行するアクション (所定のアクションまたは通知)。データタイプ：オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	適用されたアクションを繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorExact	値が conformanceTargetExact の値と同じかどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComparatorLower	値がしきい値を下回っているかどうかをチェックする演算子。有効な値：次の値を超える (>) 次の値に等しい (=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値に等しい (=) 未満データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルール違反の説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.name	しきい値ルール違反の名前。日付タイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高低 medium データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	結果が開始される前に許可された交差が発生する可能性がある期間または時間間隔。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	期間の数量 (数値)。データタイプ：数値
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasure.value	テストのメトリクスの値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	テスト内のメトリクス値の ID。データタイプ：文字列
testMeasure.value.name	テスト内のメトリクス値の名前。データタイプ：文字列
testMeasure.value.value	テストのメトリクスの値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	サービステストの終了日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの開始日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、指定された ID 44b7a8ea3b6a42107222bf9985e45a45 に関連付けられたサービステストエンティティに関する詳細を取得します。

curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
--user 'username’: ‘password'

応答本文。

{
  "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45",
  "id": "44b7a8ea3b6a42107222bf9985e45a45",
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001001",
  "startDateTime": "2024-06-05 08:22:52",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
    "id": "7d3854864316c6500e51203d5fb8f2d8"
  },
  "characteristic": [
        { 
        "id": "5c682a2a3b2682107222bf9985e45a5a", 
        "name": "url", 
        "valueType": "single_line_text", 
        "value": "test" 
         }
],
  "testMeasure": [
    {
      "id": "62ade42a3ba28210d140068aa4e45a71",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Downstream Speed",
      "unitOfMeasure": "",
      "value": "16",
      "ruleViolation": [
        {
          "id": "b9bee4ae3ba28210d140068aa4e45a3a",
          "description": "This speed is less than the target upper",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "75",
          "conformanceComparatorUpper": "less than",
          "appliedConsequence": [
            {
              "id": "489074aa3be28210d140068aa4e45a42",
              "appliedAction": "generateReport",
              "description": "",
              "name": "generateReport",
              "repeatAction": "0"
            },
            {
              "id": "785f2ce23be28210d140068aa4e45a75",
              "appliedAction": "sendWarning",
              "description": "",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

サービステスト管理オープン API - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

すべてのサービステスト定義のリストを取得します。

URL 形式

デフォルト URL: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

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

表 : 14. パスパラメーター
名前	説明
なし

表 : 15. クエリパラメータ
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。有効な値：説明 id name 関連サービス仕様 serviceTestSpecRelationship specCharacteristic testMeasureDefinition validFor データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値最大値:100 デフォルト値：20
オフセット	レコードの取得を開始する開始インデックス。このパラメーターを使用して、小さくて管理しやすいチャンクに結果をページネーションします。最初のレコードのインデックスは 0 です。データタイプ：数値デフォルト：0
state	テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答で返されます。有効な値： archived ドラフト published 引退データタイプ：文字列

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

ヘッダー

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

表 : 18. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。たとえば、 `offset=2` と `limit=3` の場合、Content-Range ヘッダーの値は items `3 から 5` になります。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
リンク	クエリ結果間を移動するための次のリンクが含まれています。 1 last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

表 : 19. ステータスコード
ステータスコード	Description (説明)
200	成功。要求が正常に処理されました。
206	応答で部分的なリソースが返されました (ページネーションあり)。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

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


名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。データタイプ：文字列
name	必須。サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	必須。テスト定義のサービス仕様。データタイプ：オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のSys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連サービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：なし 1 回日次週次月次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： automatic:メトリクスを自動的にキャプチャします。 manual:メトリクスを手動でキャプチャします。 none:メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	メトリクスキャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	テスト測定定義のしきい値を超えた (または超えていない) 場合に結果を適用する前に達成すべき条件を定義するルール。詳細については、「Define threshold rules for a test measure definition」を参照してください。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が testMeasureDefinition.thresholdRule.conformanceTargetExactに設定された値と同一かどうかを示すフラグ。true に設定した場合は、 testMeasureDefinition.thresholdRule.conformanceTargetExact が必要です。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。詳細については、「Define measure consequences for the threshold rules」を参照してください。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用された結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。[しきい値ルール [sn_st_mgmt_threshold_rule] テーブルの [sys_id または external_id に位置] フィールドにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。最大値:40 データタイプ：数値
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度レベル。有効な値：高 medium 低データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ：文字列 `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor	テスト定義が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	テスト定義のステータスが廃止された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	テスト定義のステータスが公開された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

この例では、インスタンス内のすべてのテストサービスのテスト定義に関する詳細を取得します。この場合、2 つの定義が返されます。

curl --location --request GET 
“https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
--user 'username’: ‘password'

応答本文。

[
  {
    "description": "Operation, Administration and Maintenance",
    "id": "76a3b160432a02104fefe4511fb8f2ad",
    "name": "OAM Test",
    "validFor": {
      "startDateTime": "",
      "endDateTime": ""
    },
    "testMeasureDefinition": [
      {
        "id": "77b9b964432a02104fefe4511fb8f26e",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the Rx signal level",
        "metricName": "Rx Optical Signal Level",
        "name": "Rx Optical Signal Level",
        "unitOfMeasure": "a minute",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": [
          {
            "id": "d3e97d64432a02104fefe4511fb8f281",
            "description": "",
            "name": "gponOntAniOpInfoRxOpticalSignalLevel",
            "numberOfAllowedCrossing": "",
            "thresholdRuleSeverity": "",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "0",
            "conformanceComparatorUpper": "less than",
            "conformanceTargetLower": "-50",
            "conformanceComparatorLower": "greater than",
            "consequence": []
          }
        ]
      },
      {
        "id": "878afd64432a02104fefe4511fb8f28d",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the Tx signal level",
        "metricName": "TX Optical Signal Level",
        "name": "TX Optical Signal Level",
        "unitOfMeasure": "a minute",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": [
          {
            "id": "b3dab5a4432a02104fefe4511fb8f2d3",
            "description": "",
            "name": "gponOntAniOpInfoTxOpticalSignalLevel",
            "numberOfAllowedCrossing": "",
            "thresholdRuleSeverity": "",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "65",
            "conformanceComparatorUpper": "less than",
            "conformanceTargetLower": "-65",
            "conformanceComparatorLower": "greater than",
            "consequence": []
          }
        ]
      }
    ],
    "specCharacteristic": [
      {
        "name": "AccessRequired",
        "description": "AccessRequired",
        "valueType": "yes_no",
        "validFor": {
          "startDatetime": "2024-05-30 09:09:57"
        },
        "characteristicValueSpecification": [
          {
            "value": "Yes",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          },
          {
            "value": "No",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          }
        ]
      }
    ],
    "serviceTestSpecRelationship": [],
    "relatedServiceSpecification": [
      {
        "id": "f559b564432a02104fefe4511fb8f2e0",
        "name": "OAM"
      }
    ]
  },
  {
    "description": "Upstream and Downstream speed ",
    "id": "89d2b920432a02104fefe4511fb8f22e",
    "name": "Speed Test",
    "validFor": {
      "startDateTime": "2024-05-31",
      "endDateTime": "2024-06-27"
    },
    "testMeasureDefinition": [
      {
        "id": "1a04f560432a02104fefe4511fb8f2ad",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the downstream speed in a service",
        "metricName": "Downstream Speed",
        "name": "Downstream Speed",
        "unitOfMeasure": "a second",
        "valueType": "",
        "capturePeriod": "30 Minutes",
        "validFor": {
          "startDateTime": "2024-05-30 08:49:26",
          "endDateTime": "2024-05-31 08:49:29"
        },
        "thresholdRule": [
          {
            "id": "a754f960432a02104fefe4511fb8f2d0",
            "description": "This speed is greater than the target upper",
            "name": "InternetSpeedValue",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "high",
            "tolerancePeriod": "15 Minutes",
            "conformanceTargetLower": "75",
            "conformanceComparatorLower": "greater than",
            "consequence": [
              {
                "id": "15a4bd60432a02104fefe4511fb8f2b8",
                "prescribeAction": "null",
                "description": "generate a waring report",
                "name": "degradedQualityOfService",
                "repeatAction": "0",
                "validFor": {
                  "startDateTime": "2024-05-30 08:51:29",
                  "endDateTime": "2024-08-06 08:51:31"
                }
              },
              {
                "id": "e6847d60432a02104fefe4511fb8f2c3",
                "prescribeAction": "null",
                "description": "send a warning to the system",
                "name": "packetdrop",
                "repeatAction": "0",
                "validFor": {
                  "startDateTime": "2024-05-30 08:50:53",
                  "endDateTime": "2024-08-06 08:50:55"
                }
              }
            ]
          },
          {
            "id": "cb55b5a0432a02104fefe4511fb8f201",
            "description": "",
            "name": "InternetSpeedValue",
            "numberOfAllowedCrossing": "0",
            "thresholdRuleSeverity": "medium",
            "tolerancePeriod": "",
            "conformanceTargetUpper": "120",
            "conformanceComparatorUpper": "less than",
            "consequence": []
          }
        ]
      },
      {
        "id": "8f987524432a02104fefe4511fb8f2f0",
        "captureFrequency": "once",
        "captureMethod": "automatic",
        "metricDescription": "This is the upstream speed in the service",
        "metricName": "Upstream Speed",
        "name": "Upstream Speed",
        "unitOfMeasure": "a second",
        "valueType": "",
        "capturePeriod": "",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "thresholdRule": []
      }
    ],
    "specCharacteristic": [
      {
        "name": "restart",
        "description": "restart",
        "valueType": "yes_no",
        "validFor": {
          "startDatetime": "2024-05-30 08:45:49"
        },
        "characteristicValueSpecification": [
          {
            "value": "No",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          },
          {
            "value": "Yes",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            }
          }
        ]
      }
    ],
    "serviceTestSpecRelationship": [
      {
        "id": "76a3b160432a02104fefe4511fb8f2ad",
        "name": "OAM Test",
        "relationshipType": ""
      }
    ],
    "relatedServiceSpecification": [
      {
        "id": "aeddcd1fb7d69910ff00f203ae11a990",
        "name": "Home Internet"
      }
    ]
  }
]

サービステスト管理オープン API - GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

サービステスト定義エンティティを取得します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

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

表 : 20. パスパラメーター
名前	説明
id	必須。取得するサービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。データタイプ：文字列

表 : 21. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。有効な値：説明 id name 関連サービス仕様 serviceTestSpecRelationship specCharacteristic testMeasureDefinition validFor データタイプ：文字列
state	テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答で返されます。有効な値： archived ドラフト published 引退データタイプ：文字列

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

ヘッダー

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

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

ステータスコード

表 : 25. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

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


名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。データタイプ：文字列
name	必須。サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	必須。テスト定義のサービス仕様。データタイプ：オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のSys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連サービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：なし 1 回日次週次月次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： automatic:メトリクスを自動的にキャプチャします。 manual:メトリクスを手動でキャプチャします。 none:メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	メトリクスキャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	テスト測定定義のしきい値を超えた (または超えていない) 場合に結果を適用する前に達成すべき条件を定義するルール。詳細については、「Define threshold rules for a test measure definition」を参照してください。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が testMeasureDefinition.thresholdRule.conformanceTargetExactに設定された値と同一かどうかを示すフラグ。true に設定した場合は、 testMeasureDefinition.thresholdRule.conformanceTargetExact が必要です。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。詳細については、「Define measure consequences for the threshold rules」を参照してください。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用された結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。[しきい値ルール [sn_st_mgmt_threshold_rule] テーブルの [sys_id または external_id に位置] フィールドにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。最大値:40 データタイプ：数値
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度レベル。有効な値：高 medium 低データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ：文字列 `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor	テスト定義が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	テスト定義のステータスが廃止された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	テスト定義のステータスが公開された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

この例では、指定された ID を持つサービステスト定義の詳細を取得します。

curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
--user 'username’: ‘password'

応答本文。

{
  "description": "Upstream and Downstream speed ",
  "id": "89d2b920432a02104fefe4511fb8f22e",
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

サービステスト管理オープン API - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

サービステストエンティティを更新します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

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

表 : 26. パスパラメーター
名前	説明
ID	必須。取得するサービステストのSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列

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

表 : 28. 要求本文パラメーター (XML または JSON)
名前	説明
特性	関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
mode	サービステストが実行されているモード。有効な値： ONDEMAND:サービステストを手動でトリガーします。積極的:サービステストを自動的にトリガーします。デフォルト:ONDEMAND
name	必須。サービステストの名前。データタイプ：文字列
関連サービス	必須。サービステストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.href	関連サービスへのハイパーリンク参照。データタイプ：文字列
relatedService.id	製品インベントリのSys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
state	サービステストの現在のステータス。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されましたデータタイプ：文字列
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ：オブジェクトのアレイ `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.id	検定測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
testMeasure.Measure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定メトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ:オブジェクトのアレイ `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.tolerancePeriod.amount	結果を適用するまでの期間数。データタイプ：数値
testMeasure.ruleViolation.appliedConsequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。データタイプ:オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.repeatAction	2 回目の違反が発生したときに結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返します。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorExact	値が同一かどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorLower	値がしきい値を下回っているかどうかを確認するための演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComporatorUpper	値がしきい値を超えているかどうかをチェックするための演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルールの説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.name	しきい値ルールの名前。データタイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大値:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高 medium 低データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	ただちに結果やアクションをトリガーすることなく交差の発生が有効になる時間間隔を指定します。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	テスト測定のコンフォーマンスターゲット値の測定単位を指定します。データタイプ：文字列
testMeasure.value	検定測定値の値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	検定測定値の ID。データタイプ：文字列
testMeasure.value.name	検定測定値の名前。データタイプ：文字列
testMeasure.value.value	検定測定値の値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	必須。このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のsys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	サービステストの有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 31. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

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


名前	説明
特性	関連付けられたサービステストの特性を説明するリスト。データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
name	サービステストの名前。データタイプ：文字列
関連サービス	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "string", "id": "String", "name": "String" }`
relatedService.id	製品インベントリのSys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedService.name	製品在庫の名前。データタイプ：文字列
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.id	テスト測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルにあります。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定におけるメトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ：オブジェクトのアレイ `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	しきい値ルールに違反した場合に実行するアクション (所定のアクションまたは通知)。データタイプ：オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	適用されたアクションを繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorExact	値が conformanceTargetExact の値と同じかどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComparatorLower	値がしきい値を下回っているかどうかをチェックする演算子。有効な値：次の値を超える (>) 次の値に等しい (=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値に等しい (=) 未満データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルール違反の説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高低 medium データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	結果が開始される前に許可された交差が発生する可能性がある期間または時間間隔。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	期間の数量 (数値)。データタイプ：数値
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasure.value	テストのメトリクスの値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	テスト内のメトリクス値の ID。データタイプ：文字列
testMeasure.value.name	テスト内のメトリクス値の名前。データタイプ：文字列
testMeasure.value.value	テストのメトリクスの値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	サービステストの終了日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの開始日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、要求本文に指定された詳細に従って、指定されたサービステストエンティティを更新します。

curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/2b406ec043b202104fefe4511fb8f211" \ 
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'
--data {
  "description": "Service test description",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "No"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

応答は、指定されたテストサービスで変更された情報を返すことで、更新が成功したことを示します。

{
  "description": "Service test description",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

サービステスト管理オープン API - PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

サービステスト定義エンティティの部分的な更新を許可します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

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

表 : 32. パスパラメーター
名前	説明
id	必須。取得するサービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。データタイプ：文字列

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

表 : 34. 要求本文パラメーター (XML または JSON)
名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
name	必須。サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	必須。テスト定義のサービス仕様。データタイプ：オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のSys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連サービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：なし 1 回日次週次月次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： automatic:メトリクスを自動的にキャプチャします。 manual:メトリクスを手動でキャプチャします。 none:メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	メトリクスキャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	テスト測定定義のしきい値を超えた (または超えていない) 場合に結果を適用する前に達成すべき条件を定義するルール。詳細については、「Define threshold rules for a test measure definition」を参照してください。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が testMeasureDefinition.thresholdRule.conformanceTargetExactに設定された値と同一かどうかを示すフラグ。true に設定した場合は、 testMeasureDefinition.thresholdRule.conformanceTargetExact が必要です。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。詳細については、「Define measure consequences for the threshold rules」を参照してください。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用された結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。[しきい値ルール [sn_st_mgmt_threshold_rule] テーブルの [sys_id または external_id に位置] フィールドにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。最大値:40 データタイプ：数値
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度レベル。有効な値：高 medium 低データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ：文字列 `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

ヘッダー

表 : 35. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

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

ステータスコード

表 : 37. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
404	見つかりません。要求アイテムが見つかりませんでした。

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


名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
id	サービステスト定義のsys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
name	サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	テスト定義のサービス仕様。データタイプ:オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のsys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連サービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ：オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：日次月次なし 1 回週次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： manual - メトリクスを手動でキャプチャします。自動 - メトリクスを自動的にキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	キャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	特定のテスト測定定義についてしきい値を超えたとき、またはしきい値を超えなくなったときに結果を適用するための達成条件 (発生またはクリア) を定義するルール。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が conformanceTargetExact の値と同じかどうかを示すフラグ。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値に等しい (=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：未満次の値に等しい (=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用されたアクションを繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。しきい値ルール [sn_st_mgmt_threshold_rule] テーブルにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大値:40
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高低 medium データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、要求本体に指定された変更に従って、指定されたサービステスト定義 ID を部分的に更新します。

curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e " 
--request PATCH
--header "Accept:application/json" 
--user 'username':'password'
--data {
  "description": "Upstream and Downstream speed ",
  "name": "This is my new Speed Test",
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      }
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

応答本文は、サービステスト仕様の更新された部分を返します。

{
  "description": "Upstream and Downstream speed ",
  "name": "This is my new Speed Test",
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      }
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

サービステスト管理オープン API - POST /sn_sprb_mgmt/servicetestmanagement/serviceTest

サービステストを作成します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

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

表 : 38. パスパラメーター
名前	説明
なし

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

表 : 40. 要求本文パラメーター (XML または JSON)
名前	Description (説明)
特性	関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
id	サービステストのSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。この ID はサービステストを作成し、external_idとして使用されます。データタイプ：文字列
mode	サービステストが実行されているモード。有効な値： ONDEMAND:サービステストを手動でトリガーします。積極的:サービステストを自動的にトリガーします。デフォルト:ONDEMAND
name	必須。サービステストの名前。データタイプ：文字列
関連サービス	必須。サービステストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "String", "id": "String", "name": "String" }`
relatedService.href	関連サービスへのハイパーリンク参照。データタイプ：文字列
relatedService.id	製品インベントリのSys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
relatedService.name	プロダクトインベントリアイテムの名前。データタイプ：文字列
startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
state	サービステストの現在のステータス。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されましたデータタイプ：文字列
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ：オブジェクトのアレイ `"testMeasure": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array], "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.id	検定測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルの sys_id または external_id フィールドにあります。データタイプ：文字列
testMeasure.Measure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定メトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ:オブジェクトのアレイ `"ruleViolation"[ { appliedConsequence: [Array], conformanceTargetUpper: Number, conformanceComparatorUpper: "String", description: "String", id: "String", name: "String", numberOfAllowedCrossing: Number, thresholdRuleSeverity: "String", tolerancePeriod: "String" } ]`
testMeasure.ruleViolation.appliedConsequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。データタイプ:オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.repeatAction	2 回目の違反が発生したときに結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返します。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorExact	値が同一かどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComporatorLower	値がしきい値を下回っているかどうかを確認するための演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComporatorUpper	値がしきい値を超えているかどうかをチェックするための演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルールの説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.name	しきい値ルールの名前。データタイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大値:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高 medium 低データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	ただちに結果やアクションをトリガーすることなく交差の発生が有効になる時間間隔を指定します。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	結果を適用するまでの期間数。データタイプ：数値
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	テスト測定のコンフォーマンスターゲット値の測定単位を指定します。データタイプ：文字列
testMeasure.value	検定測定値の値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String }`
testMeasure.value.id	検定測定値の ID。データタイプ：文字列
testMeasure.value.name	検定測定値の名前。データタイプ：文字列
testMeasure.value.value	検定測定値の値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	必須。このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "id": "String", "href": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のsys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	サービステストの有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 43. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

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


名前	説明
特性	関連付けられたサービステストの特性を説明するリスト。データタイプ:オブジェクトのアレイ `"characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ]`
characteristic.id	特性のSys_idまたはexternal_id。特性 [sn_prd_pm_characteristic] テーブルにあります。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。データタイプ：文字列
characteristic.name	特性の名前。データタイプ：文字列
characteristic.value	サービステストに関連する特性オプション。特性はカスタマーインスタンスによって異なります。データタイプ：文字列
characteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
説明	サービステストの説明。データタイプ：文字列
endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
mode	サービステストが実行されているモード。有効な値： ONDEMAND:サービステストを手動でトリガーします。積極的:サービステストを自動的にトリガーします。デフォルト:ONDEMAND
name	サービステストの名前。データタイプ：文字列
関連サービス	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"relatedService": { "href": "string", "id": "String", "name": "String" }`
relatedService.id	製品インベントリのSys_idまたはexternal_id。製品インベントリ [sn_prd_invt_product_inventory] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedService.name	製品在庫の名前。データタイプ：文字列
startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
state	サービステストのステータス。有効な値：確認済みキャンセル済み completed failed 進行中保留中が却下されました
testMeasure	失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "accuracy": "String", "captureDateTime": "String", "captureMethod": "String", "id": "String", "metricDescription": "String", "metricName": "String", "ruleViolation": [Array] "unitOfMeasure": "String", "value": {Object} } ]`
testMeasure.accuracy	関連するメトリクスに対してキャプチャされたテスト測定精度を表す浮動小数点数の 10 進数値。データタイプ：数値最大値:40
testMeasure.captureDateTime	メトリクスがキャプチャされた日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasure.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値：自動 - メトリクスを自動的にキャプチャします。 manual - メトリクスを手動でキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasure.id	テスト測定のSys_idまたはexternal_id。検定測定テーブル [sn_st_mgmt_test_measure] テーブルにあります。データタイプ：文字列
testMeasure.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasure.metricName	テスト測定におけるメトリクスの名前。データタイプ：文字列
testMeasure.ruleViolation	しきい値ルール定義でルールを定義し、ルールに違反した場合の結果を定義するためのオブジェクト。データタイプ：オブジェクトのアレイ `"RuleViolation": [ { "appliedConsequence": [Array], "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": {Object} } ]`
testMeasure.ruleViolation.appliedConsequence	しきい値ルールに違反した場合に実行するアクション (所定のアクションまたは通知)。データタイプ：オブジェクトのアレイ `"appliedConsequence": [ { "appliedAction": "String", "description": "String", "id": "String", "name": "String", "repeatAction": Boolean } ]`
testMeasure.ruleViolation.appliedConsequence.appliedAction	しきい値ルールに違反した場合に実行するアクション。たとえば、警告の送信やレポートの生成などです。適用されるアクションはインスタンス間で異なる場合があります。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction	適用されたアクションを繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.appliedConsequence.description	適用された結果の説明。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.id	適用された結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasure.ruleViolation.appliedConsequence.name	適用された結果の名前。データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorExact	値が conformanceTargetExact の値と同じかどうかを示すフラグ。有効な値： true:値は同じです。 false:値が同一ではありません。データタイプ：ブーリアンデフォルト値：false
testMeasure.ruleViolation.conformanceComparatorLower	値がしきい値を下回っているかどうかをチェックする演算子。有効な値：次の値を超える (>) 次の値に等しい (=) データタイプ：文字列
testMeasure.ruleViolation.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値に等しい (=) 未満データタイプ：文字列
testMeasure.ruleViolation.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。しきい値を超えたか、超えなくなったかを判断します。データタイプ：数値
testMeasure.ruleViolation.description	しきい値ルール違反の説明。データタイプ：文字列
testMeasure.ruleViolation.id	しきい値ルール違反のSys_idまたはexternal_id。しきい値ルール違反テーブル [sn_st_mgmt_threshold_rule_violation] テーブルにあります。データタイプ：文字列
testMeasure.ruleViolation.name	しきい値ルール違反の名前。日付タイプ：文字列
testMeasure.ruleViolation.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大:40
testMeasure.ruleViolation.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高低 medium データタイプ：文字列
testMeasure.ruleViolation.tolerancePeriod	結果が開始される前に許可された交差が発生する可能性がある期間または時間間隔。日付タイプ:オブジェクト `"tolerancePeriod": { "amount": Number, "units": "String" }`
testMeasure.ruleViolation.tolerancePeriod.amount	期間の数量 (数値)。データタイプ：数値
testMeasure.ruleViolation.tolerancePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasure.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasure.value	テストのメトリクスの値。データタイプ: オブジェクト `"value": { "id": "String", "name": "String", "valueType": "String", "value": "String" }`
testMeasure.value.id	テスト内のメトリクス値の ID。データタイプ：文字列
testMeasure.value.name	テスト内のメトリクス値の名前。データタイプ：文字列
testMeasure.value.name	テスト内のメトリクス値の名前。データタイプ：文字列
testMeasure.value.value	テストのメトリクスの値。データタイプ：文字列
testMeasure.value.valueType	数値、テキストなどのテスト測定値のタイプ。データタイプ：文字列
テスト仕様	このテストに関連付けられたテスト定義。データタイプ: オブジェクト `"testSpecification": { "href": "String", "id": "String" }`
testSpecification.href	サービステスト定義へのハイパーリンク参照。データタイプ：文字列
testSpecification.id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
validFor.endDateTime	サービステストの終了日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの開始日とタイムスタンプ。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、要求本文で指定された特定の詳細に従って、新しいサービステストを作成します。

curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data {
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "Yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ]
}

応答は、新しいテストサービスに関する確認の詳細を返し、一意の ID 2b406ec043b202104fefe4511fb8f211 を割り当てます。

{
  "description": "Service test",
  "endDateTime": "2025-01-31 15:05:43",
  "mode": "proactive",
  "name": "Speed Test TR0001002",
  "startDateTime": "2024-06-05 09:07:10",
  "validFor": {
    "startDateTime": "",
    "endDateTime": ""
  },
  "relatedService": {
    "id": "fa6d13f45b5620102dff5e92dc81c77f",
    "name": "Internet_VPLS_PI0000011"
  },
  "testSpecification": {
    "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
    "id": "76a3b160432a02104fefe4511fb8f2ad"
  },
  "characteristic": [
    {
      "id": "e7ef960443f202104fefe4511fb8f224",
      "name": "AccessRequired",
      "valueType": "yes_no",
      "value": "Yes"
    }
  ],
  "testMeasure": [
    {
      "id": "61d1382e3be28210d140068aa4e45a2e",
      "accuracy": "0.0001",
      "captureDateTime": "",
      "captureMethod": "automatic",
      "metricDescription": "",
      "metricName": "Flow speed",
      "unitOfMeasure": "A second",
      "value": "3000",
      "ruleViolation": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2f",
          "description": "This speed is greater than the target",
          "name": "tooMuchTraffic",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "",
          "conformanceTargetLower": "2500",
          "conformanceComparatorLower": "greater than",
          "appliedConsequence": [
            {
              "id": "65d1382e3be28210d140068aa4e45a31",
              "appliedAction": "sendWarning",
              "description": "send a warning to the system",
              "name": "sendWarning",
              "repeatAction": "0"
            }
          ]
        }
      ]
    }
  ],
  "id": "2b406ec043b202104fefe4511fb8f211"
}

サービステスト管理オープン API - POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

新しいサービステスト定義を作成します。

URL 形式

デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

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

表 : 44. パスパラメーター
名前	説明
なし

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

表 : 46. 要求本文パラメーター (XML または JSON)
名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
id	サービステスト定義のSys_idまたはexternal_id。サービステスト定義 [sn_st_mgmt_test_definition] テーブルにあります。データタイプ：文字列
name	必須。サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	必須。テスト定義のサービス仕様。データタイプ：オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のSys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連するサービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：なし 1 回日次週次月次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： automatic:メトリクスを自動的にキャプチャします。 manual:メトリクスを手動でキャプチャします。 none:メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	メトリクスキャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	テスト測定定義のしきい値を超えた (または超えていない) 場合に結果を適用する前に達成すべき条件を定義するルール。詳細については、「Define threshold rules for a test measure definition」を参照してください。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "consequence": Array, "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が testMeasureDefinition.thresholdRule.conformanceTargetExactに設定された値と同一かどうかを示すフラグ。true に設定した場合は、 testMeasureDefinition.thresholdRule.conformanceTargetExact が必要です。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値以上 (>=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：次の値未満 (<) 次の値以下 (<=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。詳細については、「Define measure consequences for the threshold rules」を参照してください。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用された結果を繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。[しきい値ルール [sn_st_mgmt_threshold_rule] テーブルの [sys_id または external_id に位置] フィールドにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。最大値:40 データタイプ：数値
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度レベル。有効な値：高 medium 低データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ：文字列 `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor	テスト定義が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	テスト定義のステータスが廃止された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	テスト定義のステータスが公開された日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

ヘッダー

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

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

ステータスコード

表 : 49. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。

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


名前	説明
説明	サービステスト定義の説明。データタイプ：文字列
id	サービステスト定義のsys_idまたはexternal_id。サービステスト [sn_st_mgmt_test] テーブルにあります。データタイプ：文字列
name	サービステスト定義の名前。データタイプ：文字列
関連サービス仕様	テスト定義のサービス仕様。データタイプ:オブジェクトのアレイ `"relatedServiceSpecification": [ { "id": "String", "name": "String" } ]`
relatedServiceSpecification.id	サービス仕様のsys_idまたはexternal_id。仕様 [sn_prd_pm_specification] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
relatedServiceSpecification.name	サービス仕様の名前。データタイプ：文字列
serviceTestSpecRelationship	関連サービステスト定義。データタイプ:オブジェクトのアレイ `"serviceTestSpecRelationship": [ { "id": "String", "name": "String", "relationshipType": "String" } ]`
serviceTestSpecRelationship.id	関連するサービステスト定義のSys_idまたはexternal_id。テスト定義 [sn_st_mgmt_test_definition] テーブルの [sys_id] または [external_id] フィールドにあります。データタイプ：文字列
serviceTestSpecRelationship.name	関連するテスト定義の名前。データタイプ：文字列
serviceTestSpecRelationship.relationshipType	関係のタイプ。受け入れ可能な値: 代入属国独占データタイプ：文字列
specCharacteristic	テスト定義の特性。データタイプ:オブジェクトのアレイ `"specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	特性の可能な値を含むアレイ。データタイプ:オブジェクトのアレイ `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	特性の値。データタイプ：文字列
specCharacteristic.description	特性の説明。データタイプ：文字列
specCharacteristic.name	特性の名前。データタイプ：文字列
specCharacteristic.validFor	特性が有効な日付範囲。データタイプ：オブジェクト `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacteristic.validFor.endDateTime	特性の終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.validFor.startDateTime	特性の開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
specCharacteristic.valueType	特性値のタイプ。はい/いいえ選択 date 日付/時刻期間メール label 1 行テストデータタイプ：文字列
testMeasureDefinition	このサービステスト定義のテスト測定定義。詳細については、「Define test measure definitions for a service test」を参照してください。データタイプ:オブジェクトのアレイ `"testMeasureDefinition": [ { "captureFrequency": "String", "captureMethod": "String", "capturePeriod": {Object}, "id": "String", "metricDescription": "String", "metricName": "String", "name": "String", "unitOfMeasure": "String", "thresholdRule": [Array], "validFor": {Object}, "valueType": "String" } ]`
testMeasureDefinition.captureFrequency	メトリクスをキャプチャする頻度。有効な値：日次月次なし 1 回週次データタイプ：文字列
testMeasureDefinition.captureMethod	メトリクスをキャプチャするために使用される方法。有効な値： manual - メトリクスを手動でキャプチャします。自動 - メトリクスを自動的にキャプチャします。 none - メトリクスをキャプチャしません。データタイプ：文字列
testMeasureDefinition.capturePeriod	キャプチャの期間。データタイプ: オブジェクト `"capturePeriod": { "amount": Number, "units": "String" }`
testMeasureDefinition.capturePeriod.amount	キャプチャ期間の数。データタイプ：数値
testMeasureDefinition.capturePeriod.units	期間の単位。受け入れ可能な値: 秒分日時間データタイプ：文字列
testMeasureDefinition.id	テスト測定定義のSys_idまたはexternal_id。テスト測定定義テーブル [sn_st_mgmt_test_measure_definition] テーブルにあります。データタイプ：文字列
testMeasureDefinition.metricDescription	メトリクスの簡潔な説明。データタイプ：文字列
testMeasureDefinition.metricName	テスト測定内のメトリクスのユーザー定義名。データタイプ：文字列
testMeasureDefinition.name	テスト測定定義の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule	特定のテスト測定定義についてしきい値を超えたとき、またはしきい値を超えなくなったときに結果を適用するための達成条件 (発生またはクリア) を定義するルール。データタイプ:オブジェクトのアレイ `{ "thresholdRule": { "conformanceComparatorExact": Boolean, "conformanceComparatorLower": "String", "conformanceComparatorUpper": "String", "conformanceTargetExact": "String", "conformanceTargetLower": "String", "conformanceTargetUpper": "String", "consequence": Array, "description": "String", "id": "String", "name": "String", "numberOfAllowedCrossing": Number, "thresholdRuleSeverity": "String", "tolerancePeriod": Object } }`
testMeasureDefinition.thresholdRule.conformanceComparatorExact	値が conformanceTargetExact の値と同じかどうかを示すフラグ。有効な値： true:値は conformanceTargetExact の値と同じです。 false:値は同一ではありません conformanceTargetExact。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.conformanceComparatorLower	値がしきい値を下回っているかどうかを確認する演算子。有効な値：次の値を超える (>) 次の値に等しい (=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceComparatorUpper	値がしきい値を超えているかどうかをチェックする演算子。有効な値：未満次の値に等しい (=) データタイプ：文字列
testMeasureDefinition.thresholdRule.conformanceTargetExact	conformanceComparatorExact が true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetLower	テスト測定結果を比較するための下限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.conformanceTargetUpper	テスト測定結果を比較するための上限しきい値。データタイプ：数値
testMeasureDefinition.thresholdRule.consequence	しきい値ルールを超えた場合に実行するアクション (所定のアクションまたは通知)。データタイプ:オブジェクトのアレイ `"consequence": [ { "description": "String", "id": "String", "name": "String", "prescribeAction": "String", "repeatAction": Boolean, "validFor": { "endDateTime": "String", "startDateTime": "String" } ]`
testMeasureDefinition.thresholdRule.consequence.description	結果の説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.id	測定結果のSys_idまたはexternal_id。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.name	結果の名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.prescribeAction	しきい値違反に対して実行するユーザー定義のアクション。アクションはインスタンスによって異なります。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.repeatAction	適用されたアクションを繰り返すかどうかを示すフラグ。有効な値： true:アクションを繰り返します。 false:アクションを繰り返しません。データタイプ：ブーリアンデフォルト値：false
testMeasureDefinition.thresholdRule.consequence.validFor	結果が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime	結果の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime	結果の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.thresholdRule.description	しきい値ルールの説明。データタイプ：文字列
testMeasureDefinition.thresholdRule.id	しきい値ルールのSys_idまたはexternal_id。しきい値ルール [sn_st_mgmt_threshold_rule] テーブルにあります。データタイプ：文字列
testMeasureDefinition.thresholdRule.name	しきい値ルールの名前。データタイプ：文字列
testMeasureDefinition.thresholdRule.numberOfAllowedCrossing	結果が適用される前に許容期間内に許可される最大交差。データタイプ：数値最大値:40
testMeasureDefinition.thresholdRule.thresholdRuleSeverity	しきい値ルールの重大度。有効な値：高低 medium データタイプ：文字列
testMeasureDefinition.unitOfMeasure	サービスのパフォーマンスの計算に使用される測定可能な時間 (日、分、秒)。データタイプ：文字列
testMeasureDefinition.validFor	テスト測定定義が有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime": "String" }`
testMeasureDefinition.validFor.endDateTime	テスト測定定義の有効終了日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
testMeasureDefinition.validFor.startDateTime	テスト測定定義の有効開始日。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor	サービステストが有効な日付範囲。データタイプ: オブジェクト `"validFor": { "startDateTime": "String", "endDateTime ": "String" }`
validFor.endDateTime	サービステストの終了日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列
validFor.startDateTime	サービステストの開始日時。形式:YYYY-MM-DD 00:00:00。`たとえば、2025-01-31 09:35:43` などです。データタイプ：文字列

cURL 要求

次の例では、新しいサービステスト定義を作成します。

curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'username':'password'
-- data {
  "description": "Upstream and Downstream speed ",
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
        },
        {
          "value": "Yes",
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
}

応答本文。

{
  "description": "Upstream and Downstream speed ",  
  "name": "Speed Test",
  "validFor": {
    "startDateTime": "2024-05-31",
    "endDateTime": "2024-06-27"
  },
  "testMeasureDefinition": [
    {
      "id": "1a04f560432a02104fefe4511fb8f2ad",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the downstream speed in a service",
      "metricName": "Downstream Speed",
      "name": "Downstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "30 Minutes",
      "validFor": {
        "startDateTime": "2024-05-30 08:49:26",
        "endDateTime": "2024-05-31 08:49:29"
      },
      "thresholdRule": [
        {
          "id": "a754f960432a02104fefe4511fb8f2d0",
          "description": "This speed is greater than the target upper",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "high",
          "tolerancePeriod": "15 Minutes",
          "conformanceTargetLower": "75",
          "conformanceComparatorLower": "greater than",
          "consequence": [
            {
              "id": "15a4bd60432a02104fefe4511fb8f2b8",
              "prescribeAction": "null",
              "description": "generate a waring report",
              "name": "degradedQualityOfService",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:51:29",
                "endDateTime": "2024-08-06 08:51:31"
              }
            },
            {
              "id": "e6847d60432a02104fefe4511fb8f2c3",
              "prescribeAction": "null",
              "description": "send a warning to the system",
              "name": "packetdrop",
              "repeatAction": "0",
              "validFor": {
                "startDateTime": "2024-05-30 08:50:53",
                "endDateTime": "2024-08-06 08:50:55"
              }
            }
          ]
        },
        {
          "id": "cb55b5a0432a02104fefe4511fb8f201",
          "description": "",
          "name": "InternetSpeedValue",
          "numberOfAllowedCrossing": "0",
          "thresholdRuleSeverity": "medium",
          "tolerancePeriod": "",
          "conformanceTargetUpper": "120",
          "conformanceComparatorUpper": "less than",
          "consequence": []
        }
      ]
    },
    {
      "id": "8f987524432a02104fefe4511fb8f2f0",
      "captureFrequency": "once",
      "captureMethod": "automatic",
      "metricDescription": "This is the upstream speed in the service",
      "metricName": "Upstream Speed",
      "name": "Upstream Speed",
      "unitOfMeasure": "a second",
      "valueType": "",
      "capturePeriod": "",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "thresholdRule": []
    }
  ],
  "specCharacteristic": [
    {
      "name": "restart",
      "description": "restart",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2024-05-30 08:45:49"
      },
      "characteristicValueSpecification": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          }
        }
      ]
    }
  ],
  "serviceTestSpecRelationship": [
    {
      "id": "76a3b160432a02104fefe4511fb8f2ad",
      "name": "OAM Test",
      "relationshipType": ""
    }
  ],
  "relatedServiceSpecification": [
    {
      "id": "aeddcd1fb7d69910ff00f203ae11a990",
      "name": "Home Internet"
    }
  ]
  "id": "89d2b920432a02104fefe4511fb8f22e"
}