List child display folders

Overview

List child display folders. Display operations store, validate, resolve, export, and navigate visualization documents used by operator interfaces.

When to use it

• Use it when an application needs to list child display folders.
• Use it when a user interface needs to organize, save, validate, or resolve an operational display.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/display-folders" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

[
  {
    "folder_id": "00000000-0000-4000-8000-000000000001",
    "parent_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "tx_id": 0
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to list child display folders. The documented 200 response is folders directly beneath the selected parent.

How it works

Reference

Required capability

read

Authorization scope

handler-resolved target

[
  {
    "folder_id": "00000000-0000-4000-8000-000000000001",
    "parent_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "tx_id": 0
  }
]

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/display-folders`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);