Definitionen dynamischer Attribute auflisten

Liefert die benutzerdefinierten Felder, die für Mitarbeiter, Projekte, Kunden und die übrigen Entitätsarten konfiguriert sind, denen ein dynamisches Attribut zugeordnet werden kann.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

Request

GET /api/v1/dynamic-attributes

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/dynamic-attributes' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.

Response

{
  "data": [
    {
      "id": "string",
      "name": "EU",
      "description": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "es": "string",
        "pl": "string"
      },
      "note": "Familienurlaub",
      "placeholder": "string",
      "position": 1,
      "is_active": true,
      "constraints": {},
      "type": {},
      "kind": {},
      "options": {}
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

Name
id
Type
string
Description
Eindeutige ID der Attributdefinition.
Name
name
Type
string
Description
Bezeichnung dieses Attributs, wird überall angezeigt, wo es eingegeben oder dargestellt wird.
Name
description
Type
object, nullable
Description
Erläuterung, was dieses Attribut erfasst; wird als Hilfetext neben dem Feld angezeigt.
Name
description.de
Type
string, nullable
Description
Name
description.en
Type
string
Description
Name
description.fr
Type
string
Description
Name
description.es
Type
string
Description
Name
description.pl
Type
string
Description
Name
note
Type
string, nullable
Description
Interne Notiz zu dieser Definition, wird der Person, die den Wert eingibt, nicht angezeigt.
Name
placeholder
Type
string, nullable
Description
Platzhaltertext, der im leeren Eingabefeld dieses Attributs angezeigt wird.
Name
position
Type
integer
Description
Sortierposition dieser Definition unter den anderen Attributen derselben Art.
Name
is_active
Type
boolean
Description
Ob diese Definition derzeit aktiv ist und zur Verwendung angeboten wird.
Name
constraints
Type
object, nullable
Description
Validierungsregeln für einen für dieses Attribut eingegebenen Wert, z. B. Pflichtfeld oder ein numerischer Wertebereich.
Name
type
Type
object, nullable
Description
Datentyp des Attributwerts, z. B. Text, Zahl, Datum oder Optionen.
Name
kind
Type
object, nullable
Description
Art der Entität, der dieses Attribut zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.
Name
options
Type
object, nullable
Description
Die auswählbaren Optionswerte. Nur enthalten bei Definitionen vom Typ OPTIONS.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Dynamische Attribute GET Definition eines dynamischen Attributs abrufen