APIから設定を取得

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

このページを使用してスキャンの設定を読み取り、スキャンを作成または編集する際に送信できるすべての設定を調べ、許可されている値と編集を見つけることができます。

メソッド エンドポイント 目的
GET /scans/[scanId]/settings スキャンの完全な設定を取得。
GET /axe-versions axe Monitorインスタンスで利用可能なaxe-coreバージョンを一覧表示。
GET /presets プリセット一覧
GET /presets/[presetId]/editability プリセットを使用するスキャンで編集可能な設定を一覧表示。

スキャン設定の取得

1つのスキャンの完全な設定を返します。このレスポンスをPOST /scans or PATCH /scans/[scanId]にそのまま送信することができます。

リクエスト例

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-KEY: <your_api_key>

必須パラメータ

名前 型 説明
scanId 整数 スキャンの一意の識別子。

レスポンス例

ステータス: 200 OK

{
  "scanId": 12345,
  "presetId": null,
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],

  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "customRules": [],
  "enablePdfUa": false,
  "publicShareLink": false,
  "axeReportsUpload": false,
  
  "depth": 3,
  "pageLimit": 100,
  "windowWidth": 1920,
  "windowHeight": 1080,
  "storeScreenshotsFileContent": false,
  "includeErrorPages": false,
  "excludeMimeTypes": [],
  "pdfTarget": -1,
  "pdfModifiedBetween": null,

  "commonComponents": [],
  "templateUris": [],
  "excludeCommonComponents": false,

  "scripts": [],
  "runSessionScriptFirst": false,
  "environmentVariables": [
    { "name": "ENV_API_KEY" }
  ],
  "userAgent": null,
  "referrer": null,
  "sessionEstablishment": {
    "authType": null,
    "authUserName": null
  },

  "restrictToFolder": false,
  "skipSpecificUrls": [],
  "mustHaveAll": [],
  "mustHaveAny": [],
  "mustNotHaveAny": [],
  "ignoreAllParams": false,
  "discardAnchorTags": false,
  "meaningfulParams": [],
  "meaninglessParams": [],

  "longPageOptimized": false,
  "pageWait": 0,
  "dynamicContentActive": false,
  "priority": 2,

  "scanGroups": [
    { "id": 7, "name": "Marketing Sites" }
  ],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": false,
  "notifyUsers": []
}

注意: パスワード、キーストア、環境変数の値は返されません。これらはレスポンスに含まれず、nullとしても返されません。環境変数は名前のみで一覧されます。

注意: presetIdがスキャンに適用されたプリセットであり、存在しない場合はnullです。プリセットが適用された場合、GET /presets/[presetId]/editabilityを使用して編集可能な設定を確認します。

エラーレスポンス

HTTPステータスコード 説明
401 APIキーが欠落しているか無効です。
403 このスキャンにアクセスする権限がありません。
404 スキャンが存在しません。

APIで利用可能な完全なスキャン設定

このセクションでは、POST /scansおよびPATCH /scans/[scanId]に送信できるすべてのスキャン設定と、GET /scans/[scanId]/settingsが返す設定を一覧表示します。設定はaxe Monitorユーザーインターフェース内のスキャン設定と同じ方法でグループ化されており、APIはユーザーインターフェースと同じ値を受け付けます。

例外:セッションを開始するための資格情報は、セキュリティ上の理由からAPIによって変更できません。資格情報はAxe Monitorユーザーインターフェースからのみ変更できます。

一般設定（必須）

名前 型 説明
名前 文字列 スキャンの名前。
サイト 文字列[] スキャンの開始URL。スキャンにスクリプトが存在しない場合にのみ必要です。

アクセシビリティ基準（必須）

名前 型 説明
axeCoreVersion 文字列 スキャンに使用するaxe-coreのバージョン。GET /axe-versionsからのバージョン値を使用します。
standardLevel 文字列 テスト対象のアクセシビリティ基準、例えばwcag22aa。選択したaxe-coreバージョンのタグから値を使用します。

基本設定（オプション）

名前 型 デフォルト 説明
standardOptions 文字列[] [] 含める追加ルールセット。現在、サポートされているのはベストプラクティスのみです。
customRules 配列 [] 「テキストを検索」設定で使用するフレーズや単語を追加します。
enablePdfUa ブーリアン false PDF/UA に対して PDF をチェックします。
publicShareLink ブーリアン false スキャン結果の公開共有リンクを作成します。
axeReportsUpload ブーリアン false スキャン結果を Axe Reports に送信します。

スキャン範囲（オプション）

名前 型 デフォルト 説明
depth 整数 [] 開始 URL からクロールするリンクのレベル数。
pageLimit 整数 [] 各実行でスキャンされる最大ページ数。
windowWidth 整数 1920 ブラウザウィンドウの幅（ピクセル単位）。
windowHeight 整数 1080 ブラウザウィンドウの高さ（ピクセル単位）。
storeScreenshots ブーリアン false スキャン結果と共にスクリーンショットを保存します。
storeFileContent ブーリアン false スキャン結果と共にページの完全なソースを保存します。
includeErrorPages ブーリアン false HTTP エラーステータスを返すページを含めます。
excludeMimeTypes 文字列[] [] クロール中にスキップするファイルタイプ（例：application/pdf）。
pdfTarget 整数 -1 PDF スキャンのターゲット。-1 は PDF スキャンをオフにします。excludeMimeTypes に application/pdf がある場合は使用できません。
pdfModifiedFromDate オブジェクトまたは null null 特定の日付以降に変更された PDF のみをスキャンします。
pdfModifiedToDate オブジェクトまたは null null 特定の日付以前に変更された PDF のみをスキャンします。

共通コンポーネント（オプション）

名前 型 デフォルト 説明
commonComponents 配列 [] ページ全体で適用される共有コンポーネント定義。
templateUris 文字列[] [] 一般的なコンポーネントを検出し統合するために使用される URL。
excludeCommonComponents ブーリアン false 共通コンポーネントの結果を問題数から除外します。

クローリングとセッション（オプション）

名前 型 デフォルト 説明
スクリプト 配列 [] タスクとセッションスクリプト。各スクリプトには { "name", "id", "contents", "shared", "mimeType" } が含まれています。
runSessionScriptFirst ブーリアン false ページスクリプトの前にセッションスクリプトを実行します。
environmentVariables 配列 [] スクリプトで利用可能な変数。各エントリは{ "name" }です。値は変更できず、セキュリティ上の理由からレスポンスには含まれません。
userAgent 文字列またはnull null ブラウザのユーザーエージェント文字列を上書きします。
referrer 文字列またはnull null 送信するHTTPリファラー ヘッダーの値。
sessionEstablishment.authType 文字列またはnull null サインイン方法。例えば、basicまたはkeystore。
sessionEstablishment.authUserName 文字列またはnull null サインインに使用されるユーザー名。
sessionEstablishment.script オブジェクト [] スキャンに認証スクリプトが含まれている場合に返されます。各スクリプトには { "id", "name", "contents", "mimeType", "shared" } が含まれています。
sessionEstablishment.script.id 整数 0 スキャンに認証スクリプトが含まれている場合に返されます。CreateまたはEdit Scanエンドポイントを使用して共有スクリプトを追加するには、Axe MonitorのユーザーインターフェースでAdmin → Shared Scriptsに移動します。スクリプトを編集し、アドレスバーのURLからIDを取得します: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name 文字列 [] スキャンに適用される認証スクリプトファイルの名前。
sessionEstablishment.script.contents 文字列 [] スキャンに適用される認証スクリプトの内容。
sessionEstablishment.script.mimeType 文字列 [] スキャンに適用されるスクリプトのファイルタイプ。
sessionEstablishment.script.shared ブーリアン false Trueは、スクリプトがAxe Monitorの管理セクションで利用可能な共有スクリプトであることを示します。

URLスコープ（オプション）

名前 型 デフォルト 説明
restrictToFolder ブーリアン false 開始URLのパスの下にあるURLのみをクロールします。
ドメイン 文字列[] [] スキャンをこれらのドメインとそのサブディレクトリに制限します。他のドメインへのリンクは追跡されません。‘sites’の値から派生しています。デフォルトでは、‘sites’フィールドのドメインのみがスキャンされます。
skipSpecificUrls 文字列[] [] クロールから除外するURLパターン。
mustHaveAll 文字列[] [] これらの文字列をすべて含むURLのみをスキャンします。
mustHaveAny 文字列[] [] これらの文字列のうち、少なくとも1つを含むURLのみをスキャンします。
mustNotHaveAny 文字列[] [] これらの文字列のいずれかを含むURLをスキップします。
ignoreAllParams ブーリアン false クエリパラメーターだけが異なるURLを同じページとして扱います。Trueのときは、meaningfulParamsとmeaninglessParamsは空でなければなりません。
discardAnchorTags ブーリアン false ＃フラグメントだけが異なるURLを同じページとして扱います。
meaningfulParams 文字列[] [] URLを別のページとするクエリパラメータ。
無意味なパラメータ 文字列[] [] 2つのURLが同じページかどうかを判断するときに無視するクエリパラメータ。

最適化（オプション）

名前 型 デフォルト 説明
長いページの最適化 ブーリアン false 各ページをスキャンする前に待機します。待機時間はpageWaitで設定します。
pageWait 整数 0 各ページをスキャンする前に待機する時間（ミリ秒単位）。許可範囲：0から120000。
waitAllPages ブーリアン true スキャン中のすべてのページにpageWaitを適用します。falseの場合、waitPageUrlsのURLにのみ適用されます。
waitPageUrls 文字列[] [] waitAllPagesがfalseの場合にpageWaitが適用されるURL。
dynamicContentActive ブーリアン false アニメーション、遅延読み込みコンポーネント、埋め込みメディアなどの動的コンテンツが読み込まれるのを待ってから各ページをスキャンします。待機時間はdynamicContentWaitで設定します。
dynamicContentWait 整数 0 動的コンテンツが読み込まれるのを待機する時間。dynamicContentActiveがtrueのときに使用されます。
優先度 整数 2 スキャンのキュー内での位置。許可範囲：1（最高）から3（最低）。

スケジュール頻度（予定されたスキャンのために必要）

名前 型 説明
スケジュール オブジェクト 手動（一回限り）または予定されたスキャンのオプションを含み、スキャンが予定されているかどうかの詳細があります。各スケジュールには{ "frequencyType", “frequencyInterval”, "frequencyData", "startDate", "startTime", “endDate”, “maxOccurrences”, “timeoutMinutes”, “timeZone.” }が含まれます。nullを送信するとスケジュールが削除されます。
schedule.frequencyType 文字列 予定されたスキャンでは必須です。スキャンがどのくらい頻繁に繰り返されるか。手動はスケジュールなしのスキャンを作成します。Weekは毎週のスキャンを作成し、Monthは毎月のスキャンを作成します。M_DoWは特定の曜日に毎月実行することを可能にします。
schedule.frequencyInterval 整数 予定されたスキャンでは必須です。実行間隔にいくつの期間を待つか（Week または Month)）。たとえば、2は毎2週間または月を意味します。
schedule.frequencyData 文字列（JSONとして） スキャンが実行される日。値はJSONで文字列として書かれ、frequencyTypeに依存します。週： 曜日が含まれるJSON配列。例："[1,3]"は毎週月曜日と水曜日に実行されます。 月： 各月に実行される日が含まれるJSONオブジェクト。日付、文字列「First」、または文字列「Last」。FirstとLastは大文字と小文字を区別します。例："{\"dayOfMonth\":15}"は15日に実行されます。M_DoW： 曜日と月のどの週にあたるかが含まれるJSONオブジェクト。例："{\"weekOfMonth\":2,\"dayOfWeek\":2}"は第2火曜日に実行されます。 weekOfMonth: 5月の最終週に用いるので、"{\"weekOfMonth\":5,\"dayOfWeek\":5}"で毎月の最終金曜日に実行されます。曜日は1 = 月曜日から7 = 日曜日と番号付けされています。

スケジュール詳細（予定されたスキャンのために必要）

