Syntax: POST /rest/v1/record/<recordKey>/attachment/<fieldName>?filename=xyz&contentid=abc&isinline=false
Dieser Aufruf erstellt einen neuen Dateianhang in einem gegebenen Feld in dem gewünschten Datensatz.
Dieser Endpunkt kann auf zwei Arten aufgerufen werden:
- als Ziel eines Form-Daten-Posts
- mit binären Rohdaten einer Datei
Bei einem Form-Daten-Post wird der Dateiname normalerweise in den Anfrage-Headern mitgesendet, so dass es nicht nötig ist, einen Dateinamen als Parameter anzugeben. Bei der binären Übertragung von Daten gibt es diesen Header gegebenenfalls nicht, so dass hier empfohlen wird den fileName-Parameter zu belegen. Wird das nicht getan, wird der Dateianhang mit einer Guid als Namen abgespeichert.
Grundsätzlich gilt aber: ist der Parameter angegeben, dann wird er auch verwendet, das heißt er kann dazu verwendet werden, den ursprünglich ausgewählten Dateinamen bei einem Form-Daten-Post zu überschreiben.
Parameter
| Name | Pflicht | Beschreibung |
|---|---|---|
| recordKey | Ja | Oid oder MigrationId eines existierenden Datensatzes (Vererbung: OrmBABase). |
| fieldName | Ja | Name des Dateianhangfelds, in dem der Dateianhang erstellt werden soll. |
| fileName | Nein | Name, der für den Dateianhang verwendet werden soll. Je nach Art des Aufrufs ist die Angabe dieses Paramters empfohlen (s. o.). |
| contentid | Nein | Content-Id des neuen Dateianhangs. Wird immer gesetzt, wenn der Paramter angegeben wird. Ist der Parameter nicht angegeben, der Typ des Dateianhangs aber ‘inline’ so wird automatisch die Oid des Anhangs für die Content-Id verwendet. |
| isinline | Nein | Erstellt einen Dateianhang mit der Content-Disposition ‘inline’ anstelle von ‘attachment’. Dies wird üblicherweise bei der Erstellung von Bildern verwendet, welche in HTML-Feldern anhand ihrer Content-Id abgerufen werden sollen, daher ist in diesem Fall die Angabe einer Content-Id empfohlen. |
Mögliche Rückgabestatus
| Status | Beschreibung |
|---|---|
| 201 Created | Der Dateianhang wurde erstellt. Informationen über den neuen Dateianhang werden im Antwortinhalt zurückgegeben. Eine URI zum Abrufen des Dateianhangs findet sich im Location-Header der Antwort. |
| 403 Forbidden | Der aktuelle Benutzer hat nicht die Berechtigung den angegebenen Datensatz zu bearbeiten. |
| 404 Not found | Der gewünschte Datensatz konnte nicht ermittelt werden. |
| 500 Internal server error |
|
Rückgabe
Der Aufruf dieses Endpunkts liefert eine JSON-Struktur mit Informationen über den erstellten Dateianhang und den zugehörigen Datensatz zurück.
Beispiel:
{
"ParentOid": "9b091e1a-a9fd-4a8d-8a5f-f2cbfbd14cce",
"ParentDisplay": "Meine Firma",
"AttachmentField": "defaultattachments",
"AttachmentOid": "9134ec3c-3ced-408c-ae45-933fc95c6f34",
"AttachmentFileName": "Konzept.docx",
"AttachmentSize": 33147,
"AttachmentInline": false
}