DQE One API — Verwaltung der benutzerdefinierten Oberfläche

Verwaltung der benutzerdefinierten Oberfläche - DQE One API

Die DQE One API ist die Backend-API, die vom DQE One-Paket für Salesforce bereitgestellt wird. Die Endpunkte zur Verwaltung der benutzerdefinierten Oberfläche auf dieser Seite setzen die Regeln zurück, die die in das Paket eingebettete benutzerdefinierte Oberfläche für eine bestimmte Sitzung steuern, und importieren sie.

Anders als bei den meisten One-Endpunkten: Beide Endpunkte auf dieser Seite authentifizieren sich mit einem Standard-Bearer-JWT im Authorization-Header (Authorization: Bearer {JWT_TOKEN}), nicht mit dem DQE-Authorization-API-Schlüssel-Header, der von den meisten anderen DQE One API-Endpunkten verwendet wird. Siehe Authentifizierung & Sitzung, um zu erfahren, wie dieses Token ausgestellt wird.

Verwandte Dokumentation:

DQE One API — Einführung (Übersicht über das Authentifizierungsmodell, Verfügbarkeitsprüfung)
DQE One API — Authentifizierung & Sitzung (wie das von diesen Endpunkten verwendete Bearer-Token über customUI/createTokenSession ausgestellt wird)

Direkt zu customUI/resetRules customUI/importRules

Regeln zurücksetzen - DQE One API

Setzt die Regeln der benutzerdefinierten Oberfläche für eine bestimmte Custom-UI-Sitzung auf ihren Standardzustand zurück.

customUI/resetRules

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie an diesen Endpunkt einen JSON-Body mit dem Authorization-Header, der auf ein Bearer-Token gesetzt ist.

Anders als bei den meisten One-Endpunkten: Dieser Endpunkt (und sein Gegenstück, customUI/importRules) authentifiziert sich mit einem Standard-Bearer-JWT im Authorization-Header (Authorization: Bearer {JWT_TOKEN}), nicht mit dem DQE-Authorization-API-Schlüssel-Header, der von den meisten anderen DQE One API-Endpunkten verwendet wird. Siehe Authentifizierung & Sitzung, um zu erfahren, wie dieses Token ausgestellt wird.

{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 läuft, wird dieser Wert durch Ihre Bereitstellung festgelegt und nicht von DQE vergeben.

POSThttps://{DOMAIN}/customUI/resetRules

Codebeispiele

Die Regeln der benutzerdefinierten Oberfläche für eine Sitzung zurücksetzen

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/resetRules" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000"
}'

fetch("https://{DOMAIN}/customUI/resetRules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    uuidToken: "550e8400-e29b-41d4-a716-446655440000"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/resetRules",
    headers={
        "Authorization": "Bearer {JWT_TOKEN}",
    },
    json={
        "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
    },
)
print(response.json())

<?php
$data = [
    'uuidToken' => '550e8400-e29b-41d4-a716-446655440000',
];