名前 型 説明
schedule.startDate 日付 必須。最初の実行日、YYYY-MM-DD の形式で。
schedule.startTime 現地時間 必須。現地時間。各実行開始時刻、24時間HH:mm:ssの形式で、午後2時30分は14:30:00 （24時間制と仮定）です。timeZone で解釈されます。
schedule.endDate 日付 スケジュールが終了する日付。このmaxOccurrencesまたはこれを設定しますが、両方は設定しません。
schedule.maxOccurrences 整数 スケジュールが終了するまでの実行回数。このendDateまたはこれを設定しますが、両方は設定しません。
schedule.timeoutMinutes 整数 スキャンが自動的に停止するまでの最大実行時間（分）。サイトがスキャンの終了を妨げる場合（たとえば、無限のリダイレクトURL）や、多くの大規模スキャンが同時に実行される場合に便利です。指定されない場合、タイムアウトはありません。
schedule.timeZone 文字列 IANAタイムゾーン名、例えばAmerica/New_York。（すべてのタイムゾーンオプション）

チームと共有（オプション）

名前 型 デフォルト 説明
スキャングループ オブジェクト[] [] スキャンが属するスキャングループ。各エントリーは { „id“, „name“ }。
scanGroups.id 文字列 [] スキャンが属するスキャングループのID。
scanGroups.name 文字列 [] スキャンが属するスキャングループの名前。
チーム オブジェクト[] [] スキャンにアクセスできるチーム。各エントリーは { „id“, „name“, „accessLevel“ }。
teams.id 文字列 [] スキャンにアクセスできるチームのID。
teams.name 文字列 [] スキャンにアクセスできるチームの名前。
teams.accessLevel 文字列 [] 「viewer」アクセスは、該当するチームにスキャンビューアアクセスを提供します。「member」アクセスはスキャンメンバーアクセスを提供し、「admin」はスキャン管理者アクセスを提供します。
scanGroups.id 文字列 [] スキャングループのID。 スキャングループを追加するには、Axe MonitorのユーザーインターフェースでAdmin → Scan Groupsに移動します。スクリプトを編集し、アドレスバーのURLからIDを取得します: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name 文字列 [] スキャングループの名前
scanGroups.accessLevel 文字列 [] 「viewer」、「member」、または「admin」
通知グループ ブーリアン false 実行が終了したときにスキャングループメンバーにメールを送信します。
通知ユーザー 配列 [] 実行が終了したときにメールを送信する特定のユーザー。

読み取り専用設定

GET /scans/[scanId]/settings はこれらも返します。これらをPOSTまたはPATCHに送信しても無視されます。

名前 型 説明
scanId 整数 スキャンの一意の識別子。
presetId 整数またはnull スキャンに適用されたプリセット、またはプリセットがない場合はnull。
scanGroups[].id 整数 各スキャングループの一意の識別子。

レスポンス例

