API DQE One — Trabajos y auditorías

Trabajos y auditorías — API DQE One

La API DQE One es la API de backend expuesta por el paquete DQE One para Salesforce. Los endpoints de Trabajos y auditorías de esta página crean y lanzan los trabajos de calidad de datos (deduplicación, coincidencia de cuentas B2B, validación de direcciones RNVP) que el paquete DQE One ejecuta contra los registros de Salesforce, y muestran una vista previa del efecto de una transformación de preparación de datos (buscar/reemplazar) antes de confirmarla. Todos los endpoints de esta página son solo POST y utilizan el encabezado DQE-Authorization para la autenticación.

Documentación relacionada de la API DQE One:

Nota sobre Obligatorio / Opcional a continuación — la especificación OpenAPI de origen marca el cuerpo de la solicitud de cada endpoint como obligatorio en su conjunto, pero no indica si cada propiedad individual del cuerpo es obligatoria u opcional (no existe una lista required en ninguno de los esquemas del cuerpo). Las marcas de Obligatorio / Opcional en este artículo reflejan nuestro mejor criterio técnico según el papel de cada campo (identidad de sesión frente a opciones configurables) y deben confirmarse con JP antes de publicar.

Ir a Crear nuevo trabajo Lanzar auditoría Vista previa de preparación de datos

Trabajos y auditorías — API DQE One

Crea un nuevo trabajo de calidad de datos de DQE — deduplicación, coincidencia de cuentas B2B o validación de direcciones RNVP — para una organización de Salesforce, utilizando el payload de configuración de trabajo descrito a continuación.

newJob

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envíe el cuerpo de la solicitud como JSON, con Content-Type: application/json.

Autenticación — este endpoint requiere el encabezado DQE-Authorization (una clave de API). Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.

{DOMAIN} es el dominio del servidor donde está instalada la propia instancia del backend de DQE One de tu organización — dado que este backend se ejecuta en tu propia infraestructura, este valor lo determina tu despliegue, no lo emite DQE.

Nota sobre el cuerpo de la solicitud de este endpoint — en la especificación OpenAPI de origen, el cuerpo de la solicitud de /newJob se define mediante un $ref que apunta al propio esquema del cuerpo de la solicitud de la ruta /lanchAudit, en lugar de a un componente compartido. JP confirmó que /launchAudit (ortografía correcta, documentado por separado más abajo) es el endpoint real y actual, y que /lanchAudit (la ruta mal escrita presente en la especificación) no es un endpoint real/actual y no se documenta aquí por sí solo. Sin embargo, el esquema de cuerpo al que hace referencia sí es el cuerpo de solicitud genuino y actual de /newJob — por lo que se resuelve y documenta en su totalidad a continuación.

POSThttps://{DOMAIN}/newJob

Ejemplos de código

Crear un nuevo trabajo

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

Parámetros

Encabezados

Encabezado	Descripción	Obl / Opc
DQE-Authorization	Clave de API utilizada para autenticar la solicitud. Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.	Obligatorio

Parámetros del cuerpo

Los 44 parámetros del cuerpo que aparecen a continuación se agrupan, para facilitar la lectura, en cuatro áreas: sesión e identidad de la organización, identificadores del trabajo y carga útil, opciones de fusión y deduplicación, y filtrado de registros y vista de lista. Los campos con el sufijo __c son campos personalizados del objeto de configuración de trabajos subyacente de Salesforce, siguiendo la convención estándar de nomenclatura de campos personalizados de Salesforce.

Sesión e identidad de la organización

