Channel Developers

Property

Description

Method

GET

Path

/open/v1/spaces/$me/nav-nodes/$all

Accept

-

Content-Type

application/json

Description

Loads all navigation nodes in the space's navigation tree.

  • Request

    • Query (empty)

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

GET

Path

/open/v1/spaces/$me/nav-nodes/{navNodeId}/$path

Accept

-

Content-Type

application/json

Description

View the path from the root to the requested node (specified by node ID) in the navigation tree.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

GET

Path

/open/v1/spaces/$me/nav-nodes/${entityType}s/{entityId}/$path

Accept

-

Content-Type

application/json

Description

View the path from the root to the requested node (specified by the attached entity type and ID) in the navigation tree. Allowed values for entity types:articles or categories.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

GET

Path

/open/v1/spaces/$me/nav-nodes/{navNodeId}/$children

Accept

-

Content-Type

application/json

Description

View the requested navigation node (specified by node ID) and its direct children nodes.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

`GET`

Path

/open/v1/spaces/$me/nav-nodes/${entityType}s/{entityId}/$children

Accept

-

Content-Type

application/json

Description

View the requested navigation node (specified by the attached entity type and ID) and its direct children nodes.

Allowed values for entity types:articles or categories.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript