Zum Inhalt springen
Developer

CustomerAppMenuItem

Einstellungen / CustomerAppMenuItem

System und Einstellungen6 EndpunkteSettings / CustomerAppMenuItem

Liefert eine Liste aller CustomerAppMenuItem-Einträge.

GET/api/settings/customer_app_menu_item

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item \
  --header 'x-iw-jwt-token: <TOKEN>'

CustomerAppMenuItem neu anlegen

POST/api/settings/customer_app_menu_item

Request-Body application/json

  • dataCustomerAppMenuItem
    Felder anzeigen (19)
    • idinteger

      Primärschlüssel des Menüeintrags. Interne ID.

    • item_keystring

      Eindeutiger Schlüssel des Menüpunkts.

    • enabledboolean

      Ob der Menüpunkt in der App angezeigt wird.

    • titlestring

      Titel des Menüpunkts, der in der App angezeigt wird.

    • iconstring

      Symbol des Menüpunkts.

    • routestring

      Route, die der Menüpunkt öffnet.

    • item_typestring

      Art des Menüpunkts.

    • menu_groupCustomerAppMenuGroup2

      Menügruppe, zu der der Eintrag gehört.

    • sort_orderinteger

      Position des Eintrags im Menü.

    • tab_bar_enabledboolean

      Ob die Position in der Tab-Leiste angezeigt wird.

    • tab_bar_priorityinteger

      Priorität des Eintrags in der Tab-Leiste.

    • visibility_rulestring

      Regel, die bestimmt, wann die Position sichtbar ist.

    • server_constraintsstring

      Serverseitige Einschränkungen als JSON-Array. Beispiel: [{"type": "app_config", "key": "C_APP_ENABLE_FUNCTION_NEWS"}]

    • client_constraintsstring

      Clientseitige Constraint-Tags als JSON-Array. Beispiel: [{"type": "platform", "value": "web"}]

    • min_build_idinteger

      Niedrigster App-Build, für den der Eintrag angezeigt wird.

    • max_build_idinteger

      Höchste App-Build-Version, für die das Element angezeigt wird.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Antworten

default

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "item_key": "string",
    "enabled": true,
    "icon": "string",
    "route": "string"
  }
}
'

Liefert einen einzelnen CustomerAppMenuItem-Eintrag.

GET/api/settings/customer_app_menu_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Aktualisiert einen vorhandenen CustomerAppMenuItem-Eintrag.

PUT/api/settings/customer_app_menu_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppMenuItem
    Felder anzeigen (19)
    • idinteger

      Primärschlüssel des Menüeintrags. Interne ID.

    • item_keystring

      Eindeutiger Schlüssel des Menüpunkts.

    • enabledboolean

      Ob der Menüpunkt in der App angezeigt wird.

    • titlestring

      Titel des Menüpunkts, der in der App angezeigt wird.

    • iconstring

      Symbol des Menüpunkts.

    • routestring

      Route, die der Menüpunkt öffnet.

    • item_typestring

      Art des Menüpunkts.

    • menu_groupCustomerAppMenuGroup2

      Menügruppe, zu der der Eintrag gehört.

    • sort_orderinteger

      Position des Eintrags im Menü.

    • tab_bar_enabledboolean

      Ob die Position in der Tab-Leiste angezeigt wird.

    • tab_bar_priorityinteger

      Priorität des Eintrags in der Tab-Leiste.

    • visibility_rulestring

      Regel, die bestimmt, wann die Position sichtbar ist.

    • server_constraintsstring

      Serverseitige Einschränkungen als JSON-Array. Beispiel: [{"type": "app_config", "key": "C_APP_ENABLE_FUNCTION_NEWS"}]

    • client_constraintsstring

      Clientseitige Constraint-Tags als JSON-Array. Beispiel: [{"type": "platform", "value": "web"}]

    • min_build_idinteger

      Niedrigster App-Build, für den der Eintrag angezeigt wird.

    • max_build_idinteger

      Höchste App-Build-Version, für die das Element angezeigt wird.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Antworten

default

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "item_key": "string",
    "enabled": true,
    "icon": "string",
    "route": "string"
  }
}
'

Aktualisiert einen vorhandenen CustomerAppMenuItem-Eintrag.

PATCH/api/settings/customer_app_menu_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppMenuItem
    Felder anzeigen (19)
    • idinteger

      Primärschlüssel des Menüeintrags. Interne ID.

    • item_keystring

      Eindeutiger Schlüssel des Menüpunkts.

    • enabledboolean

      Ob der Menüpunkt in der App angezeigt wird.

    • titlestring

      Titel des Menüpunkts, der in der App angezeigt wird.

    • iconstring

      Symbol des Menüpunkts.

    • routestring

      Route, die der Menüpunkt öffnet.

    • item_typestring

      Art des Menüpunkts.

    • menu_groupCustomerAppMenuGroup2

      Menügruppe, zu der der Eintrag gehört.

    • sort_orderinteger

      Position des Eintrags im Menü.

    • tab_bar_enabledboolean

      Ob die Position in der Tab-Leiste angezeigt wird.

    • tab_bar_priorityinteger

      Priorität des Eintrags in der Tab-Leiste.

    • visibility_rulestring

      Regel, die bestimmt, wann die Position sichtbar ist.

    • server_constraintsstring

      Serverseitige Einschränkungen als JSON-Array. Beispiel: [{"type": "app_config", "key": "C_APP_ENABLE_FUNCTION_NEWS"}]

    • client_constraintsstring

      Clientseitige Constraint-Tags als JSON-Array. Beispiel: [{"type": "platform", "value": "web"}]

    • min_build_idinteger

      Niedrigster App-Build, für den der Eintrag angezeigt wird.

    • max_build_idinteger

      Höchste App-Build-Version, für die das Element angezeigt wird.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Antworten

default

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "item_key": "string",
    "enabled": true,
    "icon": "string",
    "route": "string"
  }
}
'

Ein CustomerAppMenuItem löschen (Soft Delete)

DELETE/api/settings/customer_app_menu_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/settings/customer_app_menu_item/42 \
  --header 'x-iw-jwt-token: <TOKEN>'