Parámetro	Descripción	Obl / Opc
aud	La reclamación de audiencia (audience) — el servicio destinatario/objetivo previsto para esta solicitud firmada. Tipo: String	Obligatorio
crt	La reclamación de marca temporal de creación/emisión de esta solicitud firmada. Tipo: String	Obligatorio
sub	La reclamación de sujeto (subject) — el identificador de usuario/sesión de Salesforce que emite la solicitud. Tipo: String	Obligatorio
orgId	El ID de la organización de Salesforce que realiza la solicitud. Tipo: String	Obligatorio
orgPrefix	Un espacio de nombres/prefijo corto que identifica los campos personalizados de la organización en Salesforce. Tipo: String	Obligatorio
urllogin	La URL de inicio de sesión de la organización de Salesforce. Tipo: String	Obligatorio
url	La URL base de la instancia/API de la organización de Salesforce. La especificación de origen no aclara en qué se diferencia de `urllogin` anterior — probablemente sea la URL de la instancia de la API REST de la organización frente a su URL de inicio de sesión. Confirmar con JP. Tipo: String	Obligatorio
Region	La región o centro de datos de la organización de Salesforce o de la instancia de DQE. Tipo: String	Opcional
chatterId	Identificador de un registro de Salesforce Chatter (por ejemplo, un elemento del feed) en el que publicar actualizaciones de progreso o finalización del trabajo. Inferido únicamente a partir del nombre del campo — su propósito exacto no está documentado en la especificación de origen. Tipo: String	Opcional
isFreeTrial	Indica si la organización que realiza la llamada tiene una licencia de prueba gratuita de DQE. Inferido únicamente a partir del nombre del campo — no está documentado en la especificación de origen. Tipo: Boolean	Opcional
isPersonAccountEnable	Indica si las cuentas personales (Person Accounts) están habilitadas en la organización de Salesforce que realiza la llamada. Tipo: Boolean	Opcional

Identificadores del trabajo y carga útil

Parámetro	Descripción	Obl / Opc
jobId	Identificador de la definición/configuración del trabajo que se está lanzando. Tipo: String	Obligatorio
Name	El nombre visible del trabajo. Tipo: String	Obligatorio
Id	El ID de registro de Salesforce de una configuración de trabajo existente, al actualizar o volver a ejecutar una en lugar de crear un trabajo completamente nuevo. Inferido únicamente a partir del nombre del campo. Tipo: String	Opcional
processId	Identificador de un proceso relacionado. La especificación de origen no documenta su relación con `jobId` o `runId` — confirmar con JP. Tipo: String	Opcional
runId	Identificador de esta ejecución específica del trabajo. Puede ser generado por quien realiza la llamada o devuelto por el servidor — no está documentado en la especificación de origen. Tipo: String	Opcional
Rule_Set_Id__c	El identificador del conjunto de reglas de coincidencia/fusión de datos que aplica este trabajo. Consulta el mismo campo en `getFusionField` / `createFusionLookup` en Configuración de datos. Tipo: String	Obligatorio
Record_Type__c	El objeto de Salesforce / tipo de registro sobre el que opera este trabajo (por ejemplo, Account o Contact). Inferido únicamente a partir del nombre del campo. Tipo: String	Obligatorio
Process_kind__c	El tipo de proceso de calidad de datos que ejecuta este trabajo — por ejemplo, deduplicación, coincidencia de cuentas B2B o validación de direcciones RNVP, según las opciones más abajo en esta tabla. La especificación de origen tipa esto como una cadena simple sin enumerar los valores permitidos. Tipo: String	Obligatorio
Source__c	Una etiqueta que identifica el origen de esta solicitud de trabajo. Inferido únicamente a partir del nombre del campo. Tipo: String	Opcional
Last_Run_Id__c	El identificador de la ejecución anterior de este trabajo, si existe — probablemente utilizado para reanudar o comparar con una ejecución previa. Tipo: String	Opcional
date	Una fecha asociada con el trabajo (por ejemplo, una fecha de ejecución solicitada o programada). La especificación de origen tipa esto como una cadena simple sin un formato definido. Tipo: String	Opcional
isKilling	Indica si esta solicitud debe detener una ejecución en curso en lugar de iniciar una nueva. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
attributes	Un objeto JSON genérico. La especificación de origen no define subpropiedades. En las respuestas de la API de Salesforce, un objeto `attributes` suele contener metadatos del registro (por ejemplo, `type` y `url`) — no está confirmado si esa convención se aplica aquí. Tipo: Object (JSON)	Opcional
auditJson	Un objeto JSON genérico que contiene el payload de configuración de la auditoría/trabajo. La especificación de origen no define subpropiedades — su forma interna no está confirmada. Confirmar la estructura esperada con el equipo de ingeniería de DQE. Tipo: Object (JSON)	Obligatorio

