AdditionalUiField

Einstellungen / AdditionalUiField

System und Einstellungen5 EndpunkteSettings / AdditionalUiField

Liefert eine Liste aller AdditionalUiField-Objekte.

GET/api/settings/ui_field

Query-Parameter

`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`name`string
`entityType`string	Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person. \| Erfordert Zugriffs-Tag: SCOPE
`infoMode`string	Anzeigemodus des Infotextes des Feldes. \| Erfordert Zugriffs-Tag: SCOPE
`fieldGroup`string	Gruppe, in der das Feld auf der Detailseite angezeigt wird. \| Benötigt Zugriffsrecht: SCOPE
`fieldType`string	Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum. \| Benötigt Zugriffs-Tag: SCOPE
`fieldName`string	Technischer Name des Feldes. Wird als Schlüssel in der API verwendet. \| Benötigtes Zugriffsrecht: SCOPE
`fieldOrder`string	Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste aller AdditionalUiField-Objekte.array<AdditionalUiField>

Felder anzeigen (16)

idinteger
Primärschlüssel des zusätzlichen Feldes. Interne ID.
entity_typestring
Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
field_typestring
Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
field_groupstring
Gruppe, in der das Feld auf der Detailseite angezeigt wird.
field_requiredboolean
Das Feld muss ausgefüllt werden.
field_orderinteger
Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
field_scopestring
Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
field_access_typeinteger
Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
field_is_internalboolean
Das Feld ist nur für interne Benutzer sichtbar.
field_namestring
Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
info_modestring
Anzeigeart des Infotexts zum Feld.
field_include_in_exportboolean
Das Feld ist in Exporten enthalten.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Name der Einheit.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage

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

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/settings/ui_field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/ui_field"

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://eure-instanz.iw-erp.de/api/settings/ui_field', [
  '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://eure-instanz.iw-erp.de/api/settings/ui_field"),
  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://eure-instanz.iw-erp.de/api/settings/ui_field")
  .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://eure-instanz.iw-erp.de/api/settings/ui_field"

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/additional_ui_field_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await AdditionalUiFieldController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string",
    "field_required": true,
    "field_order": 1,
    "field_scope": "string",
    "field_access_type": 1
  }
]

AdditionalUiField neu anlegen

POST/api/settings/ui_field

Request-Body application/json

dataAdditionalUiField
Felder anzeigen (16)
- idinteger
  Primärschlüssel des zusätzlichen Feldes. Interne ID.
- entity_typestring
  Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
- field_typestring
  Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
- field_groupstring
  Gruppe, in der das Feld auf der Detailseite angezeigt wird.
- field_requiredboolean
  Das Feld muss ausgefüllt werden.
- field_orderinteger
  Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
- field_scopestring
  Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
- field_access_typeinteger
  Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
- field_is_internalboolean
  Das Feld ist nur für interne Benutzer sichtbar.
- field_namestring
  Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
- info_modestring
  Anzeigeart des Infotexts zum Feld.
- field_include_in_exportboolean
  Das Feld ist in Exporten enthalten.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200AdditionalUiField neu anlegenAdditionalUiField

Felder anzeigen (16)

idinteger
Primärschlüssel des zusätzlichen Feldes. Interne ID.
entity_typestring
Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
field_typestring
Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
field_groupstring
Gruppe, in der das Feld auf der Detailseite angezeigt wird.
field_requiredboolean
Das Feld muss ausgefüllt werden.
field_orderinteger
Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
field_scopestring
Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
field_access_typeinteger
Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
field_is_internalboolean
Das Feld ist nur für interne Benutzer sichtbar.
field_namestring
Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
info_modestring
Anzeigeart des Infotexts zum Feld.
field_include_in_exportboolean
Das Feld ist in Exporten enthalten.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Name der Einheit.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/settings/ui_field \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      field_name: 'Beispiel',
      name: 'Beispiel',
      entity_type: 'string',
      field_type: 'string',
      field_group: 'string'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/settings/ui_field', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/ui_field"

payload = { "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  } }
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://eure-instanz.iw-erp.de/api/settings/ui_field', [
  'body' => '{"data":{"id":42,"field_name":"Beispiel","name":"Beispiel","entity_type":"string","field_type":"string","field_group":"string"}}',
  '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://eure-instanz.iw-erp.de/api/settings/ui_field"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")
  {
    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,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/settings/ui_field")
  .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://eure-instanz.iw-erp.de/api/settings/ui_field"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/additional_ui_field_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/additional_ui_field.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await AdditionalUiFieldController.post(AdditionalUiField.fromJson({
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string"
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string",
  "field_required": true,
  "field_order": 1,
  "field_scope": "string",
  "field_access_type": 1
}

Liefert einen einzelnen AdditionalUiField-Eintrag.

GET/api/settings/ui_field/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes AdditionalUiField-Objekt zurück.AdditionalUiField

Felder anzeigen (16)

idinteger
Primärschlüssel des zusätzlichen Feldes. Interne ID.
entity_typestring
Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
field_typestring
Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
field_groupstring
Gruppe, in der das Feld auf der Detailseite angezeigt wird.
field_requiredboolean
Das Feld muss ausgefüllt werden.
field_orderinteger
Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
field_scopestring
Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
field_access_typeinteger
Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
field_is_internalboolean
Das Feld ist nur für interne Benutzer sichtbar.
field_namestring
Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
info_modestring
Anzeigeart des Infotexts zum Feld.
field_include_in_exportboolean
Das Feld ist in Exporten enthalten.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Name der Einheit.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage

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

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/settings/ui_field/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/additional_ui_field_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await AdditionalUiFieldController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string",
  "field_required": true,
  "field_order": 1,
  "field_scope": "string",
  "field_access_type": 1
}

Aktualisiert einen vorhandenen AdditionalUiField-Eintrag.

PUT/api/settings/ui_field/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataAdditionalUiField
Felder anzeigen (16)
- idinteger
  Primärschlüssel des zusätzlichen Feldes. Interne ID.
- entity_typestring
  Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
- field_typestring
  Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
- field_groupstring
  Gruppe, in der das Feld auf der Detailseite angezeigt wird.
- field_requiredboolean
  Das Feld muss ausgefüllt werden.
- field_orderinteger
  Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
- field_scopestring
  Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
- field_access_typeinteger
  Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
- field_is_internalboolean
  Das Feld ist nur für interne Benutzer sichtbar.
- field_namestring
  Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
- info_modestring
  Anzeigeart des Infotexts zum Feld.
- field_include_in_exportboolean
  Das Feld ist in Exporten enthalten.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200AdditionalUiField einzeln aktualisierenAdditionalUiField

Felder anzeigen (16)

idinteger
Primärschlüssel des zusätzlichen Feldes. Interne ID.
entity_typestring
Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
field_typestring
Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
field_groupstring
Gruppe, in der das Feld auf der Detailseite angezeigt wird.
field_requiredboolean
Das Feld muss ausgefüllt werden.
field_orderinteger
Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
field_scopestring
Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
field_access_typeinteger
Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
field_is_internalboolean
Das Feld ist nur für interne Benutzer sichtbar.
field_namestring
Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
info_modestring
Anzeigeart des Infotexts zum Feld.
field_include_in_exportboolean
Das Feld ist in Exporten enthalten.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Name der Einheit.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/settings/ui_field/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      field_name: 'Beispiel',
      name: 'Beispiel',
      entity_type: 'string',
      field_type: 'string',
      field_group: 'string'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/settings/ui_field/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/ui_field/42"

payload = { "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  } }
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://eure-instanz.iw-erp.de/api/settings/ui_field/42', [
  'body' => '{"data":{"id":42,"field_name":"Beispiel","name":"Beispiel","entity_type":"string","field_type":"string","field_group":"string"}}',
  '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://eure-instanz.iw-erp.de/api/settings/ui_field/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")
  {
    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,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/additional_ui_field_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/additional_ui_field.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await AdditionalUiFieldController.put(AdditionalUiField.fromJson({
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string"
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string",
  "field_required": true,
  "field_order": 1,
  "field_scope": "string",
  "field_access_type": 1
}

Aktualisiert einen vorhandenen AdditionalUiField-Eintrag.

PATCH/api/settings/ui_field/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataAdditionalUiField
Felder anzeigen (16)
- idinteger
  Primärschlüssel des zusätzlichen Feldes. Interne ID.
- entity_typestring
  Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
- field_typestring
  Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
- field_groupstring
  Gruppe, in der das Feld auf der Detailseite angezeigt wird.
- field_requiredboolean
  Das Feld muss ausgefüllt werden.
- field_orderinteger
  Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
- field_scopestring
  Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
- field_access_typeinteger
  Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
- field_is_internalboolean
  Das Feld ist nur für interne Benutzer sichtbar.
- field_namestring
  Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
- info_modestring
  Anzeigeart des Infotexts zum Feld.
- field_include_in_exportboolean
  Das Feld ist in Exporten enthalten.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200AdditionalUiField einzeln aktualisierenAdditionalUiField

Felder anzeigen (16)

idinteger
Primärschlüssel des zusätzlichen Feldes. Interne ID.
entity_typestring
Entität, zu der das Feld hinzugefügt wird, zum Beispiel Person.
field_typestring
Eingabetyp des Feldes, zum Beispiel Text, Zahl oder Datum.
field_groupstring
Gruppe, in der das Feld auf der Detailseite angezeigt wird.
field_requiredboolean
Das Feld muss ausgefüllt werden.
field_orderinteger
Sortierreihenfolge des Feldes innerhalb seiner Gruppe.
field_scopestring
Zugriffsbereich, der zum Sehen oder Bearbeiten des Feldes nötig ist.
field_access_typeinteger
Zugriffsart, die zum Sehen oder Bearbeiten des Feldes nötig ist, zum Beispiel Lesen oder Schreiben.
field_is_internalboolean
Das Feld ist nur für interne Benutzer sichtbar.
field_namestring
Technischer Name des Feldes. Wird als Schlüssel in der API verwendet.
info_modestring
Anzeigeart des Infotexts zum Feld.
field_include_in_exportboolean
Das Feld ist in Exporten enthalten.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Name der Einheit.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/settings/ui_field/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      field_name: 'Beispiel',
      name: 'Beispiel',
      entity_type: 'string',
      field_type: 'string',
      field_group: 'string'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/settings/ui_field/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/ui_field/42"

payload = { "data": {
    "id": 42,
    "field_name": "Beispiel",
    "name": "Beispiel",
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string"
  } }
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://eure-instanz.iw-erp.de/api/settings/ui_field/42', [
  'body' => '{"data":{"id":42,"field_name":"Beispiel","name":"Beispiel","entity_type":"string","field_type":"string","field_group":"string"}}',
  '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://eure-instanz.iw-erp.de/api/settings/ui_field/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")
  {
    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,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/settings/ui_field/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://eure-instanz.iw-erp.de/api/settings/ui_field/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"field_name\":\"Beispiel\",\"name\":\"Beispiel\",\"entity_type\":\"string\",\"field_type\":\"string\",\"field_group\":\"string\"}}")

	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 mit package:http (kein Controller im Package iw_erp_api)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/settings/ui_field/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "id": 42,
      "field_name": "Beispiel",
      "name": "Beispiel",
      "entity_type": "string",
      "field_type": "string",
      "field_group": "string"
    }
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "field_name": "Beispiel",
  "name": "Beispiel",
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string",
  "field_required": true,
  "field_order": 1,
  "field_scope": "string",
  "field_access_type": 1
}