Erzeugt ein Dokument mit Metadaten (JobDocument). Die DocumentGUID wird in der Antwort zurückgegeben. Das Dokument erstellt noch keine Datei oder ein Miniaturbild, diese können mit Dokument-Ressource einstellen, Dokument-Metadaten einstellen und
Dokument-Miniaturansicht einstellen
.
URL:
POST: http://api.aurelon.com/api/v2/document/create
Kopfzeilen anfordern:
Inhalt-Typ : anwendung/json
MisKey : siehe Authentifizierung
Anfrage Körper:
JSON-Objekt enthält:
-
- DokumentGUID – optional – die Dokument-GUID, wenn angegeben, wird diese GUID verwendet und wenn ein Dokument mit dieser GUID bereits existiert, wird ein Fehler angezeigt
- Name – erforderlich – Name des Dokuments
- Abmessungen – Größe des Dokuments in Einheiten, verkettet in einer Zeichenkette im folgenden Format: „{width},{height}“; diese Eigenschaft ist veraltet, verwenden Sie direkt Breite und Höhe;
- Breite – Breite des Dokuments in Einheiten
- Höhe – Höhe des Dokuments in Einheiten
- IsAsset – Markiert ein Dokument als Asset (wird nicht automatisch gelöscht)
Antwort:
Inhaltstyp application/json, der das Ergebnis der Operation enthält.
Erfolg:
200 OK : {„Message“: „Dokument erfolgreich erstellt“, „DocumentGUID“: „00000000-0000-0000-0000-00000000000000“}
Fehler:
- 400 Bad Request : {„Message“: „Ein Dokument mit dieser DocumentGUID existiert bereits“}
- 401 Unauthorised : {„Message“: „Ungültiger MisKey“}
- 401 Unerlaubt : {„Meldung“: „“MisKey“ oder „HardwareHash“, „SerialNumber“ und „ApplicationVersion“ header are required“}
- 415 Nicht unterstützter Medientyp : {„Message“: „Diese Anfrage ist nicht richtig formatiert“}
- 500 Internal Server Error : {„Message“: „Internal Server Error“}