DQE One API — Jobs & Audits

Jobs & Audits — DQE One API

Die DQE One API ist die Backend-API, die vom DQE One-Paket für Salesforce bereitgestellt wird. Die Endpunkte unter „Jobs & Audits“ auf dieser Seite erstellen und starten die Datenqualitäts-Jobs (Dublettenbereinigung, B2B-Kontoabgleich, RNVP-Adressvalidierung), die das DQE One-Paket auf Salesforce-Datensätzen ausführt, und zeigen eine Vorschau der Auswirkung einer Suchen/Ersetzen-Datenaufbereitungstransformation, bevor diese übernommen wird. Alle Endpunkte auf dieser Seite akzeptieren ausschließlich POST-Anfragen und verwenden zur Authentifizierung den DQE-Authorization-Header.

Zugehörige Dokumentation der DQE One API:

Hinweis zu Pflicht/Optional weiter unten — Die zugrunde liegende OpenAPI-Spezifikation kennzeichnet den Request-Body jedes Endpunkts insgesamt als erforderlich, markiert jedoch keine einzelnen Body-Eigenschaften als Pflicht oder optional (für keines der Body-Schemas existiert eine required-Liste). Die Kennzeichnungen Pflicht/Optional in diesem Artikel beruhen auf unserer bestmöglichen fachlichen Einschätzung anhand der Rolle jedes Feldes (Sitzungs-/Identitätsangaben vs. optionale Schalter) und sollten vor der Veröffentlichung mit JP bestätigt werden.

Direkt zu Neuen Job erstellen Audit starten Datenaufbereitung in der Vorschau

Jobs & Audits — DQE One API

Erstellt einen neuen DQE-Datenqualitäts-Job — Dublettenbereinigung, B2B-Kontoabgleich oder RNVP-Adressvalidierung — für eine Salesforce-Organisation, anhand der unten beschriebenen Job-Konfigurationsdaten.

newJob

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie den Request-Body als JSON mit Content-Type: application/json.

Authentifizierung — Für diesen Endpunkt ist der DQE-Authorization-Header (ein API-Schlüssel) erforderlich. Siehe Authentifizierung & Sitzung, um zu erfahren, wie Sie diesen Wert erhalten und konfigurieren.

{DOMAIN} ist die Domain des Servers, auf dem die eigene Instanz des DQE One-Backends Ihrer Organisation installiert ist — da dieses Backend in Ihrer eigenen Infrastruktur betrieben wird, wird dieser Wert von Ihrem Deployment festgelegt und nicht von DQE vergeben.

Hinweis zum Request-Body dieses Endpunkts — In der zugrunde liegenden OpenAPI-Spezifikation wird der Request-Body von /newJob über eine $ref-Referenz definiert, die auf das eigene Request-Body-Schema des Pfads /lanchAudit verweist, statt auf eine gemeinsam genutzte Komponente. JP hat bestätigt, dass /launchAudit (korrekte Schreibweise, weiter unten separat dokumentiert) der reale, aktuelle Endpunkt ist und dass /lanchAudit (der fehlerhaft geschriebene Pfad in der Spezifikation) kein realer/aktueller Endpunkt ist und hier nicht eigenständig dokumentiert wird. Das referenzierte Body-Schema ist jedoch der echte, aktuelle Request-Body von /newJob selbst — es wird daher vollständig aufgelöst und unten dokumentiert.

POSThttps://{DOMAIN}/newJob

Codebeispiele

Einen neuen Job erstellen

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/newJob" \
  -H "Content-Type: application/json" \
  -H "DQE-Authorization: {API_KEY}" \
  -d '{"aud": "DQEOne", "crt": "1730000000", "sub": "0055f000000XyZAAU", "orgId": "00D5f000000ABCDEAU", "orgPrefix": "dqe__", "urllogin": "https://mycompany.my.salesforce.com", "url": "https://mycompany.my.salesforce.com/services/data/v58.0", "Region": "EU", "chatterId": "0D55f00000ChatterXYZ", "isFreeTrial": false, "isPersonAccountEnable": false, "jobId": "a0C5f000000JobXYZ", "Name": "Account Dedup Job", "Id": "", "processId": "", "runId": "", "Rule_Set_Id__c": "a0B5f000000RuleXYZ", "Record_Type__c": "Account", "Process_kind__c": "Dedup", "Source__c": "OneAPI", "Last_Run_Id__c": "", "date": "2026-10-29", "isKilling": false, "attributes": {}, "auditJson": {}, "Automatic_Dedup_Merge__c": true, "Automatic_B2B_Merge__c": true, "Automatic_RNVP_Merge__c": false, "SF_Default_Merge__c": false, "Auto_Merge_Threshold__c": 85, "Merge_B2B_Status_Code__c": 0, "Merge_RNVP_Status_Code__c": "", "Assign_To_Owner__c": false, "Authorized_Empty_Bulk__c": false, "delete_record__c": false, "Enable_UnMerge_Dedup__c": false, "Enable_Reparenting_Inactive_Child__c": false, "Max_Record_Per_Batchable__c": 200, "filterJson": "", "Filters_ListView_Json__c": [], "Selected_List_View__c": "", "Run_On_View__c": false, "Use_Sort_LV__c": false, "Selected_Fields__c": {}}'

const body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "sub": "0055f000000XyZAAU",
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "urllogin": "https://mycompany.my.salesforce.com",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "Region": "EU",
  "chatterId": "0D55f00000ChatterXYZ",
  "isFreeTrial": false,
  "isPersonAccountEnable": false,
  "jobId": "a0C5f000000JobXYZ",
  "Name": "Account Dedup Job",
  "Id": "",
  "processId": "",
  "runId": "",
  "Rule_Set_Id__c": "a0B5f000000RuleXYZ",
  "Record_Type__c": "Account",
  "Process_kind__c": "Dedup",
  "Source__c": "OneAPI",
  "Last_Run_Id__c": "",
  "date": "2026-10-29",
  "isKilling": false,
  "attributes": {},
  "auditJson": {},
  "Automatic_Dedup_Merge__c": true,
  "Automatic_B2B_Merge__c": true,
  "Automatic_RNVP_Merge__c": false,
  "SF_Default_Merge__c": false,
  "Auto_Merge_Threshold__c": 85,
  "Merge_B2B_Status_Code__c": 0,
  "Merge_RNVP_Status_Code__c": "",
  "Assign_To_Owner__c": false,
  "Authorized_Empty_Bulk__c": false,
  "delete_record__c": false,
  "Enable_UnMerge_Dedup__c": false,
  "Enable_Reparenting_Inactive_Child__c": false,
  "Max_Record_Per_Batchable__c": 200,
  "filterJson": "",
  "Filters_ListView_Json__c": [],
  "Selected_List_View__c": "",
  "Run_On_View__c": false,
  "Use_Sort_LV__c": false,
  "Selected_Fields__c": {}
};

