Zum Hauptinhalt springen
GET
/
knowledgeSourceStructure
Get the knowledge source structure
curl --request GET \
  --url https://demo.enneo.ai/api/mind/knowledgeSourceStructure \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "Fragen",
    "type": "faq",
    "description": "Allgemeine Fragen",
    "parent": 0,
    "articleId": 123,
    "source": "<string>",
    "excluded": true,
    "teams": [
      1,
      5
    ],
    "access": {
      "blocked": true,
      "blockedItems": [
        {
          "id": 42,
          "kind": "article"
        },
        {
          "id": 57,
          "kind": "folder"
        }
      ]
    },
    "children": [
      {
        "id": 2,
        "name": "Allgemeine Fragen",
        "parent": 1,
        "teams": [],
        "access": {
          "blocked": true,
          "blockedItems": [
            {
              "id": 42,
              "kind": "article"
            },
            {
              "id": 57,
              "kind": "folder"
            }
          ]
        },
        "children": [
          {}
        ]
      }
    ]
  }
]

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

​
withExcluded
boolean
Standard:false

When true, include website tree nodes whose source matches the parent connector's excludePaths and tag each website node with excluded: true|false. When false (default) or omitted, those nodes are dropped from the response. Truthy values: true, 1, yes, on.

Antwort

Successful operation

​
id
integer

The unique identifier of the knowledge source structur

Beispiel:

1

​
name
string

The name of the knowledge source structure

Beispiel:

"Fragen"

​
type
string | null

The type of the knowledge source structure

Beispiel:

"faq"

​
description
string | null

The description of the knowledge source structure

Beispiel:

"Allgemeine Fragen"

​
parent
integer

The parent id of the knowledge source structure

Beispiel:

0

​
articleId
integer

For website-type nodes only — the id of one representative knowledge_sources page under this structure node, used by the FE to build the article navigation link.

​
source
string

For website-type nodes only — the source URL of the representative page.

​
excluded
boolean

For website-type nodes only, present only when ?withExcluded=true was passed. True if the node's source URL matches the parent connector's sourceConfig.excludePaths.

​
teams
integer[]

Team IDs that may access this structure node. Empty array means the node is unrestricted (visible to everyone). When non-empty, only users whose actualTeamIds intersect with this list can see the node and its descendants.

Beispiel:
[1, 5]
​
access
object

Team-ACL "access hole" indicator. Present only when this node has a problem or contains one; omitted entirely when the node is clean. A hole = the node declares team(s) that an ancestor folder forbids — because visibility is narrowing-only (reachable only by users who pass every restricted ancestor AND the node's own restriction), the access the editor granted does not actually work. To learn what is wrong, open the item and read its real teams.

​
children
object[]