$ch = curl_init("https://{DOMAIN}/customUI/resetRules");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {JWT_TOKEN}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/customUI/resetRules', {
  uuidToken: '550e8400-e29b-41d4-a716-446655440000'
}, {
  headers: {
    'Authorization': 'Bearer {JWT_TOKEN}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/resetRules"))
    .header("Authorization", "Bearer {JWT_TOKEN}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

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

using var client = new HttpClient();

var json = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/resetRules");
request.Headers.Add("Authorization", "Bearer {JWT_TOKEN}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

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

func main() {
    body := []byte(`{"uuidToken":"550e8400-e29b-41d4-a716-446655440000"}`)

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

    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

Alle Felder werden als ein einzelner JSON-Request-Body gesendet.

Hinweis zu Pflicht/Optional: Die Quell-OpenAPI-Spezifikation deklariert für diesen Request-Body kein required-Array (nur der Body als Ganzes ist als erforderlich markiert). Das unten stehende Feld wird gemäß der Dokumentationskonvention dieses Projekts als Pflicht angezeigt — die tatsächliche Optionalität vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

Feld	Beschreibung	Typ	Pflicht / Opt.
uuidToken	Kennung des Custom-UI-Sitzungs-Tokens, für das die Regeln zurückgesetzt werden sollen — derselbe `uuidToken`-Wert, der von `customUI/createTokenSession` zurückgegeben wird (siehe Authentifizierung & Sitzung).	String	Pflicht

Antwort

Gibt ein JSON-Objekt zurück, das das Ergebnis des Reset-Vorgangs bestätigt.

Schlüssel	Beschreibung	Typ
status	Ergebnisstatus des Reset-Vorgangs.	String

Antwortbeispiel

Beispiel einer Reset-Antwort

{
  "status": "success"
}

Die Quellspezifikation gibt keinen example-Wert für dieses Schema an. Der obige Wert ist lediglich ein veranschaulichender Platzhalter.

Fehler

Die Quellspezifikation definiert für diesen Endpunkt keine Fehlerantworten (4xx/5xx) — nur die Erfolgsantwort 200 ist dokumentiert. Das tatsächliche Fehlerverhalten vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Regeln importieren - DQE One API

Importiert eine Regel-Payload der benutzerdefinierten Oberfläche in eine bestimmte Custom-UI-Sitzung.

customUI/importRules

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie an diesen Endpunkt einen JSON-Body mit dem Authorization-Header, der auf ein Bearer-Token gesetzt ist.

Anders als bei den meisten One-Endpunkten: Dieser Endpunkt (und sein Gegenstück, customUI/resetRules) authentifiziert sich mit einem Standard-Bearer-JWT im Authorization-Header (Authorization: Bearer {JWT_TOKEN}), nicht mit dem DQE-Authorization-API-Schlüssel-Header, der von den meisten anderen DQE One API-Endpunkten verwendet wird. Siehe Authentifizierung & Sitzung, um zu erfahren, wie dieses Token ausgestellt wird.

POSThttps://{DOMAIN}/customUI/importRules

Codebeispiele

Eine Regel-Payload der benutzerdefinierten Oberfläche in eine Sitzung importieren

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/importRules" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
  "importRules": "{RULES_PAYLOAD}"
}'

fetch("https://{DOMAIN}/customUI/importRules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    uuidToken: "550e8400-e29b-41d4-a716-446655440000",
    importRules: "{RULES_PAYLOAD}"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/importRules",
    headers={
        "Authorization": "Bearer {JWT_TOKEN}",
    },
    json={
        "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
        "importRules": "{RULES_PAYLOAD}",
    },
)
print(response.json())

<?php
$data = [
    'uuidToken' => '550e8400-e29b-41d4-a716-446655440000',
    'importRules' => '{RULES_PAYLOAD}',
];

$ch = curl_init("https://{DOMAIN}/customUI/importRules");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {JWT_TOKEN}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/customUI/importRules', {
  uuidToken: '550e8400-e29b-41d4-a716-446655440000',
  importRules: '{RULES_PAYLOAD}'
}, {
  headers: {
    'Authorization': 'Bearer {JWT_TOKEN}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\",\"importRules\":\"{RULES_PAYLOAD}\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/importRules"))
    .header("Authorization", "Bearer {JWT_TOKEN}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

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

using var client = new HttpClient();

var json = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\",\"importRules\":\"{RULES_PAYLOAD}\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/importRules");
request.Headers.Add("Authorization", "Bearer {JWT_TOKEN}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

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

func main() {
    body := []byte(`{"uuidToken":"550e8400-e29b-41d4-a716-446655440000","importRules":"{RULES_PAYLOAD}"}`)

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

    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

Alle Felder werden als ein einzelner JSON-Request-Body gesendet.

Hinweis zu Pflicht/Optional: Die Quell-OpenAPI-Spezifikation deklariert für diesen Request-Body kein required-Array (nur der Body als Ganzes ist als erforderlich markiert). Alle unten stehenden Felder werden gemäß der Dokumentationskonvention dieses Projekts als Pflicht angezeigt — die tatsächliche Optionalität vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

Feld	Beschreibung	Typ	Pflicht / Opt.
uuidToken	Kennung des Custom-UI-Sitzungs-Tokens, in das die Regeln importiert werden sollen — derselbe `uuidToken`-Wert, der von `customUI/createTokenSession` zurückgegeben wird (siehe Authentifizierung & Sitzung).	String	Pflicht
importRules	Die zu importierende Regel-Payload der benutzerdefinierten Oberfläche. Die Quellspezifikation definiert das erwartete Format dieser Payload nicht — hier allgemein beschrieben, bis eine Bestätigung durch das DQE-Engineering-Team vorliegt.	String	Pflicht

Antwort

Gibt ein JSON-Objekt zurück, das das Ergebnis des Import-Vorgangs bestätigt.

Schlüssel	Beschreibung	Typ
status	Ergebnisstatus des Import-Vorgangs.	String

Antwortbeispiel

Beispiel einer Import-Antwort

{
  "status": "success"
}

Die Quellspezifikation gibt keinen example-Wert für dieses Schema an. Der obige Wert ist lediglich ein veranschaulichender Platzhalter.

Fehler

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

DQE One API — Verwaltung der benutzerdefinierten Oberfläche

customUI/resetRules

Anfrage

Codebeispiele

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

customUI/importRules

Anfrage

Codebeispiele

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel