CustomerAppHomeWidgetDefault
Returns a list of all CustomerAppHomeWidgetDefault entries
GET/api/settings/home_widget_default
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/settings/home_widget_default \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/settings/home_widget_default', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/home_widget_default_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await HomeWidgetDefaultController.getAll();
if (result.success) {
print(result.data);
}Add a new CustomerAppHomeWidgetDefault
POST/api/settings/home_widget_default
Request body application/json
dataCustomerAppHomeWidgetDefaultShow fields (16)
idintegerPrimary key of the default widget. Internal ID.
widget_typestringType of the widget.
titlestringTitle of the widget.
grid_xintegerColumn of the widget in the grid.
grid_yintegerRow of the widget in the grid.
span_xintegerNumber of columns the widget spans.
span_yintegerNumber of rows the widget spans.
widget_configstringConfiguration of the widget, stored as JSON.
sort_orderintegerPosition of the widget in the list.
scopestringScope the default widget applies to.
availablebooleanWhether the widget can be selected.
default_widgetbooleanWhether the widget is shown by default.
enabledbooleanWhether the widget is enabled.
deletedbooleanThis property is used to mark an entity as deleted / archived
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
Responses
default
curl --request POST \
--url https://your-instance.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
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
id: 42,
title: 'Beispiel',
widget_type: 'string',
grid_x: 1,
grid_y: 1,
span_x: 1
}
})
};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default"
payload = { "data": {
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/settings/home_widget_default', [
'body' => '{"data":{"id":42,"title":"Beispiel","widget_type":"string","grid_x":1,"grid_y":1,"span_x":1}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default"
payload := strings.NewReader("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/home_widget_default_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/home_widget_config.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await HomeWidgetDefaultController.post(HomeWidgetConfig.fromJson({
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
}));
if (result.success) {
print(result.data);
}Returns a single CustomerAppHomeWidgetDefault entry.
GET/api/settings/home_widget_default/{identifier}
Path parameters
identifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/settings/home_widget_default/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/settings/home_widget_default/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/home_widget_default_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await HomeWidgetDefaultController.get('42');
if (result.success) {
print(result.data);
}Updates an existing CustomerAppHomeWidgetDefault entry.
PUT/api/settings/home_widget_default/{identifier}
Path parameters
identifierrequiredstring |
Request body application/json
dataCustomerAppHomeWidgetDefaultShow fields (16)
idintegerPrimary key of the default widget. Internal ID.
widget_typestringType of the widget.
titlestringTitle of the widget.
grid_xintegerColumn of the widget in the grid.
grid_yintegerRow of the widget in the grid.
span_xintegerNumber of columns the widget spans.
span_yintegerNumber of rows the widget spans.
widget_configstringConfiguration of the widget, stored as JSON.
sort_orderintegerPosition of the widget in the list.
scopestringScope the default widget applies to.
availablebooleanWhether the widget can be selected.
default_widgetbooleanWhether the widget is shown by default.
enabledbooleanWhether the widget is enabled.
deletedbooleanThis property is used to mark an entity as deleted / archived
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
Responses
default
curl --request PUT \
--url https://your-instance.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
}
}
'const options = {
method: 'PUT',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
id: 42,
title: 'Beispiel',
widget_type: 'string',
grid_x: 1,
grid_y: 1,
span_x: 1
}
})
};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
payload = { "data": {
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/settings/home_widget_default/42', [
'body' => '{"data":{"id":42,"title":"Beispiel","widget_type":"string","grid_x":1,"grid_y":1,"span_x":1}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default/42")
.put(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
payload := strings.NewReader("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/home_widget_default_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/home_widget_config.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await HomeWidgetDefaultController.put(HomeWidgetConfig.fromJson({
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
}));
if (result.success) {
print(result.data);
}Updates an existing CustomerAppHomeWidgetDefault entry.
PATCH/api/settings/home_widget_default/{identifier}
Path parameters
identifierrequiredstring |
Request body application/json
dataCustomerAppHomeWidgetDefaultShow fields (16)
idintegerPrimary key of the default widget. Internal ID.
widget_typestringType of the widget.
titlestringTitle of the widget.
grid_xintegerColumn of the widget in the grid.
grid_yintegerRow of the widget in the grid.
span_xintegerNumber of columns the widget spans.
span_yintegerNumber of rows the widget spans.
widget_configstringConfiguration of the widget, stored as JSON.
sort_orderintegerPosition of the widget in the list.
scopestringScope the default widget applies to.
availablebooleanWhether the widget can be selected.
default_widgetbooleanWhether the widget is shown by default.
enabledbooleanWhether the widget is enabled.
deletedbooleanThis property is used to mark an entity as deleted / archived
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
Responses
default
curl --request PATCH \
--url https://your-instance.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
}
}
'const options = {
method: 'PATCH',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
id: 42,
title: 'Beispiel',
widget_type: 'string',
grid_x: 1,
grid_y: 1,
span_x: 1
}
})
};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
payload = { "data": {
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/settings/home_widget_default/42', [
'body' => '{"data":{"id":42,"title":"Beispiel","widget_type":"string","grid_x":1,"grid_y":1,"span_x":1}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default/42")
.patch(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
payload := strings.NewReader("{\"data\":{\"id\":42,\"title\":\"Beispiel\",\"widget_type\":\"string\",\"grid_x\":1,\"grid_y\":1,\"span_x\":1}}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'dart:convert';
import 'package:http/http.dart' as http;
final response = await http.patch(
Uri.parse('https://your-instance.iw-erp.de/api/settings/home_widget_default/42'),
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: jsonEncode({
"data": {
"id": 42,
"title": "Beispiel",
"widget_type": "string",
"grid_x": 1,
"grid_y": 1,
"span_x": 1
}
}),
);
print(response.body);Delete a CustomerAppHomeWidgetDefault (soft delete)
DELETE/api/settings/home_widget_default/{identifier}
Path parameters
identifierrequiredstring |
Responses
default
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/settings/home_widget_default/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/settings/home_widget_default/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/settings/home_widget_default/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/settings/home_widget_default/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/settings/home_widget_default/42")
.delete(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/settings/home_widget_default/42"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/home_widget_default_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await HomeWidgetDefaultController.delete('42');
if (result.success) {
print(result.data);
}