fetch("https://{DOMAIN}/newJob", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "DQE-Authorization": "{API_KEY}"
  },
  body: JSON.stringify(body)
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "sub": "0055f000000XyZAAU",
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "urllogin": "https://mycompany.my.salesforce.com",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "Region": "EU",
  "chatterId": "0D55f00000ChatterXYZ",
  "isFreeTrial": False,
  "isPersonAccountEnable": False,
  "jobId": "a0C5f000000JobXYZ",
  "Name": "Account Dedup Job",
  "Id": "",
  "processId": "",
  "runId": "",
  "Rule_Set_Id__c": "a0B5f000000RuleXYZ",
  "Record_Type__c": "Account",
  "Process_kind__c": "Dedup",
  "Source__c": "OneAPI",
  "Last_Run_Id__c": "",
  "date": "2026-10-29",
  "isKilling": False,
  "attributes": {},
  "auditJson": {},
  "Automatic_Dedup_Merge__c": True,
  "Automatic_B2B_Merge__c": True,
  "Automatic_RNVP_Merge__c": False,
  "SF_Default_Merge__c": False,
  "Auto_Merge_Threshold__c": 85,
  "Merge_B2B_Status_Code__c": 0,
  "Merge_RNVP_Status_Code__c": "",
  "Assign_To_Owner__c": False,
  "Authorized_Empty_Bulk__c": False,
  "delete_record__c": False,
  "Enable_UnMerge_Dedup__c": False,
  "Enable_Reparenting_Inactive_Child__c": False,
  "Max_Record_Per_Batchable__c": 200,
  "filterJson": "",
  "Filters_ListView_Json__c": [],
  "Selected_List_View__c": "",
  "Run_On_View__c": False,
  "Use_Sort_LV__c": False,
  "Selected_Fields__c": {}
}

response = requests.post(
    "https://{DOMAIN}/newJob",
    headers={"DQE-Authorization": "{API_KEY}"},
    json=body,
)
print(response.json())

<?php
$body = json_encode([
    'aud' => 'DQEOne',
    'crt' => '1730000000',
    'sub' => '0055f000000XyZAAU',
    'orgId' => '00D5f000000ABCDEAU',
    'orgPrefix' => 'dqe__',
    'urllogin' => 'https://mycompany.my.salesforce.com',
    'url' => 'https://mycompany.my.salesforce.com/services/data/v58.0',
    'Region' => 'EU',
    'chatterId' => '0D55f00000ChatterXYZ',
    'isFreeTrial' => false,
    'isPersonAccountEnable' => false,
    'jobId' => 'a0C5f000000JobXYZ',
    'Name' => 'Account Dedup Job',
    'Id' => '',
    'processId' => '',
    'runId' => '',
    'Rule_Set_Id__c' => 'a0B5f000000RuleXYZ',
    'Record_Type__c' => 'Account',
    'Process_kind__c' => 'Dedup',
    'Source__c' => 'OneAPI',
    'Last_Run_Id__c' => '',
    'date' => '2026-10-29',
    'isKilling' => false,
    'attributes' => [],
    'auditJson' => [],
    'Automatic_Dedup_Merge__c' => true,
    'Automatic_B2B_Merge__c' => true,
    'Automatic_RNVP_Merge__c' => false,
    'SF_Default_Merge__c' => false,
    'Auto_Merge_Threshold__c' => 85,
    'Merge_B2B_Status_Code__c' => 0,
    'Merge_RNVP_Status_Code__c' => '',
    'Assign_To_Owner__c' => false,
    'Authorized_Empty_Bulk__c' => false,
    'delete_record__c' => false,
    'Enable_UnMerge_Dedup__c' => false,
    'Enable_Reparenting_Inactive_Child__c' => false,
    'Max_Record_Per_Batchable__c' => 200,
    'filterJson' => '',
    'Filters_ListView_Json__c' => [],
    'Selected_List_View__c' => '',
    'Run_On_View__c' => false,
    'Use_Sort_LV__c' => false,
    'Selected_Fields__c' => []
]);

$ch = curl_init("https://{DOMAIN}/newJob");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'DQE-Authorization: {API_KEY}',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

const axios = require('axios');

const body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "sub": "0055f000000XyZAAU",
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "urllogin": "https://mycompany.my.salesforce.com",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "Region": "EU",
  "chatterId": "0D55f00000ChatterXYZ",
  "isFreeTrial": false,
  "isPersonAccountEnable": false,
  "jobId": "a0C5f000000JobXYZ",
  "Name": "Account Dedup Job",
  "Id": "",
  "processId": "",
  "runId": "",
  "Rule_Set_Id__c": "a0B5f000000RuleXYZ",
  "Record_Type__c": "Account",
  "Process_kind__c": "Dedup",
  "Source__c": "OneAPI",
  "Last_Run_Id__c": "",
  "date": "2026-10-29",
  "isKilling": false,
  "attributes": {},
  "auditJson": {},
  "Automatic_Dedup_Merge__c": true,
  "Automatic_B2B_Merge__c": true,
  "Automatic_RNVP_Merge__c": false,
  "SF_Default_Merge__c": false,
  "Auto_Merge_Threshold__c": 85,
  "Merge_B2B_Status_Code__c": 0,
  "Merge_RNVP_Status_Code__c": "",
  "Assign_To_Owner__c": false,
  "Authorized_Empty_Bulk__c": false,
  "delete_record__c": false,
  "Enable_UnMerge_Dedup__c": false,
  "Enable_Reparenting_Inactive_Child__c": false,
  "Max_Record_Per_Batchable__c": 200,
  "filterJson": "",
  "Filters_ListView_Json__c": [],
  "Selected_List_View__c": "",
  "Run_On_View__c": false,
  "Use_Sort_LV__c": false,
  "Selected_Fields__c": {}
};

axios.post('https://{DOMAIN}/newJob', body, {
  headers: { 'DQE-Authorization': '{API_KEY}' }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String json = "{" +
    "  \"aud\": \"DQEOne\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"orgPrefix\": \"dqe__\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"url\": \"https://mycompany.my.salesforce.com/services/data/v58.0\"," +
    "  \"Region\": \"EU\"," +
    "  \"chatterId\": \"0D55f00000ChatterXYZ\"," +
    "  \"isFreeTrial\": false," +
    "  \"isPersonAccountEnable\": false," +
    "  \"jobId\": \"a0C5f000000JobXYZ\"," +
    "  \"Name\": \"Account Dedup Job\"," +
    "  \"Id\": \"\"," +
    "  \"processId\": \"\"," +
    "  \"runId\": \"\"," +
    "  \"Rule_Set_Id__c\": \"a0B5f000000RuleXYZ\"," +
    "  \"Record_Type__c\": \"Account\"," +
    "  \"Process_kind__c\": \"Dedup\"," +
    "  \"Source__c\": \"OneAPI\"," +
    "  \"Last_Run_Id__c\": \"\"," +
    "  \"date\": \"2026-10-29\"," +
    "  \"isKilling\": false," +
    "  \"attributes\": {}," +
    "  \"auditJson\": {}," +
    "  \"Automatic_Dedup_Merge__c\": true," +
    "  \"Automatic_B2B_Merge__c\": true," +
    "  \"Automatic_RNVP_Merge__c\": false," +
    "  \"SF_Default_Merge__c\": false," +
    "  \"Auto_Merge_Threshold__c\": 85," +
    "  \"Merge_B2B_Status_Code__c\": 0," +
    "  \"Merge_RNVP_Status_Code__c\": \"\"," +
    "  \"Assign_To_Owner__c\": false," +
    "  \"Authorized_Empty_Bulk__c\": false," +
    "  \"delete_record__c\": false," +
    "  \"Enable_UnMerge_Dedup__c\": false," +
    "  \"Enable_Reparenting_Inactive_Child__c\": false," +
    "  \"Max_Record_Per_Batchable__c\": 200," +
    "  \"filterJson\": \"\"," +
    "  \"Filters_ListView_Json__c\": []," +
    "  \"Selected_List_View__c\": \"\"," +
    "  \"Run_On_View__c\": false," +
    "  \"Use_Sort_LV__c\": false," +
    "  \"Selected_Fields__c\": {}" +
    "}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/newJob"))
    .header("Content-Type", "application/json")
    .header("DQE-Authorization", "{API_KEY}")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("DQE-Authorization", "{API_KEY}");

var json = "{" +
    "  \"aud\": \"DQEOne\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"orgPrefix\": \"dqe__\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"url\": \"https://mycompany.my.salesforce.com/services/data/v58.0\"," +
    "  \"Region\": \"EU\"," +
    "  \"chatterId\": \"0D55f00000ChatterXYZ\"," +
    "  \"isFreeTrial\": false," +
    "  \"isPersonAccountEnable\": false," +
    "  \"jobId\": \"a0C5f000000JobXYZ\"," +
    "  \"Name\": \"Account Dedup Job\"," +
    "  \"Id\": \"\"," +
    "  \"processId\": \"\"," +
    "  \"runId\": \"\"," +
    "  \"Rule_Set_Id__c\": \"a0B5f000000RuleXYZ\"," +
    "  \"Record_Type__c\": \"Account\"," +
    "  \"Process_kind__c\": \"Dedup\"," +
    "  \"Source__c\": \"OneAPI\"," +
    "  \"Last_Run_Id__c\": \"\"," +
    "  \"date\": \"2026-10-29\"," +
    "  \"isKilling\": false," +
    "  \"attributes\": {}," +
    "  \"auditJson\": {}," +
    "  \"Automatic_Dedup_Merge__c\": true," +
    "  \"Automatic_B2B_Merge__c\": true," +
    "  \"Automatic_RNVP_Merge__c\": false," +
    "  \"SF_Default_Merge__c\": false," +
    "  \"Auto_Merge_Threshold__c\": 85," +
    "  \"Merge_B2B_Status_Code__c\": 0," +
    "  \"Merge_RNVP_Status_Code__c\": \"\"," +
    "  \"Assign_To_Owner__c\": false," +
    "  \"Authorized_Empty_Bulk__c\": false," +
    "  \"delete_record__c\": false," +
    "  \"Enable_UnMerge_Dedup__c\": false," +
    "  \"Enable_Reparenting_Inactive_Child__c\": false," +
    "  \"Max_Record_Per_Batchable__c\": 200," +
    "  \"filterJson\": \"\"," +
    "  \"Filters_ListView_Json__c\": []," +
    "  \"Selected_List_View__c\": \"\"," +
    "  \"Run_On_View__c\": false," +
    "  \"Use_Sort_LV__c\": false," +
    "  \"Selected_Fields__c\": {}" +
    "}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync("https://{DOMAIN}/newJob", content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{
  "aud": "DQEOne",
  "crt": "1730000000",
  "sub": "0055f000000XyZAAU",
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "urllogin": "https://mycompany.my.salesforce.com",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "Region": "EU",
  "chatterId": "0D55f00000ChatterXYZ",
  "isFreeTrial": false,
  "isPersonAccountEnable": false,
  "jobId": "a0C5f000000JobXYZ",
  "Name": "Account Dedup Job",
  "Id": "",
  "processId": "",
  "runId": "",
  "Rule_Set_Id__c": "a0B5f000000RuleXYZ",
  "Record_Type__c": "Account",
  "Process_kind__c": "Dedup",
  "Source__c": "OneAPI",
  "Last_Run_Id__c": "",
  "date": "2026-10-29",
  "isKilling": false,
  "attributes": {},
  "auditJson": {},
  "Automatic_Dedup_Merge__c": true,
  "Automatic_B2B_Merge__c": true,
  "Automatic_RNVP_Merge__c": false,
  "SF_Default_Merge__c": false,
  "Auto_Merge_Threshold__c": 85,
  "Merge_B2B_Status_Code__c": 0,
  "Merge_RNVP_Status_Code__c": "",
  "Assign_To_Owner__c": false,
  "Authorized_Empty_Bulk__c": false,
  "delete_record__c": false,
  "Enable_UnMerge_Dedup__c": false,
  "Enable_Reparenting_Inactive_Child__c": false,
  "Max_Record_Per_Batchable__c": 200,
  "filterJson": "",
  "Filters_ListView_Json__c": [],
  "Selected_List_View__c": "",
  "Run_On_View__c": false,
  "Use_Sort_LV__c": false,
  "Selected_Fields__c": {}
}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/newJob", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{API_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Header

Header	Beschreibung	Pflicht / Opt.
DQE-Authorization	API-Schlüssel zur Authentifizierung der Anfrage. Siehe Authentifizierung & Sitzung, um zu erfahren, wie Sie diesen Wert erhalten und konfigurieren.	Erforderlich

Body-Parameter

Die 44 Body-Parameter unten sind zur besseren Übersicht in vier Bereiche gegliedert: Sitzungs- & Organisationsidentität, Job-Kennungen & Nutzdaten, Merge- & Dublettenbereinigungsoptionen sowie Datensatzfilterung & Listenansicht. Felder mit dem Suffix __c sind benutzerdefinierte Felder des zugrunde liegenden Salesforce-Job-Konfigurationsobjekts, gemäß der Salesforce-Standardnamenskonvention für benutzerdefinierte Felder.

Sitzungs- & Organisationsidentität

Parameter	Beschreibung	Pflicht / Opt.
aud	Der Audience-Claim — der vorgesehene Empfänger-/Zieldienst dieser signierten Anfrage. Typ: String	Erforderlich
crt	Der Created/Issued-At-Zeitstempel-Claim dieser signierten Anfrage. Typ: String	Erforderlich
sub	Der Subject-Claim — die Salesforce-Benutzer-/Sitzungskennung, die die Anfrage stellt. Typ: String	Erforderlich
orgId	Die Salesforce-Organisations-ID, die die Anfrage stellt. Typ: String	Erforderlich
orgPrefix	Ein kurzer Namespace/Präfix, der die benutzerdefinierten Felder der Organisation in Salesforce kennzeichnet. Typ: String	Erforderlich
urllogin	Die Login-URL der Salesforce-Organisation. Typ: String	Erforderlich
url	Die Instanz-/API-Basis-URL der Salesforce-Organisation. Die Quellspezifikation klärt nicht, wie sich dies vom obigen `urllogin` unterscheidet — vermutlich die REST-API-Instanz-URL der Organisation im Gegensatz zu ihrer Login-URL. Mit JP abstimmen. Typ: String	Erforderlich
Region	Die Region oder das Rechenzentrum der Salesforce-Organisation oder der DQE-Instanz. Typ: String	Optional
chatterId	Kennung eines Salesforce-Chatter-Datensatzes (zum Beispiel eines Feed-Eintrags), an den Fortschritts- oder Abschlussmeldungen des Jobs gepostet werden. Nur aus dem Feldnamen abgeleitet — der genaue Zweck ist in der Quellspezifikation nicht dokumentiert. Typ: String	Optional
isFreeTrial	Gibt an, ob die aufrufende Organisation eine kostenlose DQE-Testlizenz nutzt. Nur aus dem Feldnamen abgeleitet — in der Quellspezifikation nicht dokumentiert. Typ: Boolean	Optional
isPersonAccountEnable	Gibt an, ob Personenkonten (Person Accounts) in der aufrufenden Salesforce-Organisation aktiviert sind. Typ: Boolean	Optional

Job-Kennungen & Nutzdaten

Parameter	Beschreibung	Pflicht / Opt.
jobId	Kennung der Job-Definition/-Konfiguration, die gestartet wird. Typ: String	Erforderlich
Name	Der Anzeigename des Jobs. Typ: String	Erforderlich
Id	Die Salesforce-Datensatz-ID einer bestehenden Job-Konfiguration, wenn eine bestehende Konfiguration aktualisiert oder erneut ausgeführt wird, statt einen völlig neuen Job zu erstellen. Nur aus dem Feldnamen abgeleitet. Typ: String	Optional
processId	Kennung eines zugehörigen Prozesses. Die Quellspezifikation dokumentiert nicht den Zusammenhang mit `jobId` oder `runId` — mit JP abstimmen. Typ: String	Optional
runId	Kennung für diesen konkreten Lauf des Jobs. Könnte vom Aufrufer erzeugt oder vom Server zurückgegeben werden — in der Quellspezifikation nicht dokumentiert. Typ: String	Optional
Rule_Set_Id__c	Die Kennung des Datenabgleichs-/Merge-Regelsatzes, den dieser Job anwendet. Siehe dasselbe Feld bei `getFusionField` / `createFusionLookup` unter Datenkonfiguration. Typ: String	Erforderlich
Record_Type__c	Das Salesforce-Objekt bzw. der Datensatztyp, auf dem dieser Job arbeitet (zum Beispiel Account oder Contact). Nur aus dem Feldnamen abgeleitet. Typ: String	Erforderlich
Process_kind__c	Die Art des Datenqualitätsprozesses, den dieser Job ausführt — zum Beispiel Dublettenbereinigung, B2B-Kontoabgleich oder RNVP-Adressvalidierung, abhängig von den weiter unten in dieser Tabelle aufgeführten Schaltern. Die Quellspezifikation definiert dies als einfache Zeichenkette, ohne zulässige Werte aufzuzählen. Typ: String	Erforderlich
Source__c	Eine Kennzeichnung der Quelle/des Ursprungs dieser Job-Anfrage. Nur aus dem Feldnamen abgeleitet. Typ: String	Optional
Last_Run_Id__c	Die Kennung des vorherigen Laufs dieses Jobs, falls vorhanden — vermutlich verwendet, um eine frühere Ausführung fortzusetzen oder mit ihr zu vergleichen. Typ: String	Optional
date	Ein mit dem Job verknüpftes Datum (zum Beispiel ein angefordertes oder geplantes Ausführungsdatum). Die Quellspezifikation definiert dies als einfache Zeichenkette ohne festgelegtes Format. Typ: String	Optional
isKilling	Gibt an, ob diese Anfrage einen laufenden Durchlauf abbrechen/stoppen soll, statt einen neuen zu starten. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
attributes	Ein generisches JSON-Objekt. Die Quellspezifikation definiert keine Unterelemente. In Salesforce-API-Antworten enthält ein `attributes`-Objekt üblicherweise Datensatzmetadaten (zum Beispiel `type` und `url`) — ob diese Konvention hier gilt, ist nicht bestätigt. Typ: Objekt (JSON)	Optional
auditJson	Ein generisches JSON-Objekt mit den Konfigurationsdaten des Audits/Jobs. Die Quellspezifikation definiert keine Unterelemente — die interne Struktur ist nicht bestätigt. Die erwartete Struktur mit der DQE-Entwicklung abstimmen. Typ: Objekt (JSON)	Erforderlich

Merge- & Dublettenbereinigungsoptionen

Parameter	Beschreibung	Pflicht / Opt.
Automatic_Dedup_Merge__c	Gibt an, ob übereinstimmende Dubletten im Rahmen dieses Jobs automatisch zusammengeführt werden sollen, ohne manuelle Prüfung. Typ: Boolean	Optional
Automatic_B2B_Merge__c	Gibt an, ob übereinstimmende B2B-Datensätze (Geschäftskonten) automatisch zusammengeführt werden sollen, entsprechend dem an anderer Stelle in der DQE-Produktlinie dokumentierten B2B-Abgleichsverhalten. Typ: Boolean	Optional
Automatic_RNVP_Merge__c	Gibt an, ob Datensätze, deren Adresse durch RNVP (Postadressvalidierung/-normalisierung) korrigiert wurde, automatisch zusammengeführt werden sollen. Typ: Boolean	Optional
SF_Default_Merge__c	Gibt an, ob beim Zusammenführen abgeglichener Datensätze das Standard-Merge-Verhalten von Salesforce anstelle der DQE-Merge-Logik verwendet werden soll. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
Auto_Merge_Threshold__c	Der Schwellenwert für den Abgleichs-Konfidenzwert, oberhalb dessen Datensätze automatisch zusammengeführt und unterhalb dessen sie zur manuellen Prüfung belassen werden. Die Quellspezifikation dokumentiert nicht die verwendete Skala. Typ: Integer	Optional
Merge_B2B_Status_Code__c	Ein Statuscode, der B2B-Datensätzen nach einem Merge-/Abgleichsdurchlauf zugewiesen wird. Die Quellspezifikation zählt die möglichen Werte nicht auf. Typ: Integer	Optional
Merge_RNVP_Status_Code__c	Ein Statuscode, der Datensätzen nach einem RNVP-Adressvalidierungsdurchlauf zugewiesen wird. Die Quellspezifikation zählt die möglichen Werte nicht auf. Typ: String	Optional
Assign_To_Owner__c	Gibt an, ob zusammengeführte/überlebende Datensätze einem bestimmten Eigentümer neu zugewiesen werden sollen. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
Authorized_Empty_Bulk__c	Gibt an, ob der Job berechtigt ist, im Bulk-Modus gegen eine leere Datensatzmenge zu laufen, statt als vermutliche Fehlkonfiguration blockiert zu werden. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
delete_record__c	Gibt an, ob unterlegene/doppelte Datensätze nach dem Abgleich gelöscht (statt zusammengeführt oder nur markiert) werden sollen. Typ: Boolean	Optional
Enable_UnMerge_Dedup__c	Gibt an, ob zuvor bereinigte/zusammengeführte Datensätze durch diesen Job wieder getrennt werden können. Typ: Boolean	Optional
Enable_Reparenting_Inactive_Child__c	Gibt an, ob Kind-Datensätze, die einem inaktiven übergeordneten Datensatz zugeordnet sind, im Rahmen des Jobs neu zugeordnet werden sollen. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
Max_Record_Per_Batchable__c	Die maximale Anzahl an Datensätzen, die pro Salesforce-Batch-Ausführung (Batchable Apex) verarbeitet werden. Typ: Integer	Optional

Datensatzfilterung & Listenansicht

Parameter	Beschreibung	Pflicht / Opt.
filterJson	Eine JSON-codierte Zeichenkette, die einen Filter definiert, mit dem der Job auf eine Teilmenge von Datensätzen eingegrenzt wird, ähnlich wie `filterJson` weiter unten bei Preview Data Prep. Typ: String	Optional
Filters_ListView_Json__c	Ein Array, das Filter aus einer Salesforce-Listenansicht definiert und zur Eingrenzung des Jobs dient. Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Optional
Selected_List_View__c	Die Kennung der Salesforce-Listenansicht, die zur Eingrenzung dieses Jobs ausgewählt wurde, verwendet zusammen mit `Run_On_View__c` weiter unten. Typ: String	Optional
Run_On_View__c	Gibt an, ob der Job nur auf die Datensätze der ausgewählten Listenansicht (`Selected_List_View__c`) angewendet werden soll, statt auf das gesamte Objekt. Typ: Boolean	Optional
Use_Sort_LV__c	Gibt an, ob die eigene Sortierreihenfolge der Listenansicht bei der Verarbeitung der Datensätze beibehalten werden soll. Nur aus dem Feldnamen abgeleitet. Typ: Boolean	Optional
Selected_Fields__c	Ein generisches JSON-Objekt mit den für diesen Job ausgewählten Feldern (zum Beispiel, welche Felder verglichen oder zurückgegeben werden sollen). Die Quellspezifikation definiert keine Unterelemente. Typ: Objekt (JSON)	Optional

Antwort

Bei erfolgreichem Aufruf gibt die API ein JSON-Objekt mit den folgenden Schlüsseln zurück.

Ungewöhnliche Form der Erfolgsantwort — Die zugrunde liegende OpenAPI-Spezifikation dokumentiert genau dieses {err, message}-Schema als 200-Erfolgsantwort von /newJob. Dass Feldnamen, die normalerweise mit einer Fehler-Payload assoziiert werden (err, message), für die dokumentierte Erfolgsantwort verwendet werden, ist ungewöhnlich und wird hier unverändert dokumentiert, statt „korrigiert“ zu werden. Dies sollte der DQE-Entwicklung gemeldet werden: Entweder wurde das Erfolgsschema in der Spezifikation falsch gekennzeichnet oder aus einer Fehlerantwort kopiert, oder die produktive API gibt tatsächlich immer diese beiden Schlüssel zurück (zum Beispiel mit leerem err bei Erfolg). Bestätigen Sie das tatsächliche Verhalten, bevor Sie einen Client gegen diese Antwort entwickeln.

Schlüssel	Beschreibung	Typ
err	Ein Fehlercode oder eine Fehlermeldung. Das Feld ist genau so dokumentiert, wie es in der Quellspezifikation für die `200`-Erfolgsantwort dieses Endpunkts erscheint — siehe den Hinweis oben.	string
message	Eine für Menschen lesbare Meldung, die das Ergebnis der Job-Erstellungsanfrage beschreibt.	string

Antwortbeispiel

Beispiel einer Antwort für einen neuen Job

{
  "err": "",
  "message": "Job created successfully"
}

Fehler

Nicht in der Quellspezifikation dokumentiert. Die OpenAPI-Definition dieses Endpunkts dokumentiert nur die Erfolgsantwort 200 — sie definiert keine spezifischen Fehlerstatuscodes, Fehler-Bodies oder Fehlerszenarien. In der Praxis sind die üblichen HTTP-Fehlerfälle zu erwarten (zum Beispiel ein 4xx-Status bei fehlendem oder ungültigem DQE-Authorization-Header oder einem fehlerhaften Request-Body sowie ein 5xx-Status bei einem serverseitigen Fehler), die genauen Codes und Payloads sind jedoch nicht bestätigt. Dieser Abschnitt sollte vervollständigt werden, sobald reale Fehlerantworten beobachtet oder von der DQE-Entwicklung bestätigt wurden.

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen. Die DQE-One-Serveradresse ist spezifisch für Ihre Salesforce-Organisation — geben Sie sie unten ein, bevor Sie eine Anfrage senden.

Konsole öffnen

API-Konsole POST /newJob

DQE-One-Serveradresse

DQE-Authorization-Header-Wert (API-Schlüssel)

Request-Body (JSON)

Sitzungs- & Organisationsidentität

aud erforderlich

crt erforderlich

sub erforderlich

orgId erforderlich

orgPrefix erforderlich

urllogin erforderlich

url erforderlich

Region optional

chatterId optional

isFreeTrial optional

isPersonAccountEnable optional

Job-Kennungen & Nutzdaten

jobId erforderlich

Name erforderlich

Id optional

processId optional

runId optional

Rule_Set_Id__c erforderlich

Record_Type__c erforderlich

Process_kind__c erforderlich

Source__c optional

Last_Run_Id__c optional

date optional

isKilling optional

attributes optional

auditJson erforderlich

Merge- & Dublettenbereinigungsoptionen

Automatic_Dedup_Merge__c optional

Automatic_B2B_Merge__c optional

Automatic_RNVP_Merge__c optional

SF_Default_Merge__c optional

Auto_Merge_Threshold__c optional

Merge_B2B_Status_Code__c optional

Merge_RNVP_Status_Code__c optional

Assign_To_Owner__c optional

Authorized_Empty_Bulk__c optional

delete_record__c optional

Enable_UnMerge_Dedup__c optional

Enable_Reparenting_Inactive_Child__c optional

Max_Record_Per_Batchable__c optional

Datensatzfilterung & Listenansicht

filterJson optional

Filters_ListView_Json__c optional

Selected_List_View__c optional

Run_On_View__c optional

Use_Sort_LV__c optional

Selected_Fields__c optional

Jobs & Audits — DQE One API

Startet einen Audit-Prozess für eine Salesforce-Organisation, identifiziert durch die Standard-Sitzungsangaben sowie eine frei definierbare DQE_Process__c-Parameterzuordnung.

launchAudit

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie den Request-Body als JSON mit Content-Type: application/json.

POSThttps://{DOMAIN}/launchAudit

Codebeispiele

Einen Audit starten

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/launchAudit" \
  -H "Content-Type: application/json" \
  -H "DQE-Authorization: {API_KEY}" \
  -d '{"orgId": "00D5f000000ABCDEAU", "sub": "0055f000000XyZAAU", "aud": "DQEOne", "urllogin": "https://mycompany.my.salesforce.com", "crt": "1730000000", "DQE_Process__c": {"ProcessType": "Audit", "TriggeredBy": "ManualLaunch"}}'

const body = {
  "orgId": "00D5f000000ABCDEAU",
  "sub": "0055f000000XyZAAU",
  "aud": "DQEOne",
  "urllogin": "https://mycompany.my.salesforce.com",
  "crt": "1730000000",
  "DQE_Process__c": {
    "ProcessType": "Audit",
    "TriggeredBy": "ManualLaunch"
  }
};

fetch("https://{DOMAIN}/launchAudit", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "DQE-Authorization": "{API_KEY}"
  },
  body: JSON.stringify(body)
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

body = {
  "orgId": "00D5f000000ABCDEAU",
  "sub": "0055f000000XyZAAU",
  "aud": "DQEOne",
  "urllogin": "https://mycompany.my.salesforce.com",
  "crt": "1730000000",
  "DQE_Process__c": {
    "ProcessType": "Audit",
    "TriggeredBy": "ManualLaunch"
  }
}

response = requests.post(
    "https://{DOMAIN}/launchAudit",
    headers={"DQE-Authorization": "{API_KEY}"},
    json=body,
)
print(response.json())

<?php
$body = json_encode([
    'orgId' => '00D5f000000ABCDEAU',
    'sub' => '0055f000000XyZAAU',
    'aud' => 'DQEOne',
    'urllogin' => 'https://mycompany.my.salesforce.com',
    'crt' => '1730000000',
    'DQE_Process__c' => [
        'ProcessType' => 'Audit',
        'TriggeredBy' => 'ManualLaunch'
    ]
]);

$ch = curl_init("https://{DOMAIN}/launchAudit");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'DQE-Authorization: {API_KEY}',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

const axios = require('axios');

const body = {
  "orgId": "00D5f000000ABCDEAU",
  "sub": "0055f000000XyZAAU",
  "aud": "DQEOne",
  "urllogin": "https://mycompany.my.salesforce.com",
  "crt": "1730000000",
  "DQE_Process__c": {
    "ProcessType": "Audit",
    "TriggeredBy": "ManualLaunch"
  }
};

axios.post('https://{DOMAIN}/launchAudit', body, {
  headers: { 'DQE-Authorization': '{API_KEY}' }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String json = "{" +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"aud\": \"DQEOne\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"DQE_Process__c\": {" +
    "    \"ProcessType\": \"Audit\"," +
    "    \"TriggeredBy\": \"ManualLaunch\"" +
    "  }" +
    "}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/launchAudit"))
    .header("Content-Type", "application/json")
    .header("DQE-Authorization", "{API_KEY}")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("DQE-Authorization", "{API_KEY}");

var json = "{" +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"aud\": \"DQEOne\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"DQE_Process__c\": {" +
    "    \"ProcessType\": \"Audit\"," +
    "    \"TriggeredBy\": \"ManualLaunch\"" +
    "  }" +
    "}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync("https://{DOMAIN}/launchAudit", content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{
  "orgId": "00D5f000000ABCDEAU",
  "sub": "0055f000000XyZAAU",
  "aud": "DQEOne",
  "urllogin": "https://mycompany.my.salesforce.com",
  "crt": "1730000000",
  "DQE_Process__c": {
    "ProcessType": "Audit",
    "TriggeredBy": "ManualLaunch"
  }
}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/launchAudit", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{API_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Header

Header	Beschreibung	Pflicht / Opt.
DQE-Authorization	API-Schlüssel zur Authentifizierung der Anfrage. Siehe Authentifizierung & Sitzung, um zu erfahren, wie Sie diesen Wert erhalten und konfigurieren.	Erforderlich

Body-Parameter

Parameter	Beschreibung	Pflicht / Opt.
orgId	Die Salesforce-Organisations-ID, die die Anfrage stellt. Typ: String	Erforderlich
sub	Der Subject-Claim — die Salesforce-Benutzer-/Sitzungskennung, die die Anfrage stellt. Typ: String	Erforderlich
aud	Der Audience-Claim — der vorgesehene Empfänger-/Zieldienst dieser signierten Anfrage. Typ: String	Erforderlich
urllogin	Die Login-URL der Salesforce-Organisation. Typ: String	Erforderlich
crt	Der Created/Issued-At-Zeitstempel-Claim dieser signierten Anfrage. Typ: String	Erforderlich
DQE_Process__c	Eine frei definierbare Schlüssel-Wert-Zuordnung von Prozessparametern für den zu startenden Audit. Die Quellspezifikation definiert dies als Objekt, dessen Werte Zeichenketten sein müssen (`additionalProperties: string`), ohne die erwarteten Schlüssel aufzuzählen — die erwarteten Schlüssel mit der DQE-Entwicklung abstimmen. Typ: Objekt (JSON)	Erforderlich

Antwort

Bei erfolgreichem Aufruf gibt die API ein JSON-Objekt mit den folgenden Schlüsseln zurück.

Schlüssel	Beschreibung	Typ
status	Der Status des Audit-Startvorgangs (zum Beispiel eine einfache Erfolgs-/Fehler-Kennzeichenkette). Die Quellspezifikation zählt die möglichen Werte nicht auf.	string