Opciones de fusión y deduplicación

Parámetro	Descripción	Obl / Opc
Automatic_Dedup_Merge__c	Indica si los registros duplicados coincidentes deben fusionarse automáticamente como parte de este trabajo, sin revisión manual. Tipo: Boolean	Opcional
Automatic_B2B_Merge__c	Indica si los registros B2B (cuentas de empresa) coincidentes deben fusionarse automáticamente, de forma coherente con el comportamiento de coincidencia B2B documentado en otras partes de la línea de productos de DQE. Tipo: Boolean	Opcional
Automatic_RNVP_Merge__c	Indica si los registros cuya dirección ha sido corregida por RNVP (validación/normalización de direcciones postales) deben fusionarse automáticamente. Tipo: Boolean	Opcional
SF_Default_Merge__c	Indica si debe usarse el comportamiento de fusión predeterminado de Salesforce en lugar de la lógica de fusión de DQE al consolidar los registros coincidentes. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
Auto_Merge_Threshold__c	El umbral de puntuación de confianza de coincidencia por encima del cual los registros se fusionan automáticamente, y por debajo del cual se dejan para revisión manual. La especificación de origen no documenta la escala utilizada. Tipo: Integer	Opcional
Merge_B2B_Status_Code__c	Un código de estado aplicado a los registros B2B tras un pase de fusión/coincidencia. La especificación de origen no enumera los valores posibles. Tipo: Integer	Opcional
Merge_RNVP_Status_Code__c	Un código de estado aplicado a los registros tras un pase de validación de direcciones RNVP. La especificación de origen no enumera los valores posibles. Tipo: String	Opcional
Assign_To_Owner__c	Indica si los registros fusionados/supervivientes deben reasignarse a un propietario específico. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
Authorized_Empty_Bulk__c	Indica si el trabajo está autorizado a ejecutarse sobre un conjunto de registros vacío en modo masivo, en lugar de bloquearse por una probable configuración incorrecta. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
delete_record__c	Indica si los registros perdedores/duplicados deben eliminarse (en lugar de fusionarse o simplemente marcarse) una vez emparejados. Tipo: Boolean	Opcional
Enable_UnMerge_Dedup__c	Indica si los registros previamente deduplicados/fusionados pueden separarse mediante este trabajo. Tipo: Boolean	Opcional
Enable_Reparenting_Inactive_Child__c	Indica si los registros secundarios vinculados a un registro principal inactivo deben reasignarse a otro principal como parte del trabajo. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
Max_Record_Per_Batchable__c	El número máximo de registros procesados por ejecución de lote (Batchable Apex) de Salesforce. Tipo: Integer	Opcional

Filtrado de registros y vista de lista

Parámetro	Descripción	Obl / Opc
filterJson	Una cadena codificada en JSON que define un filtro que acota el trabajo a un subconjunto de registros, similar a `filterJson` en Vista previa de preparación de datos más abajo. Tipo: String	Opcional
Filters_ListView_Json__c	Un array que define filtros derivados de una vista de lista de Salesforce, utilizado para acotar el trabajo. La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Opcional
Selected_List_View__c	El identificador de la vista de lista de Salesforce seleccionada para acotar este trabajo, utilizado junto con `Run_On_View__c` más abajo. Tipo: String	Opcional
Run_On_View__c	Indica si el trabajo debe ejecutarse únicamente sobre los registros de la vista de lista seleccionada (`Selected_List_View__c`), en lugar de sobre todo el objeto. Tipo: Boolean	Opcional
Use_Sort_LV__c	Indica si debe conservarse el propio orden de clasificación de la vista de lista al procesar los registros. Inferido únicamente a partir del nombre del campo. Tipo: Boolean	Opcional
Selected_Fields__c	Un objeto JSON genérico que enumera los campos seleccionados para este trabajo (por ejemplo, qué campos comparar o devolver). La especificación de origen no define subpropiedades. Tipo: Object (JSON)	Opcional

