Serverlose Funktionen – Anfrage- und Antwortobjekt
Inhaltsverzeichnis
- Anfrageobjekt
- Antwortobjekt
- Statuscode
- Inhaltstyp
- Überschriften
- Textkörper
Anfrageobjekt:
Sie können das gesamte Anfrageobjekt innerhalb der Funktion mit dem Argument "crmAPIRequest" abrufen.
Angenommen, Sie haben eine Funktion erstellt und 2 Argumente definiert. Jetzt müssen Sie dieselbe Funktion in 2 verschiedenen Webhooks verwenden, von denen jeder verschiedene Arten und Mengen von Informationen enthalten kann. Einer von ihnen lädt Daten als JSON-Objekt und der andere eine CSV-Datei hoch. Nun stehen diese beiden verschiedene Arten von Daten möglicherweise nicht in einem Argument innerhalb der Funktion zur Verfügung.
In diesem Fall können Sie das Argument "crmAPIRequest" verwenden, um den entsprechenden Inhalt zu erhalten.
Das Argument crmAPIRequest kann verwendet werden, um die Daten aus den Informationen "Textkörper", "Parameter", "Überschrift" oder "Benutzer" zu erhalten. Mit diesem einzigen Argument entfällt die Notwendigkeit, mehrere Argumente innerhalb der Funktion zu erstellen, da es die Informationen aus der Anfrage dynamisch speichert und innerhalb der Funktion zur Verfügung stellt.
Hinweis:
- Sie müssen dem Argument "crmAPIRequest" keine Werte manuell übergeben. Das CRM weist das Anfrageobjekt dem Argument zu.
- Wenn dennoch ein Wert für das Argument "crmAPIRequest" übergeben wird, wird er durch die Anforderungsinformationen überschrieben.
Beispiel für die Ausgabe von POSTMAN:
Antwortobjekt:
Der Benutzer kann definieren, wie die Antwort der API ausfallen soll. Wenn der Benutzer einen bestimmten Antwortcode als Antwort der Funktion anzeigen/erhalten möchte, kann er ihn innerhalb der Funktion angeben.
Zusätzlich zu den Statuscodes kann der Benutzer auch wählen, ob er die Antwort in einem bestimmten Dateityp erhalten möchte, z. B. JSON, HTML, Text usw.
Das Element crmAPIResponse in der Funktion dient als Argument, mit dem Sie die Art und den Inhalt der Ausgabeantwort bestimmen können.
Statuscode
Es gibt nur wenige Statuscodes, die normalerweise verwendet werden, um zu erkennen, ob der API-Aufruf erfolgreich ist oder ob es sich um eine fehlerhafte Anforderung handelt. Sie können den Statuscode definieren, der für den API-Aufruf angezeigt werden soll.
Der Standardstatuscode ist 200.
Zum Einstellen des Statuscodes:
/**
Ihre Geschäftslogik hier
**/
response = Map();
// um den Statuscode auf 204 zu überschreiben.
response.put("status_code",204);
return {"crmAPIResponse":response};
Inhaltstyp
Zusätzlich zu den Statuscodes kann die Antwort, die normalerweise als JSON-Objekt angegeben wird, so eingestellt werden, dass sie in einem anderen Format erhalten wird.
Der Standardwert dieses Schlüssels ist application/json;charset=utf-8.
Um die Antwort im Textformat zu erhalten:
/**
Ihre Geschäftslogik hier
**/
response = Map();
// um den Inhaltstyp zu überschreiben; Standard ist "application/json"
response.put("Content-Type","application/text");
return {"crmAPIResponse":response};
Überschriften
Antwortüberschriften sind nützlich, um Größe und Typ der Datei/Daten zu definieren, die der API-Aufruf als Antwort ausgibt. In einigen Fällen ziehen es die Benutzer vor, die Antwortüberschriften anzuzeigen, da sie bei der Festlegung der nächsten Vorgehensweise, d. h. des nächsten API-Aufrufs, nützlich sind.
Der Standardwert dieses Schlüssels ist {"Content-Disposition", "attachment;filename=response.json"}.
Um die Antwortüberschriften zu erhalten:
/**
Ihre Geschäftslogik hier
**/
response = Map();
headers = Map();
headers.put("X-ZOHO-SOURCE","CRM");
headers.put("X-Frame-Options","SAMEORIGIN");
headers.put("X-RATELIMIT-LIMIT","60");
response.put("headers",headers);
return {"crmAPIResponse":response};
Textkörper
Der Antwort-Textkörper enthält die Informationen, die Sie an den Dritten als Antwort auf seine Anfrage senden müssen.
Der Standardwert für den Textkörper ist empty.
Um die Antwortüberschriften zu erhalten:
/**
Ihre Geschäftslogik hier
**/
response = Map();
body = "{<XML>}"
response.put("body",body);
return {"crmAPIResponse":response};