Zum Inhalt springen
Developer

CustomerAppMenuGroup

Einstellungen / CustomerAppMenuGroup

System und Einstellungen6 EndpunkteSettings / CustomerAppMenuGroup

Liefert eine Liste aller CustomerAppMenuGroup-Einträge.

GET/api/settings/customer_app_menu_group

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_group \
  --header 'x-iw-jwt-token: <TOKEN>'

CustomerAppMenuGroup neu anlegen

POST/api/settings/customer_app_menu_group

Request-Body application/json

  • dataCustomerAppMenuGroup
    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Menügruppe. Interne ID.

    • group_keystring

      Eindeutiger Schlüssel der Menügruppe.

    • titlestring

      Titel der Menügruppe, die in der App angezeigt wird.

    • sort_orderinteger

      Position der Gruppe im Menü.

    • visibility_rulestring

      Regel, die bestimmt, wann die Gruppe sichtbar ist.

    • menu_itemsarray<CustomerAppMenuItem2>

      Menüeinträge in der Gruppe.

    • 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_group \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "group_key": "string",
    "sort_order": 1,
    "visibility_rule": "string",
    "deleted": true
  }
}
'

Liefert einen einzelnen CustomerAppMenuGroup-Eintrag.

GET/api/settings/customer_app_menu_group/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

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

Aktualisiert einen vorhandenen CustomerAppMenuGroup-Eintrag.

PUT/api/settings/customer_app_menu_group/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppMenuGroup
    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Menügruppe. Interne ID.

    • group_keystring

      Eindeutiger Schlüssel der Menügruppe.

    • titlestring

      Titel der Menügruppe, die in der App angezeigt wird.

    • sort_orderinteger

      Position der Gruppe im Menü.

    • visibility_rulestring

      Regel, die bestimmt, wann die Gruppe sichtbar ist.

    • menu_itemsarray<CustomerAppMenuItem2>

      Menüeinträge in der Gruppe.

    • 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_group/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "group_key": "string",
    "sort_order": 1,
    "visibility_rule": "string",
    "deleted": true
  }
}
'

Aktualisiert einen vorhandenen CustomerAppMenuGroup-Eintrag.

PATCH/api/settings/customer_app_menu_group/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppMenuGroup
    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Menügruppe. Interne ID.

    • group_keystring

      Eindeutiger Schlüssel der Menügruppe.

    • titlestring

      Titel der Menügruppe, die in der App angezeigt wird.

    • sort_orderinteger

      Position der Gruppe im Menü.

    • visibility_rulestring

      Regel, die bestimmt, wann die Gruppe sichtbar ist.

    • menu_itemsarray<CustomerAppMenuItem2>

      Menüeinträge in der Gruppe.

    • 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_group/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "group_key": "string",
    "sort_order": 1,
    "visibility_rule": "string",
    "deleted": true
  }
}
'

Eine CustomerAppMenuGroup löschen (Soft Delete)

DELETE/api/settings/customer_app_menu_group/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

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