Respuesta

Si la llamada se realiza correctamente, la API devuelve un objeto JSON con las siguientes claves.

Forma de respuesta de éxito inusual — la especificación OpenAPI de origen documenta exactamente este esquema {err, message} como la respuesta 200 (de éxito) de /newJob. Que se usen nombres de campo normalmente asociados a un payload de error (err, message) para la respuesta de éxito documentada resulta atípico, y se documenta tal cual en lugar de «corregirlo». Señala esto al equipo de ingeniería de DQE: o bien el esquema de éxito de la especificación se etiquetó mal o se copió de una respuesta de error, o la API en producción realmente siempre devuelve estas dos claves (por ejemplo, con err vacío en caso de éxito). Confirma el comportamiento real antes de construir un cliente basado en esta respuesta.

Clave	Descripción	Tipo
err	Un código o mensaje de error. El campo se documenta exactamente como aparece en la especificación de origen para la respuesta de éxito `200` de este endpoint — consulta el aviso anterior.	string
message	Un mensaje legible por humanos que describe el resultado de la solicitud de creación del trabajo.	string

Ejemplo de respuesta

Ejemplo de respuesta de nuevo trabajo

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

Errores

No documentado en la especificación de origen. La definición OpenAPI de este endpoint solo documenta la respuesta de éxito 200 — no define códigos de estado de error, cuerpos de error ni escenarios de fallo específicos. En la práctica, cabe esperar los modos de fallo HTTP habituales (por ejemplo, un estado 4xx si falta el encabezado DQE-Authorization o es inválido, o si el cuerpo de la solicitud está mal formado, y un estado 5xx en caso de fallo del servidor), pero los códigos y payloads exactos no están confirmados. Esta sección debería completarse cuando se observen respuestas de error reales o sean confirmadas por el equipo de ingeniería de DQE.

Probar la API

Haz clic en el botón de abajo para probar este endpoint en vivo desde tu navegador. La dirección del servidor DQE One es específica de tu organización de Salesforce — introdúcela a continuación antes de enviar una solicitud.

Abrir consola

API console POST /newJob

Dirección del servidor DQE One

Valor del encabezado DQE-Authorization (clave de API)

Cuerpo de la solicitud (JSON)

Sesión e identidad de la organización

aud obligatorio

crt obligatorio

sub obligatorio

orgId obligatorio

orgPrefix obligatorio

urllogin obligatorio

url obligatorio

Region opcional

chatterId opcional

isFreeTrial opcional

isPersonAccountEnable opcional

Identificadores del trabajo y carga útil

jobId obligatorio

Name obligatorio

Id opcional

processId opcional

runId opcional

Rule_Set_Id__c obligatorio

Record_Type__c obligatorio

Process_kind__c obligatorio

Source__c opcional

Last_Run_Id__c opcional

date opcional

isKilling opcional

attributes opcional

auditJson obligatorio

Opciones de fusión y deduplicación

Automatic_Dedup_Merge__c opcional

Automatic_B2B_Merge__c opcional

Automatic_RNVP_Merge__c opcional

SF_Default_Merge__c opcional

Auto_Merge_Threshold__c opcional

Merge_B2B_Status_Code__c opcional

Merge_RNVP_Status_Code__c opcional

Assign_To_Owner__c opcional

Authorized_Empty_Bulk__c opcional

delete_record__c opcional

Enable_UnMerge_Dedup__c opcional

Enable_Reparenting_Inactive_Child__c opcional

