--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # サービステスト管理オープン API # サービステスト管理オープン API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：218分 サービステスト管理オープン API は、サービステスト定義とサービステストを作成および取得するためのエンドポイントを提供します。 この API を使用して、外部システムと ServiceNow AI Platform間のサービス問題管理情報を管理します。サービステスト管理オープン API は、TM フォーラムのサービス問題管理 API REST 仕様のServiceNow実装です。この実装は、 [TMF653 サービステスト管理 API ユーザーガイド v4.1.0 (](https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/)2021 年 7 月) に基づいています。 この REST API は、通信環境内でサービステストを管理および実行するように設計されています。これにより、ユーザーはサービステストを定義、トリガー、監視して、サービスが品質とパフォーマンスの基準を満たしていることを確認できます。API は、テスト定義の作成と更新、テストの実行、テスト結果の取得、テストスケジュールの管理など、テスト管理のための機能を提供します。 サービステスト管理オープン API には、ServiceNow Store で入手可能な カスタマーサービス問題管理 (com.sn_sprb_mgmt) アプリケーションが必要です。詳細については、「[Customer Service Problem Management](https://www.servicenow.com/docs/access?context=cspm-landing-page&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 この API は `sn_sprb_mgmt` 名前空間で実行されます。呼び出し元ユーザーには sn_sprb_mgmt.test_integrator ロールが必要です。 サービステスト管理オープン 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\] {#service-test-management-api__ul_a4n_gcw_4bc} ## サービステスト管理オープン API -- GET /sn_sprb_mgmt/servicetestmanagement/serviceTest {#ariaid-title2} すべてのサービステストのリストを取得します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest ### サポートされている要求パラメーター {#servicetestmgmt-GET-serviceTest__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 1. パスパラメーター] {#servicetestmgmt-GET-serviceTest__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト \[sn_st_mgmt_test\] テーブルにあります。 有効なフィールド： * 特性 * description * endDateTime * ID * mode * 関連サービス * startDateTime * 状況 * テスト測定 * テスト仕様 * validFor {#servicetestmgmt-GET-serviceTest__ul_mtw_b3v_bcc} データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 最大値:100 デフォルト値：20 | | オフセット | レコードの取得を開始する開始インデックス。このパラメーターを使用して、結果を小さく管理しやすいチャンクにページネーションします。最初のレコードは 0 でインデックス付けされます。 データタイプ：数値 デフォルト：0 | | state | テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答に返されます。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-GET-serviceTest__ul_vzj_npn_xbc} データタイプ：文字列 | [表 : 2. クエリパラメーター] {#servicetestmgmt-GET-serviceTest__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-GET-serviceTest__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 4. 要求ヘッダー] {#servicetestmgmt-GET-serviceTest__entry__24} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、 `offset=2` および `limit=3` の場合、Content-Range ヘッダーの値はアイテム `3 から 5` です。 | | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | | 「リンク」 | クエリ結果間を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#servicetestmgmt-GET-serviceTest__ul_yy3_2fs_pbc} | | X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-GET-serviceTest__entry__34}{#servicetestmgmt-GET-serviceTest__entry-200-status-code}{#servicetestmgmt-GET-serviceTest__entry-400-status-code}{#servicetestmgmt-GET-serviceTest__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 206 | 応答で返された部分的なリソース (ページネーションあり)。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 6. ステータスコード] {#servicetestmgmt-GET-serviceTest__table_ash_mhx_vbc__entry__2} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、次を参照してください。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-GET-serviceTest__ul_zfr_twr_dcc} データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | 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:サービステストを手動でトリガーします。 * プロアクティブ:サービステストを自動的にトリガーします。 {#servicetestmgmt-GET-serviceTest__ul_ybc_mqn_xbc} データタイプ：文字列 デフォルト:オンデマンド | | 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`。 | | 状況 | サービステストのステータス。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-GET-serviceTest__ul_gym_mqn_xbc} データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-GET-serviceTest__ul_ed2_gxv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-GET-serviceTest__ul_ld2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorExact | 値が同一かどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-GET-serviceTest__ul_od2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorLower | 値がしきい値を下回っているかどうかを確認する演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-GET-serviceTest__ul_sd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComporatorUpper | 値がしきい値を超えているかどうかを確認する演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-GET-serviceTest__ul_vd2_gxv_xbc} データタイプ：文字列 | | 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 * 低 {#servicetestmgmt-GET-serviceTest__ul_xd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 指定された時間間隔。この時間間隔の間に、即時の結果やアクションをトリガーせずに交差が発生することができます。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-GET-serviceTest__ul_qbw_qds_dcc} データタイプ：文字列 | | 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": { "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`。 | [表 : 7. 応答本文のパラメーター (XML または JSON)] {#servicetestmgmt-GET-serviceTest__table_ash_mhx_vbc} ### 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} {#ariaid-title3} サービステストの指定された ID に基づいてサービステストエンティティを取得します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id} ### サポートされている要求パラメーター {#servicetestmgmt-GET-serviceTest-id__entry__2} | 名前 | 説明 | |-|-| | ID | 取得するサービステストのSys_idまたはexternal_id。 データタイプ：文字列 テーブル:サービステスト \[sn_st_mgmt_test\] | [表 : 8. パスパラメーター] {#servicetestmgmt-GET-serviceTest-id__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト \[sn_st_mgmt_test\] テーブルにあります。 有効なフィールド： * 特性 * description * endDateTime * ID * mode * 関連サービス * startDateTime * 状況 * テスト測定 * テスト仕様 * validFor {#servicetestmgmt-GET-serviceTest-id__ul_mtw_b3v_bcc} データタイプ：文字列 | [表 : 9. クエリパラメーター] {#servicetestmgmt-GET-serviceTest-id__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 10. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-GET-serviceTest-id__entry__14} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 要求ヘッダー] {#servicetestmgmt-GET-serviceTest-id__entry__18} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | [表 : 12. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-GET-serviceTest-id__entry__22}{#servicetestmgmt-GET-serviceTest-id__entry-200-status-code}{#servicetestmgmt-GET-serviceTest-id__entry-400-status-code}{#servicetestmgmt-GET-serviceTest-id__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 13. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-GET-serviceTest-id__section_vkd_xwr_pbc} {#servicetestmgmt-GET-serviceTest-id__section_vkd_xwr_pbc__entry__2} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-GET-serviceTest-id__ul_egw_twr_dcc} データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | 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:サービステストを手動でトリガーします。 * プロアクティブ:サービステストを自動的にトリガーします。 {#servicetestmgmt-GET-serviceTest-id__ul_itl_ksn_xbc} データタイプ：文字列 デフォルト:オンデマンド | | 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`。 | | 状況 | サービステストのステータス。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-GET-serviceTest-id__ul_prs_txv_xbc} データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-GET-serviceTest-id__ul_zrs_txv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-GET-serviceTest-id__ul_kss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.appliedConsequence.description | 適用された結果の説明。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.id | 適用された結果のSys_idまたはexternal_id。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.name | 適用された結果の名前。 データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorExact | 値が conformanceTargetExact の値と同じかどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-GET-serviceTest-id__ul_uss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値に等しい (=) {#servicetestmgmt-GET-serviceTest-id__ul_fts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * 次の値に等しい (=) * 次の値未満 {#servicetestmgmt-GET-serviceTest-id__ul_mts_txv_xbc} データタイプ：文字列 | | 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 {#servicetestmgmt-GET-serviceTest-id__ul_tts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 結果が開始されるまでに許可された交差が発生することができる期間または時間間隔。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.amount | 期間の金額 (数値)。 データタイプ：数値 | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-GET-serviceTest-id__ul_my3_qds_dcc} データタイプ：文字列 | | 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\] | | 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 要求 {#servicetestmgmt-GET-serviceTest-id__example_z5y_hvr_rbc} 次の例では、指定された 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 {#ariaid-title4} すべてのサービステスト定義のリストを取得します。 ### URL 形式 デフォルト URL: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification ### サポートされている要求パラメーター {#servicetestmgmt-GET-servTestSpecif__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 14. パスパラメーター] {#servicetestmgmt-GET-servTestSpecif__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト定義 \[sn_st_mgmt_test_definition\] テーブルにあります。 有効な値： * description * ID * name * 関連するサービス仕様 * serviceTestSpecRelationship * specCharacteristic * testMeasureDefinition * validFor {#servicetestmgmt-GET-servTestSpecif__ul_hss_b3v_bcc} データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。 データタイプ：数値 最大値:100 デフォルト値：20 | | オフセット | レコードの取得を開始する開始インデックス。このパラメーターを使用して、結果を小さく管理しやすいチャンクにページネーションします。最初のレコードは 0 でインデックス付けされます。 データタイプ：数値 デフォルト：0 | | state | テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答に返されます。 有効な値： * アーカイブ済み * ドラフト * 公開済み * 廃止 データタイプ：文字列 | [表 : 15. クエリパラメーター] {#servicetestmgmt-GET-servTestSpecif__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 16. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-GET-servTestSpecif__entry__20}{#servicetestmgmt-GET-servTestSpecif__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 17. 要求ヘッダー] {#servicetestmgmt-GET-servTestSpecif__entry__24} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。たとえば、 `offset=2` および `limit=3` の場合、Content-Range ヘッダーの値はアイテム `3 から 5` です。 | | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | | 「リンク」 | クエリ結果内を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#servicetestmgmt-GET-servTestSpecif__ul_acj_pkx_4bc} | | X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 | [表 : 18. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-GET-servTestSpecif__entry__34}{#servicetestmgmt-GET-servTestSpecif__entry-200-status-code}{#servicetestmgmt-GET-servTestSpecif__entry-400-status-code}{#servicetestmgmt-GET-servTestSpecif__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 206 | 応答で返された部分的なリソース (ページネーションあり)。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 19. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-GET-servTestSpecif__section_xvz_1lx_4bc} {#servicetestmgmt-GET-servTestSpecif__table_yvz_1lx_4bc__entry__2} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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\] | | serviceTestSpecRelationship.name | 関連するテスト定義の名前。 データタイプ：文字列 | | serviceTestSpecRelationship.relationshipType | 関係のタイプ。 指定できる値: * 依存関係 * 独占 * 代入 {#servicetestmgmt-GET-servTestSpecif__ul_hpg_xtr_dcc} データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-GET-servTestSpecif__ul_i3m_twr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「[Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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 回 * 週次 {#servicetestmgmt-GET-servTestSpecif__ul_lsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmgmt-GET-servTestSpecif__ul_gsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | メトリクスキャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-GET-servTestSpecif__ul_rn1_3ds_dcc} データタイプ：文字列 | | 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](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ：オブジェクトのアレイ { "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ではありません。 {#servicetestmgmt-GET-servTestSpecif__ul_bsw_jxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-GET-servTestSpecif__ul_zrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-GET-servTestSpecif__ul_wrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceTargetExact | conformanceComparatorExactが true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetLower | テスト測定結果を比較するための下限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetUpper | テスト測定結果を比較するための上限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.consequence | しきい値ルールを超えたときに実行するアクション (規定のアクションまたは通知)。詳細については、「[Define threshold rules for a test measure definition](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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:アクションを繰り返しません。 {#servicetestmgmt-GET-servTestSpecif__ul_srw_jxv_xbc} データタイプ：ブーリアン デフォルト値：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 * 低 {#servicetestmgmt-GET-servTestSpecif__ul_orw_jxv_xbc} データタイプ：文字列 | | 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`。 | [ ] {#servicetestmgmt-GET-servTestSpecif__table_yvz_1lx_4bc} ### 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} {#ariaid-title5} サービステスト定義エンティティを取得します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id} ### サポートされている要求パラメーター {#servicetestmanagement-GET-id__entry__2} | 名前 | 説明 | |-|-| | ID | 取得するサービステスト定義のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:サービステスト定義 \[sn_st_mgmt_test_definition\] | [表 : 20. パスパラメーター] {#servicetestmanagement-GET-id__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。このパラメーターを使用しない場合、すべてのフィールドが返されます。サービステスト定義 \[sn_st_mgmt_test_definition\] テーブルにあります。 有効な値： * description * ID * name * 関連するサービス仕様 * serviceTestSpecRelationship * specCharacteristic * testMeasureDefinition * validFor {#servicetestmanagement-GET-id__ul_hss_b3v_bcc} データタイプ：文字列 | | state | テストの現在のステータスでテスト定義をフィルタリングします。指定されたステータスのテスト定義のみが応答に返されます。 有効な値： * アーカイブ済み * ドラフト * 公開済み * 廃止 データタイプ：文字列 | [表 : 21. クエリパラメーター] {#servicetestmanagement-GET-id__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 22. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmanagement-GET-id__entry__16}{#servicetestmanagement-GET-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 23. 要求ヘッダー] {#servicetestmanagement-GET-id__entry__20}{#servicetestmanagement-GET-id__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 24. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmanagement-GET-id__entry__24}{#servicetestmanagement-GET-id__entry-200-status-code}{#servicetestmanagement-GET-id__entry-400-status-code}{#servicetestmanagement-GET-id__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 25. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmanagement-GET-id__entry__32} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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\] | | serviceTestSpecRelationship.name | 関連するテスト定義の名前。 データタイプ：文字列 | | serviceTestSpecRelationship.relationshipType | 関係のタイプ。 指定できる値: * 依存関係 * 独占 * 代入 {#servicetestmanagement-GET-id__ul_hpg_xtr_dcc} データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmanagement-GET-id__ul_i3m_twr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「[Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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 回 * 週次 {#servicetestmanagement-GET-id__ul_lsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmanagement-GET-id__ul_gsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | メトリクスキャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmanagement-GET-id__ul_rn1_3ds_dcc} データタイプ：文字列 | | 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](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ：オブジェクトのアレイ { "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ではありません。 {#servicetestmanagement-GET-id__ul_bsw_jxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmanagement-GET-id__ul_zrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmanagement-GET-id__ul_wrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceTargetExact | conformanceComparatorExactが true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetLower | テスト測定結果を比較するための下限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetUpper | テスト測定結果を比較するための上限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.consequence | しきい値ルールを超えたときに実行するアクション (規定のアクションまたは通知)。詳細については、「[Define threshold rules for a test measure definition](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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:アクションを繰り返しません。 {#servicetestmanagement-GET-id__ul_srw_jxv_xbc} データタイプ：ブーリアン デフォルト値：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 * 低 {#servicetestmanagement-GET-id__ul_orw_jxv_xbc} データタイプ：文字列 | | 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} {#ariaid-title6} サービステストエンティティを更新します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id} ### サポートされている要求パラメーター {#servicetestmgmt-PATCH-serviceTestid__entry__2} | 名前 | 説明 | |-|-| | ID | 取得するサービステストのSys_idまたはexternal_id。 データタイプ：文字列 テーブル:サービステスト \[sn_st_mgmt_test\] | [表 : 26. パスパラメーター] {#servicetestmgmt-PATCH-serviceTestid__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 27. クエリパラメーター] {#servicetestmgmt-PATCH-serviceTestid__entry__10} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、次を参照してください。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-PATCH-serviceTestid__ul_zfr_twr_dcc} データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | endDateTime | サービステストの終了日時。 データタイプ：文字列 形式:YYYY-MM-DD 00:00:00。例: `2025-01-31 09:35:43`。 | | mode | サービステストが実行されているモード。 有効な値： * ONDEMAND:サービステストを手動でトリガーします。 * プロアクティブ:サービステストを自動的にトリガーします。 {#servicetestmgmt-PATCH-serviceTestid__ul_ybc_mqn_xbc} データタイプ：文字列 デフォルト:オンデマンド | | 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`。 | | 状況 | サービステストのステータス。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-PATCH-serviceTestid__ul_gym_mqn_xbc} データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-PATCH-serviceTestid__ul_ed2_gxv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-PATCH-serviceTestid__ul_ld2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorExact | 値が同一かどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-PATCH-serviceTestid__ul_od2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorLower | 値がしきい値を下回っているかどうかを確認する演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-PATCH-serviceTestid__ul_sd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComporatorUpper | 値がしきい値を超えているかどうかを確認する演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-PATCH-serviceTestid__ul_vd2_gxv_xbc} データタイプ：文字列 | | 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 * 低 {#servicetestmgmt-PATCH-serviceTestid__ul_xd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 指定された時間間隔。この時間間隔の間に、即時の結果やアクションをトリガーせずに交差が発生することができます。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-PATCH-serviceTestid__ul_qbw_qds_dcc} データタイプ：文字列 | | 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": { "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`。 | [表 : 28. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-PATCH-serviceTestid__entry__120}{#servicetestmgmt-PATCH-serviceTestid__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 29. 要求ヘッダー] {#servicetestmgmt-PATCH-serviceTestid__entry__124} | ヘッダー | 説明 | |-|-| | なし | | [表 : 30. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-PATCH-serviceTestid__entry__128}{#servicetestmgmt-PATCH-serviceTestid__entry-200-status-code}{#servicetestmgmt-PATCH-serviceTestid__entry-400-status-code}{#servicetestmgmt-PATCH-serviceTestid__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 31. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-PATCH-serviceTestid__entry__136} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | 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\] | | relatedService.name | 製品在庫の名前。 データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-PATCH-serviceTestid__ul_zrs_txv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-PATCH-serviceTestid__ul_kss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.appliedConsequence.description | 適用された結果の説明。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.id | 適用された結果のSys_idまたはexternal_id。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.name | 適用された結果の名前。 データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorExact | 値が conformanceTargetExact の値と同じかどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-PATCH-serviceTestid__ul_uss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値に等しい (=) {#servicetestmgmt-PATCH-serviceTestid__ul_fts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * 次の値に等しい (=) * 次の値未満 {#servicetestmgmt-PATCH-serviceTestid__ul_mts_txv_xbc} データタイプ：文字列 | | 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 {#servicetestmgmt-PATCH-serviceTestid__ul_tts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 結果が開始されるまでに許可された交差が発生することができる期間または時間間隔。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.amount | 期間の金額 (数値)。 データタイプ：数値 | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-PATCH-serviceTestid__ul_my3_qds_dcc} データタイプ：文字列 | | 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\] | | 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 要求 次の例では、要求本文に指定された詳細に従って、指定されたサービステストエンティティを更新します。 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} {#ariaid-title7} サービステスト定義エンティティの部分的な更新を許可します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id} ### サポートされている要求パラメーター {#servicetestmgmt-PATCH-servTestSp-id__entry__2} | 名前 | 説明 | |-|-| | ID | 取得するサービステスト定義のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:サービステスト定義 \[sn_st_mgmt_test_definition\] | [表 : 32. パスパラメーター] {#servicetestmgmt-PATCH-servTestSp-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 33. クエリパラメーター] {#servicetestmgmt-PATCH-servTestSp-id__entry__10} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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\] | | serviceTestSpecRelationship.name | 関連するテスト定義の名前。 データタイプ：文字列 | | serviceTestSpecRelationship.relationshipType | 関係のタイプ。 指定できる値: * 依存関係 * 独占 * 代入 {#servicetestmgmt-PATCH-servTestSp-id__ul_hpg_xtr_dcc} データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-PATCH-servTestSp-id__ul_i3m_twr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「[Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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 回 * 週次 {#servicetestmgmt-PATCH-servTestSp-id__ul_lsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_gsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | メトリクスキャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-PATCH-servTestSp-id__ul_rn1_3ds_dcc} データタイプ：文字列 | | 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](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ：オブジェクトのアレイ { "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ではありません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_bsw_jxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-PATCH-servTestSp-id__ul_zrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-PATCH-servTestSp-id__ul_wrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceTargetExact | conformanceComparatorExactが true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetLower | テスト測定結果を比較するための下限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetUpper | テスト測定結果を比較するための上限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.consequence | しきい値ルールを超えたときに実行するアクション (規定のアクションまたは通知)。詳細については、「[Define threshold rules for a test measure definition](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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:アクションを繰り返しません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_srw_jxv_xbc} データタイプ：ブーリアン デフォルト値：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 * 低 {#servicetestmgmt-PATCH-servTestSp-id__ul_orw_jxv_xbc} データタイプ：文字列 | | 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`。 | [表 : 34. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-PATCH-servTestSp-id__entry__118}{#servicetestmgmt-PATCH-servTestSp-id__accept-RESTAPI}{#servicetestmgmt-PATCH-servTestSp-id__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 35. 要求ヘッダー] {#servicetestmgmt-PATCH-servTestSp-id__entry__124} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | [表 : 36. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-PATCH-servTestSp-id__entry__128}{#servicetestmgmt-PATCH-servTestSp-id__entry-200-status-code}{#servicetestmgmt-PATCH-servTestSp-id__entry-400-status-code}{#servicetestmgmt-PATCH-servTestSp-id__entry-404-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 | [表 : 37. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-PATCH-servTestSp-id__section_h1m_wz4_qbc} {#servicetestmgmt-PATCH-servTestSp-id__table_i1m_wz4_qbc__entry__2} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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\] | | serviceTestSpecRelationship.name | 関連するテスト定義の名前。 データタイプ：文字列 | | serviceTestSpecRelationship.relationshipType | 関係のタイプ。 指定できる値: * 依存関係 * 独占 * 代入 {#servicetestmgmt-PATCH-servTestSp-id__d4708e2410} データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-PATCH-servTestSp-id__ul_uwb_5wr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「 [Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US) 」を参照してください。 データタイプ：オブジェクトのアレイ "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 回 * 週次 {#servicetestmgmt-PATCH-servTestSp-id__ul_od2_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_rd2_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | キャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 指定できる値: * days * 時間 * 分 * 秒 {#servicetestmgmt-PATCH-servTestSp-id__ul_lfv_dds_dcc} データタイプ：文字列 | | 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ではありません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_gyl_vqr_dcc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値に等しい (=) {#servicetestmgmt-PATCH-servTestSp-id__ul_b22_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * 次の値未満 * 次の値に等しい (=) {#servicetestmgmt-PATCH-servTestSp-id__ul_e22_sxv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-PATCH-servTestSp-id__ul_rjm_pxy_rbc} データタイプ：ブーリアン デフォルト値：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 {#servicetestmgmt-PATCH-servTestSp-id__ul_j22_sxv_xbc} データタイプ：文字列 | | 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`。 | [ ] {#servicetestmgmt-PATCH-servTestSp-id__table_i1m_wz4_qbc} ### 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 {#ariaid-title8} サービステストを作成します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest ### サポートされている要求パラメーター {#servicetestmgmt-POST-serviceTest__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 38. パスパラメーター] {#servicetestmgmt-POST-serviceTest__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 39. クエリパラメーター] {#servicetestmgmt-POST-serviceTest__id_q31_zd1_qbc__entry__2}{#servicetestmgmt-POST-serviceTest__serviceTest-request-characteristic}{#servicetestmgmt-POST-serviceTest__serviceTest-request-characteristic.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-characteristic.name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-characteristic.value}{#servicetestmgmt-POST-serviceTest__serviceTest-request-characteristic.valueType}{#servicetestmgmt-POST-serviceTest__serviceTest-request-description}{#servicetestmgmt-POST-serviceTest__serviceTest-request-endDateTime}{#servicetestmgmt-POST-serviceTest__serviceTest-request-id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-mode}{#servicetestmgmt-POST-serviceTest__serviceTest-request-name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-relatedService}{#servicetestmgmt-POST-serviceTest__serviceTest-request-relatedService.href}{#servicetestmgmt-POST-serviceTest__serviceTest-request-relatedService.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-relatedService.name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-startDateTime}{#servicetestmgmt-POST-serviceTest__serviceTest-request-state}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.accuracy}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.captureDateTime}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.captureMethod}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.metricDescription}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.metricName}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence.appliedAction}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence.description}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence.name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.appliedConsequence.repeatAction}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceComporatorExact}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceComporatorLower}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceComporatorUpper}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceTargetExact}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceTargetLower}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.conformanceTargetUpper}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.description}{#servicetestmgmt-POST-serviceTest__serviceTest-request-test.Measure.ruleViolation.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.numberOfAllowedCrossing}{#servicetestmgmt-POST-serviceTest__serviceTest-request-estMeasure.ruleViolation.thresholdRuleSeverity}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.tolerancePeriod}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.amount}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.ruleViolation.tolerancePeriod.units}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.unitOfMeasure}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.value}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.value.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.value.name}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.value.value}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testMeasure.value.valueType}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testSpecification}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testSpecification.href}{#servicetestmgmt-POST-serviceTest__serviceTest-request-testSpecification.id}{#servicetestmgmt-POST-serviceTest__serviceTest-request-validFor}{#servicetestmgmt-POST-serviceTest__serviceTest-request-validFor.endDateTime}{#servicetestmgmt-POST-serviceTest__serviceTest-request-validFor.startDateTime} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。テスト定義の特性の詳細については、次を参照してください。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-POST-serviceTest__ul_zfr_twr_dcc} データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | endDateTime | サービステストの終了日時。 データタイプ：文字列 形式:YYYY-MM-DD 00:00:00。例: `2025-01-31 09:35:43`。 | | ID | サービステストのSys_idまたはexternal_id。この ID はサービステストを作成し、external_idとして使用されます。 データタイプ：文字列 テーブル:サービステスト \[sn_st_mgmt_test\] | | mode | サービステストが実行されているモード。 有効な値： * ONDEMAND:サービステストを手動でトリガーします。 * プロアクティブ:サービステストを自動的にトリガーします。 {#servicetestmgmt-POST-serviceTest__ul_ybc_mqn_xbc} データタイプ：文字列 デフォルト:オンデマンド | | 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`。 | | 状況 | サービステストのステータス。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-POST-serviceTest__ul_gym_mqn_xbc} データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-POST-serviceTest__ul_ed2_gxv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-POST-serviceTest__ul_ld2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorExact | 値が同一かどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-POST-serviceTest__ul_od2_gxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComporatorLower | 値がしきい値を下回っているかどうかを確認する演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-POST-serviceTest__ul_sd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComporatorUpper | 値がしきい値を超えているかどうかを確認する演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-POST-serviceTest__ul_vd2_gxv_xbc} データタイプ：文字列 | | 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 * 低 {#servicetestmgmt-POST-serviceTest__ul_xd2_gxv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 指定された時間間隔。この時間間隔の間に、即時の結果やアクションをトリガーせずに交差が発生することができます。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.amount | 結果を適用するまでの期間の数。 データタイプ：数値 | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-POST-serviceTest__ul_qbw_qds_dcc} データタイプ：文字列 | | 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": { "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`。 | [表 : 40. 要求本文パラメーター (XML または JSON)] {#servicetestmgmt-POST-serviceTest__id_q31_zd1_qbc} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-POST-serviceTest__entry__124}{#servicetestmgmt-POST-serviceTest__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 41. 要求ヘッダー] {#servicetestmgmt-POST-serviceTest__entry__128} | ヘッダー | 説明 | |-|-| | なし | | [表 : 42. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-POST-serviceTest__entry__132}{#servicetestmgmt-POST-serviceTest__entry-200-status-code}{#servicetestmgmt-POST-serviceTest__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 43. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-POST-serviceTest__table_qzk_r2p_qbc__entry__2} | 名前 | 説明 | |-|-| | 特性 | 関連付けられたサービステストの特性を説明するリスト。 データタイプ：オブジェクトのアレイ "characteristic": [ { "id": "String", "name": "String", "value": "String", "valueType": "String" } ] | | characteristic.id | 特性のSys_idまたはexternal_id。そのレコードにexternal_idが存在する場合、応答はexternal_idを返し、そうでない場合はsys_idを返します。 データタイプ：文字列 テーブル:特性 \[sn_prd_pm_characteristic\] | | characteristic.name | 特性の名前。 データタイプ：文字列 | | characteristic.value | サービステストに関連付けられた特性オプション。特性はお客様のインスタンスによって異なります。 データタイプ：文字列 | | characteristic.valueType | 特性値のタイプ。 * 選択 * date * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ データタイプ：文字列 | | description | サービステストの説明。 データタイプ：文字列 | | endDateTime | サービステストの終了日時。 データタイプ：文字列 形式:YYYY-MM-DD 00:00:00。例: `2025-01-31 09:35:43`。 | | ID | サービステスト定義のSys_idまたはexternal_id。 データタイプ：文字列 テーブル:サービステスト \[sn_st_mgmt_test\] | | mode | サービステストが実行されているモード。 有効な値： * ONDEMAND:サービステストを手動でトリガーします。 * プロアクティブ:サービステストを自動的にトリガーします。 {#servicetestmgmt-POST-serviceTest__ul_itl_ksn_xbc} データタイプ：文字列 デフォルト:オンデマンド | | name | サービステストの名前。 データタイプ：文字列 | | 関連サービス | このテストに関連付けられたテスト定義。 データタイプ: オブジェクト "relatedService": { "href": "string", "id": "String", "name": "String" } | | relatedService.id | 製品インベントリのSys_idまたはexternal_id。 データタイプ：文字列 テーブル:プロダクトインベントリ \[sn_prd_invt_product_inventory\] | | relatedService.name | 製品在庫の名前。 データタイプ：文字列 | | startDateTime | サービステストの開始日時。 データタイプ：文字列 形式:YYYY-MM-DD 00:00:00。例: `2025-01-31 09:35:43`。 | | 状況 | サービステストのステータス。 有効な値： * 確認済み * キャンセル * 完了 * 失敗 * 進行中 * 保留中 * 却下 {#servicetestmgmt-POST-serviceTest__ul_prs_txv_xbc} データタイプ：文字列 | | テスト測定 | 失われたパケットや接続ステータスなど、製品、サービス、またはリソーステストの特定の側面の測定値。 データタイプ：オブジェクトのアレイ "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:メトリクスをキャプチャしません。 {#servicetestmgmt-POST-serviceTest__ul_zrs_txv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-POST-serviceTest__ul_kss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.appliedConsequence.description | 適用された結果の説明。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.id | 適用された結果のSys_idまたはexternal_id。 データタイプ：文字列 | | testMeasure.ruleViolation.appliedConsequence.name | 適用された結果の名前。 データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorExact | 値が conformanceTargetExact の値と同じかどうかを示すフラグ。 有効な値： * true:値は同じです。 * false:値が同一ではありません。 {#servicetestmgmt-POST-serviceTest__ul_uss_txv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasure.ruleViolation.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値に等しい (=) {#servicetestmgmt-POST-serviceTest__ul_fts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * 次の値に等しい (=) * 次の値未満 {#servicetestmgmt-POST-serviceTest__ul_mts_txv_xbc} データタイプ：文字列 | | 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 {#servicetestmgmt-POST-serviceTest__ul_tts_txv_xbc} データタイプ：文字列 | | testMeasure.ruleViolation.tolerancePeriod | 結果が開始されるまでに許可された交差が発生することができる期間または時間間隔。 日付タイプ:オブジェクト "tolerancePeriod": { "amount": Number, "units": "String" } | | testMeasure.ruleViolation.tolerancePeriod.amount | 期間の金額 (数値)。 データタイプ：数値 | | testMeasure.ruleViolation.tolerancePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-POST-serviceTest__ul_my3_qds_dcc} データタイプ：文字列 | | 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\] | | 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`。 | [ ] {#servicetestmgmt-POST-serviceTest__table_qzk_r2p_qbc} ### cURL 要求 {#servicetestmgmt-POST-serviceTest__example_x42_qf1_qbc} 次の例では、要求本文に指定された特定の詳細に従って、新しいサービステストを作成します。 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 {#ariaid-title9} 新しいサービステスト定義を作成します。 ### URL 形式 デフォルト URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification ### サポートされている要求パラメーター {#servicetestmgmt-POST-serviceTestSp__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 44. パスパラメーター] {#servicetestmgmt-POST-serviceTestSp__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 45. クエリパラメーター] {#servicetestmgmt-POST-serviceTestSp__id_thr_xwn_qbc__entry__2}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-description-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-id-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-relatedServiceSpecification-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-relatedServiceSpecification.id-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-relatedServiceSpecification.name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristics-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristics.characteristicValueSpecification-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.characteristicValueSpecification.value-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.characteristicValueSpecification.descr-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.characteristicValueSpecification.name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.validFor-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.validFor.endDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.validFor.startDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-specCharacteristic.valueType-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.captureFrequency-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.captureMethod-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.capturePeriod-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.capturePeriod.amount-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.capturePeriod.units-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.id-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.metricDescription-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.metricName-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.ComporatorExact-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.ComporatorLower-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.ComporatorUpper-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.TargetExact-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.TargetLower-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.TargetUpper-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.description-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.id-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.prescribeAction-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.repeatAction-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.validFor-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.description-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.id-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.name-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.numberOfAllowedCrossing-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.thresholdRule.thresholdRuleSeverity-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.unitOfMeasure-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.validFor-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.validFor.endDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-testMeasureDefinition.validFor.startDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-validFor-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-validFor.endDateTime-param}{#servicetestmgmt-POST-serviceTestSp__testSpec-request-validFor.startDateTime-param} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-POST-serviceTestSp__ul_i3m_twr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「[Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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 回 * 週次 {#servicetestmgmt-POST-serviceTestSp__ul_lsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmgmt-POST-serviceTestSp__ul_gsw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | メトリクスキャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 有効な値： * days * 時間 * 分 * 秒 {#servicetestmgmt-POST-serviceTestSp__ul_rn1_3ds_dcc} データタイプ：文字列 | | 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](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ：オブジェクトのアレイ { "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ではありません。 {#servicetestmgmt-POST-serviceTestSp__ul_bsw_jxv_xbc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値以上 (\>=) {#servicetestmgmt-POST-serviceTestSp__ul_zrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * は次の値未満 (\<) * 次の値以下 (\<=) {#servicetestmgmt-POST-serviceTestSp__ul_wrw_jxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceTargetExact | conformanceComparatorExactが true に設定されている場合は必須です。conformanceComparatorExact値が true に設定されている場合、その値は conformanceTargetExact で定義された値と一致します。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetLower | テスト測定結果を比較するための下限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.conformanceTargetUpper | テスト測定結果を比較するための上限しきい値。 データタイプ：数値 | | testMeasureDefinition.thresholdRule.consequence | しきい値ルールを超えたときに実行するアクション (規定のアクションまたは通知)。詳細については、「[Define threshold rules for a test measure definition](https://www.servicenow.com/docs/access?context=define-threshold-rules&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US)」を参照してください。 データタイプ:オブジェクトのアレイ "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:アクションを繰り返しません。 {#servicetestmgmt-POST-serviceTestSp__ul_srw_jxv_xbc} データタイプ：ブーリアン デフォルト値：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 * 低 {#servicetestmgmt-POST-serviceTestSp__ul_orw_jxv_xbc} データタイプ：文字列 | | 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`。 | [表 : 46. 要求本文パラメーター (XML または JSON)] {#servicetestmgmt-POST-serviceTestSp__id_thr_xwn_qbc} ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#servicetestmgmt-POST-serviceTestSp__entry__126}{#servicetestmgmt-POST-serviceTestSp__accept-JSON-only-entry-RESTAPI}{#servicetestmgmt-POST-serviceTestSp__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 47. 要求ヘッダー] {#servicetestmgmt-POST-serviceTestSp__entry__132} | ヘッダー | 説明 | |-|-| | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | [表 : 48. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#servicetestmgmt-POST-serviceTestSp__entry__136}{#servicetestmgmt-POST-serviceTestSp__entry-200-status-code}{#servicetestmgmt-POST-serviceTestSp__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 49. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#servicetestmgmt-POST-serviceTestSp__table_qqg_3s4_qbc__entry__2} | 名前 | 説明 | |-|-| | description | サービステスト定義の説明。 データタイプ：文字列 | | 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\] | | serviceTestSpecRelationship.name | 関連するテスト定義の名前。 データタイプ：文字列 | | serviceTestSpecRelationship.relationshipType | 関係のタイプ。 指定できる値: * 依存関係 * 独占 * 代入 {#servicetestmgmt-POST-serviceTestSp__ul_hpg_xtr_dcc} データタイプ：文字列 | | 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 * 日付/時刻 * duration * email * label * 単一行テスト * はい/いいえ {#servicetestmgmt-POST-serviceTestSp__ul_uwb_5wr_dcc} データタイプ：文字列 | | testMeasureDefinition | このサービステスト定義のテスト測定定義。詳細については、「 [Define test measure definitions for a service test](https://www.servicenow.com/docs/access?context=define-test-measure-spm&version=australia&pubname=australia-telecom-media-technology&ft:locale=en-US) 」を参照してください。 データタイプ：オブジェクトのアレイ "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 回 * 週次 {#servicetestmgmt-POST-serviceTestSp__ul_od2_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.captureMethod | メトリクスのキャプチャに使用される方法。 有効な値： * 自動:メトリクスを自動的にキャプチャします。 * manual:メトリクスを手動でキャプチャします。 * none:メトリクスをキャプチャしません。 {#servicetestmgmt-POST-serviceTestSp__ul_rd2_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.capturePeriod | キャプチャの期間または期間。 データタイプ: オブジェクト "capturePeriod": { "amount": Number, "units": "String" } | | testMeasureDefinition.capturePeriod.amount | キャプチャ期間の数。 データタイプ：数値 | | testMeasureDefinition.capturePeriod.units | 期間の単位。 指定できる値: * days * 時間 * 分 * 秒 {#servicetestmgmt-POST-serviceTestSp__ul_lfv_dds_dcc} データタイプ：文字列 | | 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ではありません。 {#servicetestmgmt-POST-serviceTestSp__ul_gyl_vqr_dcc} データタイプ：ブーリアン デフォルト値：false | | testMeasureDefinition.thresholdRule.conformanceComparatorLower | 値がしきい値を下回っているかどうかをチェックする演算子。 有効な値： * は次の値を超える (\>) * 次の値に等しい (=) {#servicetestmgmt-POST-serviceTestSp__ul_b22_sxv_xbc} データタイプ：文字列 | | testMeasureDefinition.thresholdRule.conformanceComparatorUpper | 値がしきい値を超えているかどうかをチェックする演算子。 有効な値： * 次の値未満 * 次の値に等しい (=) {#servicetestmgmt-POST-serviceTestSp__ul_e22_sxv_xbc} データタイプ：文字列 | | 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:アクションを繰り返しません。 {#servicetestmgmt-POST-serviceTestSp__ul_rjm_pxy_rbc} データタイプ：ブーリアン デフォルト値：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 {#servicetestmgmt-POST-serviceTestSp__ul_j22_sxv_xbc} データタイプ：文字列 | | 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`。 | [ ] {#servicetestmgmt-POST-serviceTestSp__table_qqg_3s4_qbc} ### 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" }