Synupv1
Schlüssel erstellen
v1Ressourcen/Custom Fields/getBenutzerdefinierte Feld-Definitionen auflisten

Benutzerdefinierte Feld-Definitionen auflisten

Liefert das für den angegebenen Entitätstyp (location oder client) definierte benutzerdefinierte Feldschema, in der Reihenfolge, in der es in der Benutzeroberfläche angezeigt wird.

get/api/v1/custom-fields/definitions
custom-fields:read
Query-Parameter
entityTypestring (location | client)erforderlich
Für welchen Entitätstyp das Schema aufgelistet werden soll: "location" oder "client".
Antwort
dataarray of objectoptional
idstringoptional
Eindeutige Kennung der benutzerdefinierten Feld-Definition.
entityTypestring (location | client)optional
Der Entitätstyp, für den diese Definition gilt: "location" oder "client".
keystringoptional
Unveränderlicher Slug, der dieses Feld identifiziert, abgeleitet von seinem label bei der Erstellung. Verwenden Sie dies, um das Feld beim Setzen von Werten zu referenzieren.
labelstringoptional
Das Anzeigelabel des benutzerdefinierten Feldes.
typestring (text | number | date | single_select | multi_select)optional
Der Werttyp des Feldes.
requiredbooleanoptional
Ob das Feld als erforderlich markiert ist. Dies wird von der API nicht erzwungen — es ist nur ein Hinweis für die Benutzeroberfläche.
optionsarray of stringoptional
Die auswählbaren Optionen des Feldes, für Felder des Typs single_select und multi_select. Null für andere Typen.
createdBystringoptional
Wer diese Feld-Definition erstellt hat: "user" oder "agent".
ordernumberoptional
Die Anzeigereihenfolge des Feldes relativ zu anderen Definitionen desselben Entitätstyps, niedrigste zuerst.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/custom-fields/definitions
Ihr API-Schlüssel
entityType *
{
  "data": [
    {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": false,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  ]
}