Max_Record_Per_Batchable__c opcional

Filtrado de registros y vista de lista

filterJson opcional

Filters_ListView_Json__c opcional

Selected_List_View__c opcional

Run_On_View__c opcional

Use_Sort_LV__c opcional

Selected_Fields__c opcional

Trabajos y auditorías — API DQE One

Lanza un proceso de auditoría para una organización de Salesforce, identificado mediante las reclamaciones de sesión estándar más un mapa de parámetros de formato libre DQE_Process__c.

launchAudit

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envíe el cuerpo de la solicitud como JSON, con Content-Type: application/json.

Autenticación — este endpoint requiere el encabezado DQE-Authorization (una clave de API). Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.

POSThttps://{DOMAIN}/launchAudit

Ejemplos de código

Lanzar una auditoría

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

Parámetros

Encabezados

Encabezado	Descripción	Obl / Opc
DQE-Authorization	Clave de API utilizada para autenticar la solicitud. Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.	Obligatorio

Parámetros del cuerpo

Parámetro	Descripción	Obl / Opc
orgId	El ID de la organización de Salesforce que realiza la solicitud. Tipo: String	Obligatorio
sub	La reclamación de sujeto (subject) — el identificador de usuario/sesión de Salesforce que emite la solicitud. Tipo: String	Obligatorio
aud	La reclamación de audiencia (audience) — el servicio destinatario/objetivo previsto para esta solicitud firmada. Tipo: String	Obligatorio
urllogin	La URL de inicio de sesión de la organización de Salesforce. Tipo: String	Obligatorio
crt	La reclamación de marca temporal de creación/emisión de esta solicitud firmada. Tipo: String	Obligatorio
DQE_Process__c	Un mapa clave-valor de formato libre con los parámetros del proceso para la auditoría que se lanza. La especificación de origen tipa esto como un objeto cuyos valores deben ser cadenas (`additionalProperties: string`) y no enumera las claves esperadas — confirmar las claves esperadas con el equipo de ingeniería de DQE. Tipo: Object (JSON)	Obligatorio

Respuesta

Si la llamada se realiza correctamente, la API devuelve un objeto JSON con las siguientes claves.

Clave	Descripción	Tipo
status	El estado de la operación de lanzamiento de auditoría (por ejemplo, una simple cadena indicadora de éxito/fallo). La especificación de origen no enumera los valores posibles.	string

Ejemplo de respuesta

Ejemplo de respuesta de lanzamiento de auditoría

{
  "status": "ok"
}

Errores

Probar la API

Abrir consola

Trabajos y auditorías — API DQE One

Muestra una vista previa de cómo se verían los registros tras aplicar a un campo una transformación de preparación de datos configurada (buscar/reemplazar, opcionalmente mediante expresiones regulares), antes de confirmar cualquier cambio.

previewDataPrep

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envíe el cuerpo de la solicitud como JSON, con Content-Type: application/json.

Autenticación — este endpoint requiere el encabezado DQE-Authorization (una clave de API). Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.

POSThttps://{DOMAIN}/previewDataPrep

Ejemplos de código

Vista previa de una transformación de preparación de datos

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

Parámetros

Encabezados

Encabezado	Descripción	Obl / Opc
DQE-Authorization	Clave de API utilizada para autenticar la solicitud. Consulta Autenticación y sesión para saber cómo obtener y configurar este valor.	Obligatorio

Parámetros del cuerpo

