Einzelne Kategorie abrufen

Sucht die Kategorie anhand ihres eindeutigen Namens und liefert ihre Konfiguration.

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

Request

GET /api/v1/categories/{name}

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

Pfad-Parameter

Name
name
Type
string
Description
Der Name der Kategorie

Response

{
  "data": {
    "name": "EU",
    "description": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "es": "string",
      "pl": "string"
    },
    "type": {
      "id": "string",
      "name": "Mitarbeiter/in"
    }
  }
}

Response-Felder

Name
name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
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
type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.
Name
type.id
Type
string
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Mitarbeiter/in", "Projekt", "Kunde", "Dokument", "Angebot", "Kontakt", "Ticket", "Ticket2", "Ticket3"

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

GET Verfügbare Kategorien zur Kennzeichnung von Datensätzen auflisten Preisgruppen