ホーム
REST API
REST API を使用した製品の拡張方法について説明します。
REST API
AppScan Enterprise の REST API について説明します。
スキャン管理 REST API (レガシー)
サービス
以下の各 REST Web サービスでは、各種タスク (特にレポート・データへのアクセスの提供) が実行されます。
スキャンの実行
REST サービスを使用してスキャン関連の情報を取得する方法について説明します。
統計の検索
この REST サービスは、スキャンの統計を検索します。

REST API
REST API を使用した製品の拡張方法について説明します。
- REST API
  AppScan Enterprise の REST API について説明します。
  - スキャン管理 REST API (レガシー)
    - Web サービス API
      各種タスク (特にレポート・データへのアクセスの提供) を実行するために、REST Web サービスを介してアプリケーション・プログラミング・インターフェース (API) を使用します。
    - サンプル 1: Web サービスを使用したスキャンの作成および実行
      このサンプルでは、スキャンの作成と実行について説明します。
    - サンプル 2: ビルド自動化による DAST スキャン
    - サービス
      以下の各 REST Web サービスでは、各種タスク (特にレポート・データへのアクセスの提供) が実行されます。
      - Web サービス・スキーマの要求
        この REST サービスは、Web サービス・スキーマを戻します。スキーマには、すべての Web サービスから戻された要素および属性を説明する、完全な注釈が付けられます。XML 明細については、この文書を参照してください。
      - バージョン情報の要求
        この REST サービスは、サーバーに関するバージョン情報を返します。
      - フォルダーの取得
        この REST サービスを使用して <folder> 要素を取得する方法について説明します。
      - スキャンの実行
        REST サービスを使用してスキャン関連の情報を取得する方法について説明します。
        テンプレート・リストの取得
        この REST サービスは、テンプレート・ディレクトリーまたはそのいずれかのサブフォルダー内でユーザーがアクセスできる、使用可能なジョブ・テンプレートのリストを取得します。
        Scanlogs の検索
        この REST サービスは、スキャン用に Log ディレクトリーから scanlogs を検索します。
        統計の検索
        この REST サービスは、スキャンの統計を検索します。
        テンプレートを基にしたスキャン・ジョブの作成
        この REST サービスは、特定のテンプレートを基にして、スキャン・ジョブ、および関連するレポート・パックを作成します。POST データを使用して、名前フィールドと説明フィールドがサーバーに提供されます。
        ジョブ・オプションの構成
        この REST サービスは、開始 URL の追加などのコンテンツ・スキャン・ジョブ・オプションを構成します。
        フォルダー項目アクションの更新
        この REST サービスによって、フォルダー項目 (ジョブ、レポート・パック、ダッシュボード) のアクション (スキャンの開始、中断、キャンセル、終了、再開) が更新されます。
        マニュアル探査データのアップロード
        この REST サービスは、*.htd / *.har / *.dast.config ファイルに保管されているマニュアル探査データを AppScan® Enterprise にアップロードします。トラフィック・ファイルのサイズは 20 MB を超えないようにしてください。この制限を超える場合、記録されているスモール化の手順を使用して、ファイルをより小さなサイズのチャンクに分割してください。*.har または *.dast.config のファイル・フォーマットでファイルを使用するには、追加のパラメーター・フォーマットをリクエストに含めます。以下に例を示します。
        アプリケーションをスキャンするための基本認証オプションおよび NTLM 認証オプションの設定
        この REST サービスは、基本認証または NTLM 認証を使用する Web サイトにログインするためのユーザー資格情報を設定します。パスワードは、データベースに保存される前にエンコードされますが、平文で受信されます。ユーザー名およびパスワードが Enterprise Console インターフェースに平文で表示されないようにするために、この REST サービスを HTTPS 経由で呼び出して、マニュアル探査時にテスト・ユーザー・アカウントを使用します。
        記録されたログイン・データのアップロード
        この REST サービスは、*.htd / *.har / *.dast.config ファイルに保管されている、記録されたログイン手順としてのマニュアル探査データをコンテンツ・スキャン・ジョブにアップロードし、コンテンツ・スキャン・ジョブの「ログイン方法」を「記録されたログイン」に設定します。
      - レポート結果の取得
        この REST サービスを使用してレポート結果の取得する方法について説明します。
  - AppScan Enterprise REST API
  - 障害追跡システムの統合 REST API
    障害追跡システムへの障害の送信に使用される RESTful Web サービスを視覚化するための組み込み障害追跡システムの統合 REST API インターフェースを使用する方法について説明します。
  - API 変更履歴
    REST API の製品のバージョン間での変更記録を追跡します。

統計の検索

この REST サービスは、スキャンの統計を検索します。

HTTPS 方式

GET

サービス形式

/services/folderitems/<folderItemID>/statistics

照会ストリング・パラメーター

「なし」

戻り値

統計には、ジョブ/スキャンのステータス、実行開始時刻、実行終了時刻、経過時間、合計スキャン時間、検出されたページ、リンク切れ、スキャンされたページ、ページ・スキャン数 (分)、スキャン・フェーズ、検出されたセキュリティー・エンティティー、テスト済みのセキュリティー・エンティティー、セキュリティー・エンティティーの分析数 (分)、セキュリティー問題のバリアント、および送信された要求数が含まれます。

例:

<?xml version="1.0" encoding="utf-8"?>

<statistics xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" status="Suspended (Unknown error: SDK Server Down Error)" 
run-start="2018-08-08T12:27:51.203" run-end="2018-08-08T12:27:51.203" elapsed-time="0:00:00" net-scan-time="0:20:28" pages-found="72" broken-links="27" pages-scanned="72" page-scan-rate="3.52" scanning-phase="-" security-entities-found="326" security-entities-tested="326" security-entity-analysis-rate="15.93" security-issue-variants="67" requests-sent="3209" xmlns="http://www.ibm.com/Rational/AppScanEnterprise" />

詳しくは、文書化されたスキーマを参照してください。