DQE One API — Custom UI Management

Custom UI Management - DQE One API

The DQE One API is the backend API exposed by the DQE One package for Salesforce. The Custom UI Management endpoints on this page reset and import the rules that drive the package's embedded custom UI for a given session.

Different from most One endpoints: both endpoints on this page authenticate with a standard Bearer JWT in the Authorization header (Authorization: Bearer {JWT_TOKEN}), not the DQE-Authorization API-key header used by most other DQE One API endpoints. See Authentication & Session for how this token is issued.

Related documentation:

DQE One API — Introduction (authentication model overview, health check)
DQE One API — Authentication & Session (how the Bearer token used by these endpoints is issued, via customUI/createTokenSession)

Jump to customUI/resetRules customUI/importRules

Reset Rules - DQE One API

Resets the custom UI rules for a given custom UI session back to their default state.

customUI/resetRules

Jump to Parameters Response Example Errors ▶ Test the API

Request

Send a JSON body to this endpoint with the Authorization header set to a Bearer token.

Different from most One endpoints: this endpoint (and its sibling, customUI/importRules) authenticates with a standard Bearer JWT in the Authorization header (Authorization: Bearer {JWT_TOKEN}), not the DQE-Authorization API-key header used by most other DQE One API endpoints. See Authentication & Session for how this token is issued.

{DOMAIN} is the domain of the server where your organization's own instance of the DQE One backend is installed — since this backend runs in your own infrastructure, this value is determined by your deployment, not issued by DQE.

POSThttps://{DOMAIN}/customUI/resetRules

Code examples

Reset the custom UI rules for a session

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

Parameters

All fields are sent as a single JSON request body.

Note on Mandatory/Optional: the source OpenAPI specification does not declare a required array for this request body (only the body as a whole is marked required). The field below is shown as Mandatory based on this project's documentation convention — confirm actual optionality with DQE engineering before publishing.

Field	Description	Type	Mand / Opt
uuidToken	Identifier of the custom UI session token to reset the rules for — the same `uuidToken` value returned by `customUI/createTokenSession` (see Authentication & Session).	String	Mandatory

Response

Returns a JSON object confirming the outcome of the reset operation.

Key	Description	Type
status	Outcome status of the reset operation.	String

Response example

Example reset response

{
  "status": "success"
}

The source specification gives no example value for this schema. The value above is an illustrative placeholder only.

Errors

The source specification does not define any error responses (4xx/5xx) for this endpoint — only the 200 success response is documented. Confirm actual error behavior with DQE engineering before publishing.

Test the API

Click the button below to test this endpoint live in your browser.

Open console

Import Rules - DQE One API

Imports a custom UI rules payload into a given custom UI session.

customUI/importRules

Jump to Parameters Response Example Errors ▶ Test the API

Request

Send a JSON body to this endpoint with the Authorization header set to a Bearer token.

Different from most One endpoints: this endpoint (and its sibling, customUI/resetRules) authenticates with a standard Bearer JWT in the Authorization header (Authorization: Bearer {JWT_TOKEN}), not the DQE-Authorization API-key header used by most other DQE One API endpoints. See Authentication & Session for how this token is issued.

POSThttps://{DOMAIN}/customUI/importRules

Code examples

Import a custom UI rules payload into a session

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

Parameters

All fields are sent as a single JSON request body.

Note on Mandatory/Optional: the source OpenAPI specification does not declare a required array for this request body (only the body as a whole is marked required). All fields below are shown as Mandatory based on this project's documentation convention — confirm actual optionality with DQE engineering before publishing.

Field	Description	Type	Mand / Opt
uuidToken	Identifier of the custom UI session token to import the rules into — the same `uuidToken` value returned by `customUI/createTokenSession` (see Authentication & Session).	String	Mandatory
importRules	The custom UI rules payload to import. The source specification does not define the expected format of this payload — described generically here pending confirmation from DQE engineering.	String	Mandatory

Response

Returns a JSON object confirming the outcome of the import operation.

Key	Description	Type
status	Outcome status of the import operation.	String

Response example

Example import response

{
  "status": "success"
}

The source specification gives no example value for this schema. The value above is an illustrative placeholder only.

Errors

Test the API

Click the button below to test this endpoint live in your browser.

Open console

DQE One API — Custom UI Management

customUI/resetRules

Request

Code examples

Parameters

Response

Response example

Errors

Test the API

customUI/importRules

Request

Code examples

Parameters

Response

Response example

Errors

Test the API

See also

Was this article helpful?

Previous article

Next article