Wählen Sie bei einer Seite den Typ Dateiaustausch, um Dateien herunterladen zu können.
Ressource
/rest/v5/{identifier}/{id}
identifier: Identifikator der Page
id: ID des Datei-Datensatzes
Parameter
| Parameter | Beschreibung | Mögliche Werte | optional |
|---|
| type | Der Typ gibt die Verarbeitung und Ausgabe des Downloads an. Dieser Parameter kann über die Anfrage bereitgestellt werden. | - Binary
- Die Binärdaten der Datei werden über die Schnittstelle zurückgegeben. Es wird direkt der Inhalt der Datei mit passenden Headern ausgegeben.
- PublicFilePath
- Datei wird in einem öffentlichen Verzeichnis abgelegt. Der Pfad zur Datei wird über die Schnittstelle zurückgegeben.
| nein |
| formatPresetId | Eine Id, die angegeben kann, um eine Datei anhand eines Ausgabeformates zu konvertieren und herunterzuladen.
Die Konvertierung funktioniert derzeit nur für den type "binary". | Beliebige Id (Ganzzahl) eines Ausgabeformates. | ja |
Response
Die Response ist abhängig vom übertragenen type-Parameter.
Ressource
/rest/v5/{identifier}/
identifier: Identifikator der Page
Parameter
| Parameter | Beschreibung | Mögliche Werte | optional |
|---|
| file | Die Datei, die hochgeladen werden soll. zusätzlich zum Parameter "file" muss auch der Parameter "filename" übergeben werden. Im Content-Disposition Header muss auch der filename genannt werden. | | nein |
| uploadConfig | Die Upload-Konfiguration (mamUpload), die zum Upload genutzt werden soll. Es muss ein Zielpfad definiert werden. | - Zeichenkette
- Identifier des mamUpload-Datensatzes
- Ganzzahl
- Id des mamUpload-Datensatzes
| nein |
Response
Die Response enthält im Body einen Parameter "file", der den mamFile-Datensatz im JSON Format überträgt.
| Codeblock |
|---|
| language | js |
|---|
| theme | RDark |
|---|
| title | POST Response |
|---|
| collapse | true |
|---|
|
{
"body": {
"file": {
"changeTime": 1680245367,
"createTime": 1680245367,
"environment": "",
"id": 2805,
"sortNumber": 1,
"userID": 1,
"userTable": "brandboxUser",
"decoded": true,
"decrypted": true,
"encryptionHelper": null,
"clientID": 1,
"domainID": 1,
"odm": null,
"mamFileContentHash": "d4108912609bc21549a015d98fb91da5990b73f912173693ef773322bb1873777560ff2a06f762becc0a15ce60cd5012f798756c389d8c67693de289144c9095",
"mamFileFileSize": 2265,
"mamFileImageAltText": "",
"mamFileImageName": "",
"mamFileImageTitle": "",
"mamFileIsPublic": false,
"mamFileIsRenderable": true,
"renderAttempts": 0,
"mamFileMetaData": "",
"mamFileMimeType": "image\/png",
"mamFileOriginalFileName": "700.png",
"mamFilePath": "share\/public\/client-1\/domain-1\/rest-upload\/user-brandboxUser-1\/700_2.png",
"mamFileResDpi": 72,
"mamFileResX": 700,
"mamFileResY": 400,
"mamFolderID": 2660
}
},
"code": 0,
"message": "",
"extra": []
} |
Request
Ein Request zum Upload könnte folgendermaßen aussehen.
| Codeblock |
|---|
| language | php |
|---|
| theme | RDark |
|---|
| title | POST Request |
|---|
| collapse | true |
|---|
|
POST https://{{host}}/rest/v5/FileExchange
Accept: application/x-www-form-urlencoded
Content-Type: multipart/form-data; boundary=WebAppBoundary
Authorization: {{access_token}}
--WebAppBoundary
Content-Disposition: form-data; name="uploadConfig"
Content-Type: text/plain
194
--WebAppBoundary
Content-Disposition: form-data; name="file"; filename="Image.png";
Content-Type: image/png
< PathToImage/Image.png
--WebAppBoundary-- |
Weitere Funktionen
sind nicht implementiert.