---
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


---

# ATF コードカバレッジ API

# ATF コードカバレッジ API {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：27分

ATF コードカバレッジ API は、自動テストフレームワーク (ATF) の実行からコードカバレッジを計算するためのエンドポイントを提供します。範囲は、フィルタリングされた行番号、特定のスクリプト ID、または一連のテストスイート/テスト実行の対象となるすべてのスクリプトによって取得できます。

ATF コードカバレッジは、展開要求内のコードの何パーセントが ATF テストスイートでカバーされているかを判断できるツールです。

デフォルトでは、ATF テストスイートが展開要求のコードの 70% 未満をカバーする場合、ReleaseOps は展開要求を \[調整中\] ステータスに移行し、テスト失敗タスクが自動的に作成されます。ATF コードカバレッジしきい値は、展開要求アセスメントプレイブックで調整できます。詳細については、「[Set Automated Test Framework (ATF) code coverage](https://www.servicenow.com/docs/access?context=set-atf-code-coverage-threshold&version=australia&pubname=australia-application-development&ft:locale=en-US)」を参照してください。

ATF および Performance Analyzer の詳細については、 を参照してください。 [Testing and debugging applications](https://www.servicenow.com/docs/access?context=testing-and-debugging-applications&version=australia&pubname=australia-application-development&ft:locale=en-US)

[Deployment analyzer in ReleaseOps](https://www.servicenow.com/docs/access?context=deployment-analyzer&version=australia&pubname=australia-application-development&ft:locale=en-US)

## ATF コードカバレッジ - POST /now/atf/code_coverage/all {#ariaid-title2}

指定された ATF 実行の対象となるすべてのスクリプトの範囲をアグリゲートします。テストスイートの実行と個々のテスト実行の組み合わせをサポートします。

### URL 形式

バージョニングされた URL: /api/now/v1/atf/code_coverage/all

デフォルト URL: /api/now/atf/code_coverage/all

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

{#atf_code_covg-POST-all__entry__2}{#atf_code_covg-POST-all__version-not_optional-RESTAPI}

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

{#atf_code_covg-POST-all__entry__6}

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

{#atf_code_covg-POST-all__entry__10}

| 名前 | 説明 |
|-|-|
| test_suite_result_ids | `test_result_ids`が指定されていない限り必須です。テストスイート結果sys_idsのリスト。 テーブル:テストスイート結果 \[sys_atf_test_suite_result\] データタイプ：文字列のアレイ |
| test_result_ids | `test_suite_result_ids`が指定されていない限り必須です。含めるテスト結果sys_idsのリスト (スイートと組み合わせ可能)。 テーブル:テスト結果 \[sys_atf_test_result\] データタイプ：文字列のアレイ |
| 詳細 | 各カスタムテストスクリプトの応答で提供する詳細レベルを示すフラグ。 有効な値： * true:応答本文 details オブジェクトにアイテムごとの詳細なカバー範囲を含めます。 * false:オブジェクト details 応答本文は空を返すか、まったく返しません。 {#atf_code_covg-POST-all__ul_qm3_ycy_l3c} デフォルト値：false データタイプ：ブーリアン |
| sys_scopes | 結果を指定したアプリケーションスコープ (例:`、["x_my_app", "global"]`) にフィルタリングします。複数のスコープは OR ロジックを使用するため、一致するスコープが含まれます。空のアレイまたは NULL アレイが指定されている場合、フィルタリングは行われません。 データタイプ：文字列のアレイ |
[表 : 3. 要求本文パラメーター (JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#atf_code_covg-POST-all__entry__20}{#atf_code_covg-POST-all__accept-RESTAPI}

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

{#atf_code_covg-POST-all__entry__24}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#atf_code_covg-POST-all__entry__28}{#atf_code_covg-POST-all__entry-200-status-code}{#atf_code_covg-POST-all__entry-400-status-code}{#atf_code_covg-POST-all__entry-500-status-code}

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

### 応答本文のパラメーター (JSON)

{#atf_code_covg-POST-all__table_10z_n1c_i8e__entry__2}

| 名前 | 説明 |
|-|-|
| link | 要求レコードへのリンク。 データタイプ：文字列 |
| details.\<scriptId\> | 各カスタムテストスクリプトの ATF 集計範囲の割合をスクリプトsys_id別に一覧表示します。 データタイプ：数値 |
| api_request_sys_id | 要求のsys_id。 テーブル:ATF コードカバレッジ API 要求 \[sys_atf_code_coverage_request\] データタイプ：文字列 |
| result | 成功またはエラーメッセージ。 エラー応答フォーマット: * 400 要求が正しくありません`{ "result": "検証エラー: <specific_error_message>" }` * 500 内部サーバーエラー`{ "result": "内部サーバーエラー:<error_message>" }` {#atf_code_covg-POST-all__ul_apt_1ss_l3c} 考えられるエラー: * 要求本文の検証: `要求本文は必須であり、空にすることはできません` * テスト ID 検証: `少なくとも 1 つの有効な (空でない) ID を test_result_ids または test_suite_result_ids で指定する必要があります` * タイプの不一致: `要求パラメーターのデータタイプが無効です` {#atf_code_covg-POST-all__ul_qzs_kts_l3c} データタイプ：文字列 |
| total | detailsプロパティにリストされているスクリプトの ATF コードカバレッジの合計を反映する、全体的なコードカバレッジの割合。提供されたテストにカスタムスクリプトが関連付けられていない場合、またはコードカバレッジの割合が指定されていない場合、値はゼロです。 可能な値:0〜100 データタイプ：数値 |
| truncation_message | 要求データが切り捨てられた場合 永続化中は、どのスクリプトが情報を切り捨てたかについての詳細を提供します。 メッセージの例: `truncation_message:「フィールド atf_code_coverage_request.metadata_info が 5,000 文字から 4,000 文字に短縮されました (最大:4,000 文字)。データ損失を防ぐために列長を長くすることを検討してください」` データタイプ：文字列 |
| was_truncated | 永続化中に要求データが切り捨てられたかどうかを示すフラグ。切り捨てを減らすために、 サポートされているデフォルトの文字数を変更できます。 たとえば、 `request_data_truncated: true` です。 有効な値： * true:永続化中に要求データが切り捨てられました。 * false:永続化中に要求データが切り捨てられませんでした。 {#atf_code_covg-POST-all__ul_ihd_rdy_l3c} データタイプ：ブーリアン デフォルトの文字数:4000 |
[ ]

{#atf_code_covg-POST-all__table_10z_n1c_i8e}  

### cURL 要求

次の例は、選択したテスト結果スイートとテスト結果のすべてのコードカバレッジを取得する方法を示しています。

    curl "https://instance.service-now.com/api/now/atf/code_coverage/all" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"test_suite_result_ids\": [\"5f81c7c4ff943210b88affffffffffc5\"],
      \"test_result_ids\": [\"bb8daec1ff103210b88affffffffff1c\"],
      \"verbose\": true,
      \"sys_scopes\": [\"x_my_app\", \"global\"]
    }" \
    --user 'username':'password'

出力:

    {
      "result": "success",
      "total": 73,
      "details": {
        "sys_script_include_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6": 85,
        "sys_script_include_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7": 92,
        "sys_ui_script_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8": 45,
        "sys_script_d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9": 68,
        "sys_script_include_e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0": 100
      },
      "api_request_sys_id": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
      "link": "https://instance.service-now.com/sys_atf_code_coverage_request.do?sys_id=f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1"
    }

## ATF コードカバレッジ:POST /now/atf/code_coverage/by_script_id {#ariaid-title3}

特定のスクリプトレコードのカバレッジを計算します。
指定された ATF 実行の対象となるすべてのスクリプトのコードカバレッジを計算するには、エンドポイント /now/atf/code_coverage/all を使用します。

### URL 形式 {#atf_code_covg-POST-byScriptId__section_tr5_5b2_l3c}

バージョニングされた URL: /api/now/v1/atf/code_coverage/by_script_id

デフォルト URL: /api/now/atf/code_coverage/by_script_id

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

{#atf_code_covg-POST-byScriptId__entry__2}{#atf_code_covg-POST-byScriptId__version-not_optional-RESTAPI}

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

{#atf_code_covg-POST-byScriptId__entry__6}

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

{#atf_code_covg-POST-byScriptId__entry__10}

| 名前 | 説明 |
|-|-|
| test_suite_result_ids | `test_result_ids`が指定されていない限り必須です。テストスイート結果sys_idsのリスト。 テーブル:テストスイート結果 \[sys_atf_test_suite_result\] データタイプ：文字列のアレイ |
| test_result_ids | `test_suite_result_ids`が指定されていない限り必須です。含めるテスト結果sys_idsのリスト (スイートと組み合わせ可能)。 テーブル:テスト結果 \[sys_atf_test_result\] データタイプ：文字列のアレイ |
| script_array | 必須です。コードカバレッジを評価する 1 つ以上の有効なスクリプトsys_ids。有効な (空でない) スクリプト識別子を少なくとも 1 つ含める必要があります。null、空、または空白のみのエントリは除外されます。 テーブル:メタデータトレース \[sys_traced_metadata\] データタイプ：アレイ |
| 詳細 | 各カスタムテストスクリプトの応答で提供する詳細レベルを示すフラグ。 有効な値： * true:応答本文 details オブジェクトにアイテムごとの詳細なカバー範囲を含めます。 * false:オブジェクト details 応答本文は空を返すか、まったく返しません。 {#atf_code_covg-POST-byScriptId__ul_qm3_ycy_l3c} デフォルト値：false データタイプ：ブーリアン |
| sys_scopes | 結果を指定したアプリケーションスコープ (例:`、["x_my_app", "global"]`) にフィルタリングします。複数のスコープは OR ロジックを使用するため、一致するスコープが含まれます。空のアレイまたは NULL アレイが指定されている場合、フィルタリングは行われません。 データタイプ：文字列のアレイ |
[表 : 9. 要求本文パラメーター (JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#atf_code_covg-POST-byScriptId__entry__22}{#atf_code_covg-POST-byScriptId__accept-RESTAPI}

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

{#atf_code_covg-POST-byScriptId__entry__26}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 11. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#atf_code_covg-POST-byScriptId__entry__30}{#atf_code_covg-POST-byScriptId__entry-200-status-code}{#atf_code_covg-POST-byScriptId__entry-400-status-code}{#atf_code_covg-POST-byScriptId__entry-500-status-code}

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

### 応答本文のパラメーター (JSON) {#atf_code_covg-POST-byScriptId__section_j35_dqx_l3c}

{#atf_code_covg-POST-byScriptId__table_10z_n1c_i8e__entry__2}

| 名前 | 説明 |
|-|-|
| link | 要求レコードへのリンク。 データタイプ：文字列 |
| details.\<scriptId\> | 各カスタムテストスクリプトの ATF 集計範囲の割合をスクリプトsys_id別に一覧表示します。 データタイプ：数値 |
| api_request_sys_id | 要求のsys_id。 テーブル:ATF コードカバレッジ API 要求 \[sys_atf_code_coverage_request\] データタイプ：文字列 |
| result | 成功またはエラーメッセージ。 エラー応答フォーマット: * 400 要求が正しくありません`{ "result": "検証エラー: <specific_error_message>" }` * 500 内部サーバーエラー`{ "result": "内部サーバーエラー:<error_message>" }` {#atf_code_covg-POST-byScriptId__ul_apt_1ss_l3c} 考えられるエラー: * 要求本文の検証: `要求本文は必須であり、空にすることはできません` * 指定された script_array 要求エントリが null、空、または空白の場合、スクリプトアレイの検証結果が出ます - `「script_arrayは必須であり、空にすることはできません - script_arrayには少なくとも 1 つの有効なスクリプト識別子が含まれている必要があります」` * テスト ID 検証: `少なくとも 1 つの有効な (空でない) ID を test_result_ids または test_suite_result_ids で指定する必要があります` * タイプの不一致: `要求パラメーターのデータタイプが無効です` {#atf_code_covg-POST-byScriptId__ul_qzs_kts_l3c} データタイプ：文字列 |
| total | detailsプロパティにリストされているスクリプトの ATF コードカバレッジの合計を反映する、全体的なコードカバレッジの割合。提供されたテストにカスタムスクリプトが関連付けられていない場合、またはコードカバレッジの割合が指定されていない場合、値はゼロです。 可能な値:0〜100 データタイプ：数値 |
| truncation_message | 要求データが切り捨てられた場合 永続化中は、どのスクリプトが情報を切り捨てたかについての詳細を提供します。 メッセージの例: `truncation_message:「フィールド atf_code_coverage_request.metadata_info が 5,000 文字から 4,000 文字に短縮されました (最大:4,000 文字)。データ損失を防ぐために列長を長くすることを検討してください」` データタイプ：文字列 |
| was_truncated | 永続化中に要求データが切り捨てられたかどうかを示すフラグ。切り捨てを減らすために、 サポートされているデフォルトの文字数を変更できます。 たとえば、 `request_data_truncated: true` です。 有効な値： * true:永続化中に要求データが切り捨てられました。 * false:永続化中に要求データが切り捨てられませんでした。 {#atf_code_covg-POST-byScriptId__ul_ihd_rdy_l3c} データタイプ：ブーリアン デフォルトの文字数:4000 |
[ ]

{#atf_code_covg-POST-byScriptId__table_10z_n1c_i8e}

### 追加情報 {#atf_code_covg-POST-byScriptId__id_lvt_1qx_l3c}

要求データがデータベースフィールドの制限を超えている場合、大きな要求ペイロードは永続化時に切り捨てられることがあります。  
ATF コードカバレッジ API 要求 \[sys_atf_code_coverage_request\] テーブルの次のフィールドは切り捨ての対象となります。

* test_suite_results:テストスイート結果 ID の JSON アレイ。
* test_results:テスト結果 ID の JSON アレイ。
* metadata_info:フィルターされた行またはスクリプトアレイを含む JSON オブジェクト。
{#atf_code_covg-POST-byScriptId__ul_pcf_xsh_m3c}

was_truncated プロパティが true の場合、詳細は応答本文の truncation_message プロパティに入力されます。さらに、次のメッセージがログに記録されます。

`フィールド <table_name>.<field_name><original_length> 文字から <truncated_length> 文字に切り捨てられます (最大:<max_field_length>)。データ損失を防ぐために列長を長くすることを検討してください」`  
glide.db.truncate_utf8システムプロパティの切り捨て動作:

* glide.db.truncate_utf8 が true の場合、情報は UTF-8 バイト境界で切り捨てられます。マルチバイト文字の場合、この設定の方が安全です。
* glide.db.truncate_utf8 が false (デフォルト) の場合、情報は文字境界で切り捨てられます。デフォルトの境界は 4,000 文字です。
{#atf_code_covg-POST-byScriptId__ul_j11_tth_m3c}  

### cURL 要求

次の例は、特定のテストスクリプトによってフィルタリングされた、選択したテスト結果スイートのコードカバレッジを取得する方法を示しています。verboseが `false` または省略されている場合、detailsオブジェクトは空です。全体的な total 率のみが返されます。

    curl "https://instance.service-now.com/api/now/atf/code_coverage/by_script_id" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"test_suite_result_ids\": [\"5f81c7c4ff943210b88affffffffffc5\"],
      \"script_array\": [
        \"sys_script_include_db95cb370a0a0b2b00244880b5cacda7\",
        \"sys_script_include_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6\"
      ]
    }" \
    --user 'username':'password'

出力:

    {
      "result": "success",
      "total": 78,
      "details": {},
      "api_request_sys_id": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
      "link": "https://instance.service-now.com/sys_atf_code_coverage_request.do?sys_id=a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2"
    }

## ATF コードカバレッジ - POST /now/atf/code_coverage/by_line_number {#ariaid-title4}

メタデータレコードごとにフィルタリングされた行番号のセットを使用して、コードカバレッジを計算します。

### URL 形式

バージョニングされた URL: /api/now/v1/atf/code_coverage/by_line_number

デフォルト URL: /api/now/atf/code_coverage/by_line_number

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

{#atf_code_covg-POST-byLineNumber__entry__2}{#atf_code_covg-POST-byLineNumber__version-not_optional-RESTAPI}

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

{#atf_code_covg-POST-byLineNumber__entry__6}

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

{#atf_code_covg-POST-byLineNumber__table_fyr_lf4_k3c__entry__2}{#atf_code_covg-POST-byLineNumber__atfCC-reqParms-filtered_lines}{#atf_code_covg-POST-byLineNumber__atfCC-reqParms-filtered_linesID}{#atf_code_covg-POST-byLineNumber__atfCC-reqParms-filtered_linesScrpt}

| 名前 | 説明 |
|-|-|
| test_suite_result_ids | `test_result_ids`が指定されていない限り必須です。テストスイート結果sys_idsのリスト。 テーブル:テストスイート結果 \[sys_atf_test_suite_result\] データタイプ：文字列のアレイ |
| test_result_ids | `test_suite_result_ids`が指定されていない限り必須です。含めるテスト結果sys_idsのリスト (スイートと組み合わせ可能)。 テーブル:テスト結果 \[sys_atf_test_result\] データタイプ：文字列のアレイ |
| filtered_lines | 必須です。コードカバレッジを指定するメタデータsys_idsと対応するコード行のマップ (例: `{ "<metadata_sys_id>": { "script": [...] } }`)。 データタイプ: オブジェクト |
| filtered_lines.\<sys_id\> | 必須であり、空にすることはできません。コードカバレッジを評価する 1 つ以上のスクリプトsys_ids。有効な (空でない) スクリプト識別子を少なくとも 1 つ含める必要があります。null、空、または空白のみのエントリは除外されます。 テーブル:メタデータトレース \[sys_traced_metadata\] データタイプ: オブジェクト |
| filtered_lines.\<sys_id\>.script | 必須です。行番号と行番号の範囲の文字列のリスト。指定するすべての値は、1 以上の正の整数である必要があります。 有効な回線番号形式: * 個別行:\[1, 7, 10\] * 範囲:たとえば、\["1-7"\] は \[1, 2, 3, 4, 5, 6, 7\] に展開されます。 * 形式は start-end で、start の値は end 以下です。 * 最大範囲は 10000 行です。 {#atf_code_covg-POST-byLineNumber__ul_sg3_q2s_l3c} * 混合フォーマット。たとえば、\[1, "3-6", 7\] は \[1, 3, 4, 5, 6, 7\] に展開されます。 {#atf_code_covg-POST-byLineNumber__ul_n1v_5f4_k3c} 例： { "filtered_lines": { "sys_script_include_db95cb370a0a0b2b00244880b5cacda7": { "script": [1, "3-6", 7, "10-12"] } } } データタイプ：アレイ |
| 詳細 | 各カスタムテストスクリプトの応答で提供する詳細レベルを示すフラグ。 有効な値： * true:応答本文 details オブジェクトにアイテムごとの詳細なカバー範囲を含めます。 * false:オブジェクト details 応答本文は空を返すか、まったく返しません。 {#atf_code_covg-POST-byLineNumber__ul_qm3_ycy_l3c} デフォルト値：false データタイプ：ブーリアン |
| sys_scopes | 結果を指定したアプリケーションスコープ (例:`、["x_my_app", "global"]`) にフィルタリングします。複数のスコープは OR ロジックを使用するため、一致するスコープが含まれます。空のアレイまたは NULL アレイが指定されている場合、フィルタリングは行われません。 データタイプ：文字列のアレイ |
[表 : 15. 要求本文パラメーター (JSON)]

{#atf_code_covg-POST-byLineNumber__table_fyr_lf4_k3c}

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#atf_code_covg-POST-byLineNumber__entry__26}{#atf_code_covg-POST-byLineNumber__accept-RESTAPI}

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

{#atf_code_covg-POST-byLineNumber__entry__30}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 17. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#atf_code_covg-POST-byLineNumber__entry__34}{#atf_code_covg-POST-byLineNumber__entry-200-status-code}{#atf_code_covg-POST-byLineNumber__entry-400-status-code}{#atf_code_covg-POST-byLineNumber__entry-500-status-code}

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

### 応答本文のパラメーター (JSON) {#atf_code_covg-POST-byLineNumber__section_wkx_2qx_l3c}

{#atf_code_covg-POST-byLineNumber__table_10z_n1c_i8e__entry__2}

| 名前 | 説明 |
|-|-|
| link | 要求レコードへのリンク。 データタイプ：文字列 |
| details.\<scriptId\> | 各カスタムテストスクリプトの ATF 集計範囲の割合をスクリプトsys_id別に一覧表示します。 データタイプ：数値 |
| api_request_sys_id | 要求のsys_id。 テーブル:ATF コードカバレッジ API 要求 \[sys_atf_code_coverage_request\] データタイプ：文字列 |
| result | 成功またはエラーメッセージ。 エラー応答フォーマット: * 400 要求が正しくありません`{ "result": "検証エラー: <specific_error_message>" }` * 500 内部サーバーエラー`{ "result": "内部サーバーエラー:<error_message>" }` {#atf_code_covg-POST-byLineNumber__ul_apt_1ss_l3c} 考えられるエラー: * フィルター済み行の検証:「 `filtered_linesは必須であり、空にすることはできません」:「filtered_linesには、有効な行番号を持つメタデータエントリが少なくとも 1 つ含まれている必要があります」` * フィルタリングされた行構造のエラー: * `「filtered_linesの無効な回線番号形式:「 <details>` * `「filtered_linesのデータタイプが無効です。行番号が整数または有効な範囲文字列であることを確認してください (例:「1-7」)」` * `「filtered_lines構造内に Null 値が見つかりました。すべてのメタデータ ID、フィールド名、および行番号リストは null 以外である必要があります」` * `「予期しないエラー処理filtered_lines:<exception_type>:<メッセージ>」` {#atf_code_covg-POST-byLineNumber__ul_zkv_yqh_m3c} * 回線番号形式のエラー: * 汎用解析エラー:「 `無効な行番号形式:<item>」` - * 行番号\< 1 - `「行番号は正である必要があります:<line_number>」` * 回線範囲選択エラー。例:「a-b」 - `「無効な範囲形式:<range>。開始と終了の両方が有効な整数である必要があります」` * 回線範囲選択エラー。例:「10-5」 - `「無効な範囲:<範囲>。開始値 (<start>) は終了値 (<end>) 以下である必要があります"` * 回線範囲選択エラー (「-5-10」など) - `「無効な範囲:<範囲>。行番号は正の値でなければなりません (開始:<開始>)」` * 回線範囲選択エラー。例:「1-50000」 - `「範囲が大きすぎます:<範囲>。最大範囲サイズは 10000 行です (要求:<size>)」` {#atf_code_covg-POST-byLineNumber__ul_klw_1sh_m3c} * 要求本文の検証: `要求本文は必須であり、空にすることはできません` * テスト ID 検証: `少なくとも 1 つの有効な (空でない) ID を test_result_ids または test_suite_result_ids で指定する必要があります` * タイプの不一致: `要求パラメーターのデータタイプが無効です` {#atf_code_covg-POST-byLineNumber__ul_qzs_kts_l3c} データタイプ：文字列 |
| total | detailsプロパティにリストされているスクリプトの ATF コードカバレッジの合計を反映する、全体的なコードカバレッジの割合。提供されたテストにカスタムスクリプトが関連付けられていない場合、またはコードカバレッジの割合が指定されていない場合、値はゼロです。 可能な値:0〜100 データタイプ：数値 |
| truncation_message | 要求データが切り捨てられた場合 永続化中は、どのスクリプトが情報を切り捨てたかについての詳細を提供します。 メッセージの例: `truncation_message:「フィールド atf_code_coverage_request.metadata_info が 5,000 文字から 4,000 文字に短縮されました (最大:4,000 文字)。データ損失を防ぐために列長を長くすることを検討してください」` データタイプ：文字列 |
| was_truncated | 永続化中に要求データが切り捨てられたかどうかを示すフラグ。切り捨てを減らすために、 サポートされているデフォルトの文字数を変更できます。 たとえば、 `request_data_truncated: true` です。 有効な値： * true:永続化中に要求データが切り捨てられました。 * false:永続化中に要求データが切り捨てられませんでした。 {#atf_code_covg-POST-byLineNumber__ul_ihd_rdy_l3c} データタイプ：ブーリアン デフォルトの文字数:4000 |
[ ]

{#atf_code_covg-POST-byLineNumber__table_10z_n1c_i8e}

### 追加情報 {#atf_code_covg-POST-byLineNumber__id_lvt_1qx_l3c}

要求データがデータベースフィールドの制限を超えている場合、大きな要求ペイロードは永続化時に切り捨てられることがあります。  
ATF コードカバレッジ API 要求 \[sys_atf_code_coverage_request\] テーブルの次のフィールドは切り捨ての対象となります。

* test_suite_results:テストスイート結果 ID の JSON アレイ。
* test_results:テスト結果 ID の JSON アレイ。
* metadata_info:フィルターされた行またはスクリプトアレイを含む JSON オブジェクト。
{#atf_code_covg-POST-byLineNumber__ul_pcf_xsh_m3c}

was_truncated プロパティが true の場合、詳細は応答本文の truncation_message プロパティに入力されます。さらに、次のメッセージがログに記録されます。

`フィールド <table_name>.<field_name><original_length> 文字から <truncated_length> 文字に切り捨てられます (最大:<max_field_length>)。データ損失を防ぐために列長を長くすることを検討してください」`  
glide.db.truncate_utf8システムプロパティの切り捨て動作:

* glide.db.truncate_utf8 が true の場合、情報は UTF-8 バイト境界で切り捨てられます。マルチバイト文字の場合、この設定の方が安全です。
* glide.db.truncate_utf8 が false (デフォルト) の場合、情報は文字境界で切り捨てられます。デフォルトの境界は 4,000 文字です。
{#atf_code_covg-POST-byLineNumber__ul_j11_tth_m3c}  

### cURL 要求

次の例は、選択したテスト結果スイートとテスト結果のすべてのコードカバレッジを取得する方法を示しています。

    curl "https://instance.service-now.com/api/now/atf/code_coverage/by_line_number" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"test_suite_result_ids\": [\"5f81c7c4ff943210b88affffffffffc5\"],
      \"test_result_ids\": [\"bb8daec1ff103210b88affffffffff1c\"],
      \"filtered_lines\": {
        \"sys_script_include_db95cb370a0a0b2b00244880b5cacda7\": {
          \"script\": [1, \"3-6\", 7, \"10-12\"]
        }
      },
      \"verbose\": true,
      \"sys_scopes\": [\"x_my_app\", \"global\"]
    }" \
    --user 'username':'password'

出力:

    {
      "result": "success",z
      "total": 64,
      "details": {
        "sys_script_include_db95cb370a0a0b2b00244880b5cacda7": 80,
        "sys_ui_script_c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8": 50
      },
      "api_request_sys_id": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
      "link": "https://instance.service-now.com/sys_atf_code_coverage_request.do?sys_id=b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
      "was_truncated": false
    }