Einstellungen von der API abrufen
Verwenden Sie diese Seite, um die Einstellungen eines Scans zu lesen, jede Einstellung zu ermitteln, die Sie beim Erstellen oder Bearbeiten eines Scans senden können, und um herauszufinden, welche Werte und Bearbeitungen erlaubt sind.
| Methode | Endpunkt | Zweck |
|---|---|---|
| GET | /scans/[scanId]/settings |
Die vollständigen Einstellungen eines Scans abrufen. |
| GET | /axe-versions |
Listet die in Ihrer axe Monitor Instanz verfügbaren axe-core Versionen auf. |
| GET | /presets |
Presets auflisten |
| GET | /presets/[presetId]/editability |
Liste, welche Einstellungen in Scans, die ein Preset verwenden, bearbeitet werden können. |
Scan-Einstellungen abrufen
Gibt die vollständigen Einstellungen eines Scans zurück. Sie können diese Antwort unverändert an POST /scans or PATCH /scans/[scanId] zurücksenden.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-KEY: <your_api_key>Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
Beispielantwort
Status: 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": []
}Hinweis: Passwörter, Keystore und Umgebungsvariablenwerte werden niemals zurückgegeben. Sie werden vollständig aus der Antwort ausgeschlossen, nicht als null zurückgegeben. Umgebungsvariablen werden nur nach Namen aufgelistet.
Hinweis: presetId ist das Preset, das auf den Scan angewendet wird, oder null, wenn keines vorhanden ist. Wenn ein Preset angewendet wird, verwenden Sie GET /presets/[presetId]/editability, um zu sehen, welche Einstellungen Sie bearbeiten können.
Fehlerantworten
| HTTP-Statuscode | Beschreibung |
|---|---|
| 401 | Der API-Schlüssel fehlt oder ist ungültig. |
| 403 | Sie haben keinen Zugriff auf diesen Scan. |
| 404 | Der Scan existiert nicht. |
Vollständige Scan-Einstellungen über API verfügbar
Dieser Abschnitt listet jede Scan-Einstellung auf, die Sie an POST /scans und PATCH /scans/[scanId] senden können und die von GET /scans/[scanId]/settings zurückgegeben wird. Einstellungen sind auf die gleiche Weise gruppiert wie die Scaneinstellungen in der Benutzeroberfläche von Axe Monitor, und die API akzeptiert die gleichen Werte wie die Benutzeroberfläche.
Ausnahme: Anmeldeinformationen für den Start einer Sitzung sind aus Sicherheitsgründen nicht über die API änderbar. Anmeldeinformationen können nur über die Benutzeroberfläche von Axe Monitor geändert werden.
Allgemeine Einstellungen (Erforderlich)
| Name | Typ | Beschreibung |
|---|---|---|
| name | String | Der Name des Scans. |
| sites | String[] | Die Start-URLs für den Scan. Nur erforderlich, wenn keine Skripte im Scan vorhanden sind. |
Barrierefreiheitsstandard (Erforderlich)
| Name | Typ | Beschreibung |
|---|---|---|
| axeCoreVersion | String | Die axe-core Version, mit der gescannt werden soll. Verwenden Sie einen Versionswert aus GET /axe-versions. |
| standardLevel | String | Der Barrierefreiheitsstandard, gegen den getestet werden soll, zum Beispiel wcag22aa. Verwenden Sie einen Wert aus den Tags der gewählten axe-core Version. |
Grundeinstellungen (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| standardOptions | String[] | [] | Zusätzliche Regelsätze, die einbezogen werden sollen. Derzeit wird nur „best-practice“ unterstützt. |
| customRules | Array | [] | Fügen Sie Phrasen oder Wörter hinzu, die mit der Einstellung 'Text suchen' verwendet werden sollen. |
| enablePdfUa | Boolean | falsch | Prüfen Sie PDFs gemäß PDF/UA. |
| publicShareLink | Boolean | falsch | Erstellen Sie einen öffentlichen Freigabelink für die Scanergebnisse. |
| axeReportsUpload | Boolean | falsch | Senden Sie Scan-Ergebnisse an Axe Reports. |
Scan-Bereich (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| Tiefe | Integer | [] | Wie viele Link-Ebenen von den Start-URLs zu durchsuchen sind. |
| seitenlimit | Integer | [] | Die maximale Anzahl an Seiten, die bei jedem Durchlauf gescannt wird. |
| fensterBreite | Integer | 1920 | Browserfensterbreite in Pixeln. |
| fensterHöhe | Integer | 1080 | Browserfensterhöhe in Pixeln. |
| screenshotSpeichern | Boolean | falsch | Screenshots mit den Scan-Ergebnissen speichern. |
| DateiinhaltSpeichern | Boolean | falsch | Speichern Sie den vollständigen Seitenquellcode mit den Scan-Ergebnissen. |
| fehlerseitenEinbeziehen | Boolean | falsch | Seiten einbeziehen, die einen HTTP-Fehlerstatus zurückgeben. |
| mimeTypenAusschließen | String[] | [] | Dateitypen, die während des Crawlings übersprungen werden sollen, z. B. application/pdf. |
| pdfZiel | Integer | -1 | Das Ziel der PDF-Erfassung. -1 schaltet die PDF-Erfassung aus. Kann nicht verwendet werden, wenn application/pdf in mimeTypenAusschließen enthalten ist. |
| pdfÄnderungAbDatum | Objekt oder null | null | Nur PDFs scannen, die nach einem bestimmten Datum geändert wurden. |
| pdfÄnderungBisDatum | Objekt oder null | null | Nur PDFs scannen, die vor einem bestimmten Datum geändert wurden. |
Gemeinsame Komponenten (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| gemeinsameKomponenten | Array | [] | Geteilte Komponentendefinitionen, die über Seiten hinweg angewendet werden. |
| vorlagenUris | String[] | [] | URL zur Erkennung und Konsolidierung gemeinsamer Komponenten. |
| gemeinsameKomponentenAusschließen | Boolean | falsch | Ergebnisse gemeinsamer Komponenten aus der Anzahl der Probleme auslassen. |
Crawling und Sitzung (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| Skripte | Array | [] | Aufgaben- und Sitzungsskripte. Jedes Skript hat { „name“, “id”, „contents“, „shared“, „mimeType“ }. |
| runSessionScriptFirst | Boolean | falsch | Führen Sie das Sitzungsskript vor den Seitenskripten aus. |
| environmentVariables | Array | [] | Variablen, die Skripten zur Verfügung stehen. Jeder Eintrag ist { "name" }. Werte können nicht geändert werden und werden aus Sicherheitsgründen nicht in Antworten aufgenommen. |
| userAgent | String oder null | null | Die Browser-User-Agent-Zeichenfolge überschreiben. |
| referrer | String oder null | null | Der Wert des HTTP-Referer-Headers, der gesendet werden soll. |
| sessionEstablishment.authType | String oder null | null | Die Anmeldemethode, zum Beispiel Basic oder Keystore. |
| sessionEstablishment.authUserName | String oder null | null | Der Benutzername, der zur Anmeldung verwendet wird. |
| sessionEstablishment.script | Objekt | [] | Wird zurückgegeben, wenn der Scan ein Authentifizierungsskript hat. Jedes Skript hat { „id“, “name”, „contents“, „mimeType“, „shared“ }. |
| sessionEstablishment.script.id | Integer | 0 | Wird zurückgegeben, wenn der Scan ein Authentifizierungsskript hat. Um ein gemeinsames Skript beim Verwenden der Endpunkte Create oder Edit Scan hinzuzufügen, gehen Sie zu Admin → Shared Scripts in der Axe Monitor-Oberfläche. Bearbeiten Sie ein Skript und rufen Sie die ID aus der URL in der Adressleiste ab: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit |
| sessionEstablishment.script.name | String | [] | Name der Authentifizierungsskriptdatei, die auf den Scan angewendet wird. |
| sessionEstablishment.script.contents | String | [] | Inhalte des Authentifizierungsskripts, das auf den Scan angewendet wird. |
| sessionEstablishment.script.mimeType | String | [] | Dateityp des Skripts, das auf den Scan angewendet wird. |
| sessionEstablishment.script.shared | Boolean | falsch | True zeigt an, dass das Skript ein gemeinsam genutztes Skript ist, das im Admin-Bereich von Axe Monitor verfügbar ist. |
URL-Bereich (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| restrictToFolder | Boolean | falsch | Crawlen Sie nur URLs unter dem Pfad der Start-URL. |
| domains | String[] | [] | Begrenzen Sie den Scan auf diese Domains und deren Unterverzeichnisse. Links zu anderen Domains werden nicht verfolgt. Abgeleitet vom 'sites'-Wert. Standardmäßig werden nur Domains im 'sites'-Feld gescannt. |
| skipSpecificUrls | String[] | [] | URL-Muster, die aus dem Crawlen ausgeschlossen werden sollen. |
| mustHaveAll | String[] | [] | Scannen Sie nur URLs, die alle diese Textstrings enthalten. |
| mustHaveAny | String[] | [] | Scannen Sie nur URLs, die mindestens einen dieser Textstrings enthalten. |
| mustNotHaveAny | String[] | [] | Überspringen Sie URLs, die einen dieser Textstrings enthalten. |
| ignoreAllParams | Boolean | falsch | Behandeln Sie URLs, die sich nur in Abfrageparametern unterscheiden, als dieselbe Seite. Wenn true, müssen meaningfulParams und meaninglessParams leer sein. |
| discardAnchorTags | Boolean | falsch | Behandeln Sie URLs, die sich nur in ihrem # Fragment unterscheiden, als dieselbe Seite. |
| meaningfulParams | String[] | [] | Abfrageparameter, die eine URL zu einer separaten Seite machen. |
| meaninglessParams | String[] | [] | Abfrageparameter, die ignoriert werden sollen, wenn entschieden wird, ob zwei URLs dieselbe Seite sind. |
Optimierung (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| longPageOptimized | Boolean | falsch | Warten Sie, bevor Sie jede Seite scannen. Legen Sie die Wartezeit mit pageWait fest. |
| pageWait | Integer | 0 | Wie lange vor dem Scannen jeder Seite gewartet werden soll, in Millisekunden. Erlaubter Bereich: 0 bis 120000. |
| waitAllPages | Boolean | true | Wendet pageWait auf jede Seite im Scan an. Wenn false, wird es nur auf die URLs in waitPageUrls angewendet. |
| waitPageUrls | String[] | [] | Die URLs, auf die pageWait angewendet wird, wenn waitAllPages false ist. |
| dynamicContentActive | Boolean | falsch | Warten Sie, bis dynamische Inhalte wie Animationen, verzögerte Komponenten und eingebettete Medien geladen sind, bevor Sie jede Seite scannen. Legen Sie die Wartezeit mit dynamicContentWait fest. |
| dynamicContentWait | Integer | 0 | Wie lange auf dynamische Inhalte gewartet werden soll, bevor jede Seite gescannt wird. Wird verwendet, wenn dynamicContentActive true ist. |
| priority | Integer | 2 | Die Position des Scans in der Warteschlange. Erlaubter Bereich: 1 (höchste) bis 3 (niedrigste). |
Planungshäufigkeit (Erforderlich für geplante Scans)
| Name | Typ | Beschreibung |
|---|---|---|
| schedule | Objekt | Enthält die Option für manuelle (einmalige) oder geplante Scans und Details, wenn der Scan geplant ist. Jedes Schema enthält { „frequencyType“, „frequencyInterval“, „frequencyData“, „startDate“, „startTime“, „endDate“, „maxOccurrences“, „timeoutMinutes“, „timeZone.“ }. Durch Senden von null wird der Zeitplan entfernt. |
| schedule.frequencyType | String | Erforderlich bei geplanten Scans. Wie oft der Scan wiederholt wird. Manual erstellt einen Scan ohne Zeitplan. Week erstellt wöchentliche Scans, und Month erstellt monatliche Scans. M_DoW ermöglicht es, monatliche Scans an einem bestimmten Wochentag auszuführen. |
| schedule.frequencyInterval | Integer | Erforderlich bei geplanten Scans. Wie viele Perioden zwischen den Ausführungen gewartet werden (Week oder Month). Zum Beispiel bedeutet 2 alle 2 Wochen oder Monate. |
| schedule.frequencyData | Zeichenkette (als JSON) | Welche Tage der Scan läuft. Der Wert ist JSON, geschrieben als Zeichenkette, und was darin steht, hängt von frequencyType ab. Woche: JSON-Array mit den Wochentagen, an denen es ausgeführt werden soll. Beispiel: "[1,3]" läuft jeden Montag und Mittwoch. Monat: JSON-Objekt mit dem Datum zu jedem Monat. Eine Zahl des Tages, die Zeichenkette „First“ oder die Zeichenkette „Last“. First und Last sind großschreibungssensitiv. Beispiel: "{\"dayOfMonth\":15}" läuft am 15. M_DoW: JSON-Objekt mit einem Wochentag und welcher im Monat. Beispiel: "{\"weekOfMonth\":2,\"dayOfWeek\":2}" läuft am zweiten Dienstag. Verwenden Sie weekOfMonth: 5 für die letzte Woche des Monats, sodass "{\"weekOfMonth\":5,\"dayOfWeek\":5}" der letzte Freitag jedes Monats ist. Tage sind nummeriert 1 = Montag bis 7 = Sonntag. |
Planungsdetails (Erforderlich für geplante Scans)
| Name | Typ | Beschreibung |
|---|---|---|
| schedule.startDate | Datum | Erforderlich. Datum des ersten Laufs, wie YYYY-MM-DD. |
| schedule.startTime | Zeit - Lokal | Erforderlich. Ortszeit. jeder Lauf beginnt, als 24-Stunden HH:mm:ss, also ist 14:30 Uhr 14:30:00 (24-Stunden-Format angenommen). Interpretiert in timeZone. |
| schedule.endDate | Datum | Datum, an dem der Zeitplan endet. Entweder dies oder maxOccurrences festlegen, nicht beide. |
| schedule.maxOccurrences | Integer | Anzahl der Läufe, nach denen der Zeitplan endet. Entweder dies oder endDate festlegen, nicht beide. |
| schedule.timeoutMinutes | Integer | Maximale Laufdauer in Minuten, nach der der Scan automatisch gestoppt wird. Nützlich, wenn eine Website einen Scan daran hindert, abzuschließen (wie eine endlos weiterleitende URL) oder wenn viele große Scans gleichzeitig laufen. Wenn nicht vorhanden, gibt es kein Timeout. |
| schedule.timeZone | String | IANA-Zeitzonenname, wie America/New_York. (Alle Zeitzonenoptionen) |
Teams und Freigabe (Optional)
| Name | Typ | Standard | Beschreibung |
|---|---|---|---|
| scanGroups | Objekt[] | [] | Scan-Gruppen, zu denen der Scan gehört. Jeder Eintrag ist { „id“, "name" }. |
| scanGroups.id | String | [] | IDs der Scan-Gruppen, zu denen der Scan gehört. |
| scanGroups.name | String | [] | Namen der Scan-Gruppen, zu denen der Scan gehört. |
| Teams | Objekt[] | [] | Teams mit Zugriff auf den Scan. Jeder Eintrag ist { „id“, "name", „accessLevel“ }. |
| teams.id | String | [] | IDs der Teams mit Zugriff auf den Scan. |
| teams.name | String | [] | Namen der Teams mit Zugriff auf den Scan. |
| teams.accessLevel | String | [] | „viewer“-Zugriff bietet Scan-Viewer-Zugriff für das entsprechende Team. „member“-Zugriff bietet Scan-Member-Zugriff, und „admin“-Zugriff bietet Scan-Admin-Zugriff. |
| scanGroups.id | String | [] | ID der Scan-Gruppen.Um Scan-Gruppen beim Verwenden der Create- oder Edit-Scan-Endpunkte hinzuzufügen, gehen Sie zu Admin → Scan-Gruppen in der Axe Monitor-Benutzeroberfläche. Bearbeiten Sie ein Skript und holen Sie sich die ID aus der URL in der Adressleiste: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit |
| scanGroups.name | String | [] | Name der Scan-Gruppen |
| scanGroups.accessLevel | String | [] | „viewer“, „member“ oder „admin“ |
| notifyGroup | Boolean | falsch | Mitglieder der Scan-Gruppe per E-Mail benachrichtigen, wenn ein Lauf endet. |
| notifyUsers | Array | [] | Spezifische Benutzer per E-Mail benachrichtigen, wenn ein Lauf endet. |
Schreibgeschützte Einstellungen
GET /scans/[scanId]/settings gibt diese ebenfalls zurück. Sie werden ignoriert, wenn Sie sie an POST oder PATCH senden.
| Name | Typ | Beschreibung |
|---|---|---|
| scanId | Integer | Die eindeutige Kennung des Scans. |
| presetId | Ganzzahl oder null | Das auf den Scan angewendete Preset oder null, falls keines vorhanden ist. |
| scanGroups[].id | Integer | Die eindeutige Kennung jeder Scan-Gruppe. |
Beispielantwort
{
"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-Versionen auflisten
Gibt die in Ihrer axe Monitor-Instanz verfügbaren axe-core-Versionen und die unterstützten Standards jeder Version zurück. Axe Monitor erkennt neue axe-core-Versionen nicht automatisch, also verwenden Sie diesen Endpunkt, um zu sehen, welche Versionen Sie als axeCoreVersion eines Scans festlegen können.
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/axe-versions
X-API-Key: <your_api_key>Beispielantwort
Status: 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"
}Antwortfelder
| Name | Typ | Beschreibung |
|---|---|---|
| Versionen | Array | Die in Ihrer Instanz verfügbaren axe-core-Versionen. |
| versions[].version | String | Der Versionskennzeichner. Verwenden Sie diesen Wert als axeCoreVersion eines Scans. |
| versions[].supported | Boolean | Ob die Version aktuell unterstützt wird. |
| versions[].tags | String[] | Die Standards und Regelsets, die diese Version unterstützt. Verwenden Sie diese Werte für die standardLevel und standardOptions eines Scans. |
| Standard | String | Die Standard-axe-core-Version für Ihre Instanz. |
Vorlagenbearbeitbarkeit abrufen
Gibt zurück, welche Einstellungen bei Scans, die eine Vorlage verwenden, bearbeitet werden können. Prüfen Sie dies, bevor Sie PATCH /scans/[scanId]/settings an einen Scan mit einer Vorlage senden, damit Sie wissen, welche Einstellungen akzeptiert werden.
Um die Vorlage eines Scans zu finden, lesen Sie presetId aus GET /scans/[scanId]/settings ab. Um andere Vorlagen-IDs zu finden, gehen Sie zur Axe Monitor-Benutzeroberfläche und navigieren Sie zu Admin → Vorlagen. Bearbeiten Sie die gewünschte Vorlage. Kopieren Sie die ID aus der URL in der Adressleiste: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit
Beispielanfrage
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/presets/[presetId]/editability
X-API-KEY: <your_api_key>Erforderliche Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| presetId | Integer | Die eindeutige Kennung der Vorlage. |
Beispielantwort
Status: 200 OK
{
"presetId": 42,
"fields": {
"name": true,
"depth": false,
"pageLimit": false,
"axeCoreVersion": false
}
}
Antwortfelder
| Name | Typ | Beschreibung |
|---|---|---|
| presetId | Integer | Die eindeutige Kennung der Vorlage. |
| Felder | Objekt | Jeder Schlüssel ist ein Einstellungsname aus Erweiterte Scaneinstellungen. true bedeutet, dass Sie ihn bei Scans, die dieses Preset verwenden, bearbeiten können; false bedeutet, dass das Preset ihn sperrt. |
Das Senden einer gesperrten Einstellung mit einem neuen Wert gibt 400 field_locked_by_preset zurück. Das Senden mit seinem aktuellen Wert ist erfolgreich und ändert nichts.
Fehlerantwort
| Name | Typ |
|---|---|
| 401 | Der API-Schlüssel fehlt oder ist ungültig. |
| 403 | Sie haben keinen Zugriff auf dieses Preset. |
| 404 | Das Preset existiert nicht. |
