Preview plugin setting removal

1 parameter

plugin_setting_idintegerrequired

The integer identifier of the plugin setting to preview for removal.

1 status code

200Returns the removal preview, including the revision and affected placements.

dataobjectoptional

Error handling

The plugin_setting_id path parameter must be an integer identifying the plugin setting to preview for removal.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.removalPreview.list({ pluginSettingId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": {
    "placements": [
      {
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "device_name": "Example Name",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "impact": "removed"
      }
    ],
    "revision": "example_value"
  }
}

Request

Response

Errors