Parámetro	Descripción	Obl / Opc
aud	La reclamación de audiencia (audience) — el servicio destinatario/objetivo previsto para esta solicitud firmada. Tipo: String	Obligatorio
crt	La reclamación de marca temporal de creación/emisión de esta solicitud firmada. Tipo: String	Obligatorio
filterJson	Una cadena codificada en JSON que acota la vista previa a un subconjunto de registros, de forma coherente con `filterJson` en `newJob` dentro de la tabla de Trabajos y auditorías anterior. Tipo: String	Opcional
find	Un array de valores a buscar dentro de los campos objetivo, cada entrada emparejada posicionalmente con la entrada correspondiente en `replace` más abajo. La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Obligatorio
format	Un array de reglas de formato aplicadas a los valores previsualizados (por ejemplo, reglas de mayúsculas/minúsculas o de enmascaramiento). La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Opcional
isPersonAccount	Indica si la vista previa debe tener en cuenta que las cuentas personales (Person Accounts) estén habilitadas en la organización. Tipo: Boolean	Opcional
isRegex	Un array de indicadores que señalan, por cada par `find`/`replace`, si el valor de búsqueda debe tratarse como una expresión regular en lugar de una cadena literal. La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Opcional
orgId	El ID de la organización de Salesforce que realiza la solicitud. Tipo: String	Obligatorio
orgPrefix	Un espacio de nombres/prefijo corto que identifica los campos personalizados de la organización en Salesforce. Tipo: String	Obligatorio
origin	Un array que identifica los campos/columnas de origen a los que se aplica cada par `find`/`replace`. La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Obligatorio
prevRecords	Un array de registros obtenidos previamente contra los que previsualizar la transformación, en lugar de volver a consultar Salesforce. La especificación de origen deja los elementos del array sin tipar. Tipo: Array (JSON)	Opcional
ProcessKind	El tipo de proceso de preparación de datos que se está previsualizando. La especificación de origen tipa esto como una cadena simple sin enumerar los valores permitidos. Tipo: String	Obligatorio
RecordType	El objeto de Salesforce / tipo de registro al que se aplica la vista previa (por ejemplo, Account o Contact). Tipo: String	Obligatorio
replace	Un array de valores de reemplazo, emparejado posicionalmente con `find` anterior. Tipo: Array (JSON)	Obligatorio
selectedFieldName	El nombre del campo que se está previsualizando/transformando. Tipo: String	Obligatorio
sub	La reclamación de sujeto (subject) — el identificador de usuario/sesión de Salesforce que emite la solicitud. Tipo: String	Obligatorio
url	La URL base de la instancia/API de la organización de Salesforce. Tipo: String	Obligatorio
urllogin	La URL de inicio de sesión de la organización de Salesforce. Tipo: String	Obligatorio
uuidPage	Un UUID que identifica la página/sesión de la interfaz personalizada que solicita esta vista previa, utilizado para correlacionar la vista previa con una sesión de interfaz específica. Inferido únicamente a partir del nombre del campo. Tipo: String	Obligatorio

Respuesta

Si la llamada se realiza correctamente, la API devuelve un objeto JSON con las siguientes claves.

Clave	Descripción	Tipo
previewColumn	Un array de objetos que describen las columnas afectadas por la transformación previsualizada (por ejemplo, metadatos de campo de la columna previsualizada). La especificación de origen tipa cada elemento como un objeto genérico sin propiedades adicionales definidas.	array[object]
previewValues	Un array de objetos que contiene los valores de registro previsualizados tras aplicar la transformación configurada de buscar/reemplazar/regex, sin confirmar ningún cambio. La especificación de origen tipa cada elemento como un objeto genérico sin propiedades adicionales definidas.	array[object]

Ejemplo de respuesta

Ejemplo de respuesta de vista previa de preparación de datos

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

Errores

Probar la API

Abrir consola

API DQE One — Trabajos y auditorías

newJob

Solicitud

Ejemplos de código

Parámetros

Encabezados

Parámetros del cuerpo

Respuesta

Ejemplo de respuesta

Errores

Probar la API

launchAudit

Solicitud

Ejemplos de código

Parámetros

Encabezados

Parámetros del cuerpo

Respuesta

Ejemplo de respuesta

Errores

Probar la API

previewDataPrep

Solicitud

Ejemplos de código

Parámetros

Encabezados

Parámetros del cuerpo

Respuesta

Ejemplo de respuesta

Errores

Probar la API

Ver también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente