Configuration of sections in menu

Web Portal provides an API to manage sections displayed in the Web Portal menu. The management of sections is restricted to users with the "Web Portal Operator" role. Sections can be added, deleted and modified. Web Portal internally maintains a list of default sections. Default sections cannot be deleted and editing is restricted to the "navigationPriority" field.

Url	Method	Description	Request Body	Response Body
api/v1/navigationSections	GET	Gets all sections		{"items": NavigationSection[]}
api/v1/navigationSections	POST	Adds a new section	NavigationSection	NavigationSection
api/v1/navigationSections/{sectionId}	PATCH	Updates specific fields of a section	NavigationSection	NavigationSection
api/v1/navigationSections/{sectionId}	DELETE	Deletes a section

Url

Method

Description

Request Body

Response Body

api/v1/navigationSections

GET

Gets all sections

{"items": NavigationSection[]}

api/v1/navigationSections

POST

Adds a new section

NavigationSection

api/v1/navigationSections/{sectionId}

PATCH

Updates specific fields of a section

NavigationSection

api/v1/navigationSections/{sectionId}

DELETE

Deletes a section

NavigationSection

Property	Description	Type	Required
sectionId	Unique identifier of the section	String (255)	Yes
title	Title of the section which will be displayed in the Menu. Additional translations for the title can be provided as part of the localization object	String (255)	No
navigationPriority	A number that can be assigned to a section that controls the ordering of sections. Sections with lower values will appear first in the menu.	Number	No
localization	Provide further translations for properties on the same level e.g. title.	Object	No

Property

Description

Type

Required

sectionId

Unique identifier of the section

String (255)

Yes

title

Title of the section which will be displayed in the Menu. Additional translations for the title can be provided as part of the localization object

String (255)

navigationPriority

A number that can be assigned to a section that controls the ordering of sections. Sections with lower values will appear first in the menu.

Number

localization

Provide further translations for properties on the same level e.g. title.

Object

NavigationSection example

{
    "sectionId"; "section1",
    "title": "Secton 1",
    "navigationPriority": 10,
    "localization": {
        "title": {
            "de": "Abschnitt 1"
        }
    }
}