Definition eines dynamischen Attributs abrufen

Sucht die Definition anhand ihrer ID und liefert ihre vollständige Konfiguration, einschließlich der Optionsliste, sofern ihr Typ eine hat.

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

Request

GET /api/v1/dynamic-attributes/{id}

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

Pfad-Parameter

Name
id
Type
string
Description
Die ID des dynamischen Attributs

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": {}
  }
}

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.

GET Definitionen dynamischer Attribute auflisten Ordner