{
  "scanId": 0,
  "name": "string",
  "sites": [
    "string"
  ],
  "axeCoreVersion": "string",
  "standardLevel": "string",
  "standardOptions": [
    "string"
  ],
  "enablePdfUa": true,
  "depth": 0,
  "pageLimit": 0,
  "axeReportsUpload": true,
  "publicShareLink": true,
  "includeErrorPages": true,
  "storeFileContent": true,
  "storeScreenshots": true,
  "pdfModifiedFromDate": "2026-11-03",
  "pdfModifiedToDate": "2026-11-03",
  "pdfTarget": 0,
  "scanGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "teams": [
    {
      "id": "string",
      "name": "string",
      "accessLevel": "viewer"
    }
  ],
  "schedule": {
    "frequencyType": "Manual",
    "frequencyInterval": 0,
    "frequencyData": "string",
    "startDate": "2026-11-03",
    "startTime": "string",
    "endDate": "2026-11-03",
    "maxOccurrences": 0,
    "timeoutMinutes": 0,
    "timeZone": "string"
  },
  "scripts": [
    {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  ],
  "runSessionScriptFirst": true,
  "userAgent": "string",
  "referrer": "string",
  "sessionEstablishment": {
    "authType": "basic",
    "authUserName": "string",
    "script": {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  },
  "restrictToFolder": true,
  "skipSpecificUrls": [
    "string"
  ],
  "mustHaveAll": [
    "string"
  ],
  "mustHaveAny": [
    "string"
  ],
  "mustNotHaveAny": [
    "string"
  ],
  "ignoreAllParams": true,
  "discardAnchorTags": true,
  "meaningfulParams": [
    "string"
  ],
  "meaninglessParams": [
    "string"
  ],
  "domains": [
    "string"
  ],
  "excludeMimeTypes": [
    "string"
  ],
  "longPageOptimized": true,
  "pageWait": 0,
  "dynamicContentActive": true,
  "dynamicContentWait": 0,
  "waitAllPages": true,
  "waitPageUrls": [
    "string"
  ],
  "headlessMode": true,
  "eagerStrategy": true,
  "windowWidth": 0,
  "windowHeight": 0,
  "priority": 1,
  "templateUris": [
    "string"
  ],
  "commonComponents": [
    {
      "id": 0,
      "name": "string",
      "selectors": [
        "string"
      ]
    }
  ],
  "excludeCommonComponents": true,
  "customRules": [
    {
      "ruleId": "find-text",
      "options": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "notifyGroup": true,
  "notifyUsers": [
    "string"
  ],
  "presetId": 0,
  "draft": true
}

axe-coreバージョン一覧

axe Monitorインスタンスで利用可能なaxe-coreバージョンと、それぞれがサポートする標準を返します。axe Monitorは新しいaxe-coreバージョンを自動検出しないため、このエンドポイントを使用して、スキャンのaxeCoreVersionとして設定できるバージョンを確認してください。

リクエスト例

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/axe-versions
X-API-Key: <your_api_key>

レスポンス例

ステータス: 200 OK

{
  "versions": [
    {
      "version": "latest",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    },
    {
      "version": "4.12.1",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    }
  ],
  "default": "latest"
}

レスポンスフィールド

名前 型 説明
バージョン 配列 インスタンスで利用可能なaxe-coreバージョン。
versions[].version 文字列 バージョン識別子。この値をスキャンのaxeCoreVersionとして使用します。
versions[].supported ブーリアン そのバージョンが現在サポートされているかどうか。
versions[].tags 文字列[] このバージョンがサポートする標準とルールセット。これらの値をスキャンのstandardLevelおよびstandardOptionsとして使用します。
デフォルト 文字列 インスタンスのデフォルトaxe-coreバージョン。

プリセット編集可能性の取得

プリセットを使用するスキャンで編集可能な設定を返します。プリセットが設定されたスキャンにPATCH /scans/[scanId]/settingsを送信する前にこれを確認し、受け入れられる設定を把握してください。

スキャンのプリセットを見つけるには、GET /scans/[scanId]/settingsからpresetIdを読み取ります。その他のプリセットIDを見つけるには、Axe Monitorユーザーインターフェースに移動し、Admin → Presetsをナビゲートします。希望するプリセットを編集します。アドレスバーのURLからIDをコピーします: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

リクエスト例

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/presets/[presetId]/editability

X-API-KEY: <your_api_key>

必須パラメータ

名前 型 説明
presetId 整数 プリセットの一意の識別子。

レスポンス例

ステータス: 200 OK

{
  "presetId": 42,
  "fields": {
    "name": true,
    "depth": false,
    "pageLimit": false,
    "axeCoreVersion": false
  }
}

レスポンスフィールド

名前 型 説明
presetId 整数 プリセットの一意の識別子。
フィールド オブジェクト それぞれのキーは詳細スキャン設定からの設定名です。trueの場合、このプリセットを使用するスキャンで編集可能であることを示し、falseの場合、プリセットが設定をロックしていることを示します。

ロックされた設定を新しい値で送信すると、400 field_locked_by_preset が返されます。現在の値で送信すると成功し、何も変更されません。

エラーレスポンス

名前 型
401 APIキーが欠落しているか無効です。
403 このプリセットにアクセスする権限がありません。
404 プリセットは存在しません。

Is this page helpful?

Help us improve this page

Still need help?