Zum Inhalt springen
Developer

CustomerAppHomeWidgetDefault

Einstellungen / CustomerAppHomeWidgetDefault

System und Einstellungen6 EndpunkteSettings / CustomerAppHomeWidgetDefault

Liefert eine Liste aller CustomerAppHomeWidgetDefault-Einträge.

GET/api/settings/home_widget_default

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

CustomerAppHomeWidgetDefault neu anlegen

POST/api/settings/home_widget_default

Request-Body application/json

  • dataCustomerAppHomeWidgetDefault
    Felder anzeigen (16)
    • idinteger

      Primärschlüssel des Standard-Widgets. Interne ID.

    • widget_typestring

      Art des Widgets.

    • titlestring

      Titel des Widgets.

    • grid_xinteger

      Spalte des Widgets im Raster.

    • grid_yinteger

      Zeile des Widgets im Raster.

    • span_xinteger

      Anzahl der Spalten, über die sich das Widget erstreckt.

    • span_yinteger

      Anzahl der Zeilen, über die sich das Widget erstreckt.

    • widget_configstring

      Konfiguration des Widgets, als JSON gespeichert.

    • sort_orderinteger

      Position des Widgets in der Liste.

    • scopestring

      Scope, für den das Standard-Widget gilt.

    • availableboolean

      Ob das Widget ausgewählt werden kann.

    • default_widgetboolean

      Ob das Widget standardmäßig angezeigt wird.

    • enabledboolean

      Ob das Widget aktiviert ist.

    • 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/home_widget_default \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "widget_type": "string",
    "grid_x": 1,
    "grid_y": 1,
    "span_x": 1
  }
}
'

Liefert einen einzelnen CustomerAppHomeWidgetDefault-Eintrag.

GET/api/settings/home_widget_default/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

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

Aktualisiert einen vorhandenen CustomerAppHomeWidgetDefault-Eintrag.

PUT/api/settings/home_widget_default/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppHomeWidgetDefault
    Felder anzeigen (16)
    • idinteger

      Primärschlüssel des Standard-Widgets. Interne ID.

    • widget_typestring

      Art des Widgets.

    • titlestring

      Titel des Widgets.

    • grid_xinteger

      Spalte des Widgets im Raster.

    • grid_yinteger

      Zeile des Widgets im Raster.

    • span_xinteger

      Anzahl der Spalten, über die sich das Widget erstreckt.

    • span_yinteger

      Anzahl der Zeilen, über die sich das Widget erstreckt.

    • widget_configstring

      Konfiguration des Widgets, als JSON gespeichert.

    • sort_orderinteger

      Position des Widgets in der Liste.

    • scopestring

      Scope, für den das Standard-Widget gilt.

    • availableboolean

      Ob das Widget ausgewählt werden kann.

    • default_widgetboolean

      Ob das Widget standardmäßig angezeigt wird.

    • enabledboolean

      Ob das Widget aktiviert ist.

    • 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/home_widget_default/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "widget_type": "string",
    "grid_x": 1,
    "grid_y": 1,
    "span_x": 1
  }
}
'

Aktualisiert einen vorhandenen CustomerAppHomeWidgetDefault-Eintrag.

PATCH/api/settings/home_widget_default/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataCustomerAppHomeWidgetDefault
    Felder anzeigen (16)
    • idinteger

      Primärschlüssel des Standard-Widgets. Interne ID.

    • widget_typestring

      Art des Widgets.

    • titlestring

      Titel des Widgets.

    • grid_xinteger

      Spalte des Widgets im Raster.

    • grid_yinteger

      Zeile des Widgets im Raster.

    • span_xinteger

      Anzahl der Spalten, über die sich das Widget erstreckt.

    • span_yinteger

      Anzahl der Zeilen, über die sich das Widget erstreckt.

    • widget_configstring

      Konfiguration des Widgets, als JSON gespeichert.

    • sort_orderinteger

      Position des Widgets in der Liste.

    • scopestring

      Scope, für den das Standard-Widget gilt.

    • availableboolean

      Ob das Widget ausgewählt werden kann.

    • default_widgetboolean

      Ob das Widget standardmäßig angezeigt wird.

    • enabledboolean

      Ob das Widget aktiviert ist.

    • 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/home_widget_default/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "title": "Beispiel",
    "widget_type": "string",
    "grid_x": 1,
    "grid_y": 1,
    "span_x": 1
  }
}
'

Eine CustomerAppHomeWidgetDefault löschen (Soft Delete)

DELETE/api/settings/home_widget_default/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

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