Antwortbeispiel

Beispielantwort für den Audit-Start

{
  "status": "ok"
}

Fehler

API testen

Konsole öffnen

Jobs & Audits — DQE One API

Zeigt eine Vorschau, wie Datensätze nach Anwendung einer konfigurierten Datenaufbereitungstransformation (Suchen/Ersetzen, optional mit regulären Ausdrücken) auf ein Feld aussehen würden, bevor Änderungen übernommen werden.

previewDataPrep

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie den Request-Body als JSON mit Content-Type: application/json.

POSThttps://{DOMAIN}/previewDataPrep

Codebeispiele

Eine Datenaufbereitungstransformation in der Vorschau anzeigen

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/previewDataPrep" \
  -H "Content-Type: application/json" \
  -H "DQE-Authorization: {API_KEY}" \
  -d '{"aud": "DQEOne", "crt": "1730000000", "filterJson": "", "find": ["Rue"], "format": [], "isPersonAccount": false, "isRegex": [false], "orgId": "00D5f000000ABCDEAU", "orgPrefix": "dqe__", "origin": ["BillingStreet"], "prevRecords": [], "ProcessKind": "DataPrep", "RecordType": "Account", "replace": ["Rue De"], "selectedFieldName": "BillingStreet", "sub": "0055f000000XyZAAU", "url": "https://mycompany.my.salesforce.com/services/data/v58.0", "urllogin": "https://mycompany.my.salesforce.com", "uuidPage": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

const body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "filterJson": "",
  "find": [
    "Rue"
  ],
  "format": [],
  "isPersonAccount": false,
  "isRegex": [
    false
  ],
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "origin": [
    "BillingStreet"
  ],
  "prevRecords": [],
  "ProcessKind": "DataPrep",
  "RecordType": "Account",
  "replace": [
    "Rue De"
  ],
  "selectedFieldName": "BillingStreet",
  "sub": "0055f000000XyZAAU",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "urllogin": "https://mycompany.my.salesforce.com",
  "uuidPage": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
};

fetch("https://{DOMAIN}/previewDataPrep", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "DQE-Authorization": "{API_KEY}"
  },
  body: JSON.stringify(body)
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "filterJson": "",
  "find": [
    "Rue"
  ],
  "format": [],
  "isPersonAccount": False,
  "isRegex": [
    false
  ],
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "origin": [
    "BillingStreet"
  ],
  "prevRecords": [],
  "ProcessKind": "DataPrep",
  "RecordType": "Account",
  "replace": [
    "Rue De"
  ],
  "selectedFieldName": "BillingStreet",
  "sub": "0055f000000XyZAAU",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "urllogin": "https://mycompany.my.salesforce.com",
  "uuidPage": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.post(
    "https://{DOMAIN}/previewDataPrep",
    headers={"DQE-Authorization": "{API_KEY}"},
    json=body,
)
print(response.json())

<?php
$body = json_encode([
    'aud' => 'DQEOne',
    'crt' => '1730000000',
    'filterJson' => '',
    'find' => [
        'Rue'
    ],
    'format' => [],
    'isPersonAccount' => false,
    'isRegex' => [
        false
    ],
    'orgId' => '00D5f000000ABCDEAU',
    'orgPrefix' => 'dqe__',
    'origin' => [
        'BillingStreet'
    ],
    'prevRecords' => [],
    'ProcessKind' => 'DataPrep',
    'RecordType' => 'Account',
    'replace' => [
        'Rue De'
    ],
    'selectedFieldName' => 'BillingStreet',
    'sub' => '0055f000000XyZAAU',
    'url' => 'https://mycompany.my.salesforce.com/services/data/v58.0',
    'urllogin' => 'https://mycompany.my.salesforce.com',
    'uuidPage' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]);

$ch = curl_init("https://{DOMAIN}/previewDataPrep");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'DQE-Authorization: {API_KEY}',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

const axios = require('axios');

const body = {
  "aud": "DQEOne",
  "crt": "1730000000",
  "filterJson": "",
  "find": [
    "Rue"
  ],
  "format": [],
  "isPersonAccount": false,
  "isRegex": [
    false
  ],
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "origin": [
    "BillingStreet"
  ],
  "prevRecords": [],
  "ProcessKind": "DataPrep",
  "RecordType": "Account",
  "replace": [
    "Rue De"
  ],
  "selectedFieldName": "BillingStreet",
  "sub": "0055f000000XyZAAU",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "urllogin": "https://mycompany.my.salesforce.com",
  "uuidPage": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
};

axios.post('https://{DOMAIN}/previewDataPrep', body, {
  headers: { 'DQE-Authorization': '{API_KEY}' }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String json = "{" +
    "  \"aud\": \"DQEOne\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"filterJson\": \"\"," +
    "  \"find\": [" +
    "    \"Rue\"" +
    "  ]," +
    "  \"format\": []," +
    "  \"isPersonAccount\": false," +
    "  \"isRegex\": [" +
    "    false" +
    "  ]," +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"orgPrefix\": \"dqe__\"," +
    "  \"origin\": [" +
    "    \"BillingStreet\"" +
    "  ]," +
    "  \"prevRecords\": []," +
    "  \"ProcessKind\": \"DataPrep\"," +
    "  \"RecordType\": \"Account\"," +
    "  \"replace\": [" +
    "    \"Rue De\"" +
    "  ]," +
    "  \"selectedFieldName\": \"BillingStreet\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"url\": \"https://mycompany.my.salesforce.com/services/data/v58.0\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"uuidPage\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"" +
    "}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/previewDataPrep"))
    .header("Content-Type", "application/json")
    .header("DQE-Authorization", "{API_KEY}")
    .POST(HttpRequest.BodyPublishers.ofString(json))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("DQE-Authorization", "{API_KEY}");

var json = "{" +
    "  \"aud\": \"DQEOne\"," +
    "  \"crt\": \"1730000000\"," +
    "  \"filterJson\": \"\"," +
    "  \"find\": [" +
    "    \"Rue\"" +
    "  ]," +
    "  \"format\": []," +
    "  \"isPersonAccount\": false," +
    "  \"isRegex\": [" +
    "    false" +
    "  ]," +
    "  \"orgId\": \"00D5f000000ABCDEAU\"," +
    "  \"orgPrefix\": \"dqe__\"," +
    "  \"origin\": [" +
    "    \"BillingStreet\"" +
    "  ]," +
    "  \"prevRecords\": []," +
    "  \"ProcessKind\": \"DataPrep\"," +
    "  \"RecordType\": \"Account\"," +
    "  \"replace\": [" +
    "    \"Rue De\"" +
    "  ]," +
    "  \"selectedFieldName\": \"BillingStreet\"," +
    "  \"sub\": \"0055f000000XyZAAU\"," +
    "  \"url\": \"https://mycompany.my.salesforce.com/services/data/v58.0\"," +
    "  \"urllogin\": \"https://mycompany.my.salesforce.com\"," +
    "  \"uuidPage\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"" +
    "}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync("https://{DOMAIN}/previewDataPrep", content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{
  "aud": "DQEOne",
  "crt": "1730000000",
  "filterJson": "",
  "find": [
    "Rue"
  ],
  "format": [],
  "isPersonAccount": false,
  "isRegex": [
    false
  ],
  "orgId": "00D5f000000ABCDEAU",
  "orgPrefix": "dqe__",
  "origin": [
    "BillingStreet"
  ],
  "prevRecords": [],
  "ProcessKind": "DataPrep",
  "RecordType": "Account",
  "replace": [
    "Rue De"
  ],
  "selectedFieldName": "BillingStreet",
  "sub": "0055f000000XyZAAU",
  "url": "https://mycompany.my.salesforce.com/services/data/v58.0",
  "urllogin": "https://mycompany.my.salesforce.com",
  "uuidPage": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/previewDataPrep", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{API_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Header

Header	Beschreibung	Pflicht / Opt.
DQE-Authorization	API-Schlüssel zur Authentifizierung der Anfrage. Siehe Authentifizierung & Sitzung, um zu erfahren, wie Sie diesen Wert erhalten und konfigurieren.	Erforderlich

Body-Parameter

Parameter	Beschreibung	Pflicht / Opt.
aud	Der Audience-Claim — der vorgesehene Empfänger-/Zieldienst dieser signierten Anfrage. Typ: String	Erforderlich
crt	Der Created/Issued-At-Zeitstempel-Claim dieser signierten Anfrage. Typ: String	Erforderlich
filterJson	Eine JSON-codierte Zeichenkette, die die Vorschau auf eine Teilmenge von Datensätzen eingrenzt, analog zu `filterJson` bei `newJob` in der obigen Jobs-&-Audits-Tabelle. Typ: String	Optional
find	Ein Array mit den Werten, nach denen im/in den Zielfeld(ern) gesucht wird; jeder Eintrag ist positionsgebunden dem entsprechenden Eintrag in `replace` weiter unten zugeordnet. Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Erforderlich
format	Ein Array mit Formatierungsregeln, die auf die in der Vorschau angezeigten Werte angewendet werden (zum Beispiel Groß-/Kleinschreibung oder Maskierungsregeln). Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Optional
isPersonAccount	Gibt an, ob die Vorschau berücksichtigen soll, dass Personenkonten (Person Accounts) in der Organisation aktiviert sind. Typ: Boolean	Optional
isRegex	Ein Array von Kennzeichen, das pro `find`/`replace`-Paar angibt, ob der Suchwert als regulärer Ausdruck statt als literale Zeichenkette behandelt werden soll. Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Optional
orgId	Die Salesforce-Organisations-ID, die die Anfrage stellt. Typ: String	Erforderlich
orgPrefix	Ein kurzer Namespace/Präfix, der die benutzerdefinierten Felder der Organisation in Salesforce kennzeichnet. Typ: String	Erforderlich
origin	Ein Array, das das/die Quellfeld(er)/die Spalte(n) angibt, auf die sich jedes `find`/`replace`-Paar bezieht. Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Erforderlich
prevRecords	Ein Array zuvor abgerufener Datensätze, gegen die die Transformation in der Vorschau getestet wird, statt Salesforce erneut abzufragen. Die Quellspezifikation lässt die Array-Elemente ungetypt. Typ: Array (JSON)	Optional
ProcessKind	Die Art des Datenaufbereitungsprozesses, der in der Vorschau angezeigt wird. Die Quellspezifikation definiert dies als einfache Zeichenkette, ohne zulässige Werte aufzuzählen. Typ: String	Erforderlich
RecordType	Das Salesforce-Objekt bzw. der Datensatztyp, auf den sich die Vorschau bezieht (zum Beispiel Account oder Contact). Typ: String	Erforderlich
replace	Ein Array mit Ersatzwerten, positionsgebunden dem obigen `find` zugeordnet. Typ: Array (JSON)	Erforderlich
selectedFieldName	Der Name des Feldes, das in der Vorschau angezeigt/transformiert wird. Typ: String	Erforderlich
sub	Der Subject-Claim — die Salesforce-Benutzer-/Sitzungskennung, die die Anfrage stellt. Typ: String	Erforderlich
url	Die Instanz-/API-Basis-URL der Salesforce-Organisation. Typ: String	Erforderlich
urllogin	Die Login-URL der Salesforce-Organisation. Typ: String	Erforderlich
uuidPage	Eine UUID, die die Seite/Sitzung der benutzerdefinierten Oberfläche kennzeichnet, von der diese Vorschau angefordert wird, verwendet, um die Vorschau einer bestimmten UI-Sitzung zuzuordnen. Nur aus dem Feldnamen abgeleitet. Typ: String	Erforderlich

Antwort

Bei erfolgreichem Aufruf gibt die API ein JSON-Objekt mit den folgenden Schlüsseln zurück.

Schlüssel	Beschreibung	Typ
previewColumn	Ein Array von Objekten, die die von der Vorschautransformation betroffene(n) Spalte(n) beschreiben (zum Beispiel Feldmetadaten für die in der Vorschau angezeigte Spalte). Die Quellspezifikation definiert jedes Element als generisches Objekt ohne weitere Eigenschaften.	array[object]
previewValues	Ein Array von Objekten mit den in der Vorschau angezeigten Datensatzwerten nach Anwendung der konfigurierten Suchen/Ersetzen-/Regex-Transformation, ohne dass Änderungen übernommen werden. Die Quellspezifikation definiert jedes Element als generisches Objekt ohne weitere Eigenschaften.	array[object]

Antwortbeispiel

Beispielantwort für die Datenaufbereitungs-Vorschau

{
  "previewColumn": [
    {
      "field": "BillingStreet",
      "label": "Billing Street"
    }
  ],
  "previewValues": [
    {
      "Id": "0015f00000AbCdeAAE",
      "before": "12 Rue de Paris",
      "after": "12 Rue De Paris"
    }
  ]
}

Fehler

API testen

Konsole öffnen

DQE One API — Jobs & Audits

newJob

Anfrage

Codebeispiele

Parameter

Header

Body-Parameter

Antwort

Antwortbeispiel

Fehler

API testen

launchAudit

Anfrage

Codebeispiele

Parameter

Header

Body-Parameter

Antwort

Antwortbeispiel

Fehler

API testen

previewDataPrep

Anfrage

Codebeispiele

Parameter

Header

Body-Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel