Speichern eines neuen DMS-Objektes ohne Benutzerinteraktion
Sie können ein neues DMS-Objekt automatisiert im d.3-Repository speichern, ohne dass ein Anwender eine Aktion durchführen muss. Beim Speichern ohne Benutzerinteraktion werden keine Validate
-Hooks in d.3 server ausgeführt. Grundvoraussetzung für das Durchführen der Aktion sind die Zuordnungen (Mappings). Im Kapitel Grundlegendes zu Zuordnungen (Mappings) finden Sie Basisinformationen, die Ihnen das Erstellen von Zuordnungen erleichtern.
Um ein neues DMS-Objekt zu speichern, müssen Sie folgende Schritte durchführen:
Ermitteln der URL zu einem Repository
Ermitteln der Linkrelation für die Ablage eines neuen eines DMS-Objektes
Bereitstellen der zu speichernden Datei (optional)
Aufrufen der URL zur Ablage eines neuen DMS-Objektes
Ermitteln der URL zu einem Repository
Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln.
Ermitteln der Linkrelation für die Ablage eines neuen DMS-Objektes
Rufen Sie die URL zu einem Repository wie folgt auf:
Request
GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27 Accept: application/hal+json
Das JSON-Objekt zu einem Repository enthält die Linkrelation dmsobjectwithmapping
.
Response
{ "_links": { "dmsobjectwithmapping": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/{dmsobjectid}{?sourceid}", "templated":true } }, "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27" }
Die Werte dmsobjectid
und sourceid
sind für das Speichern nicht relevant. Daher füllen Sie diese beim Ausführen des Templates nicht aus.
Bereitstellen der zu speichernden Datei (optional)
Im Kapitel Bereitstellen von Dateien erfahren Sie, wie Sie contentUri
oder contentLocationUri
erhalten. Diese Parameter benötigen Sie zum Speichern eines neuen DMS-Objektes.
Wenn Sie eine Akte erstellen möchten, ist das Bereitstellen der Datei nicht erforderlich.
Aufrufen der URL zur Ablage eines neuen DMS-Objektes
Führen Sie eine HTTP POST
-Anforderung mit den benötigten Eigenschaften als Body
auf diese URL aus.
Request
POST /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m Origin: https://baseuri Accept: application/hal+json Content-Type: application/hal+json { "filename": "myfile.txt", "sourceCategory": "mycategory1_ID", "sourceId": "/myapp/sources/mysource", "contentLocationUri": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/blob/chunk/2018-01-01_temp_master_file_user1_44f7-95a6-58b8400ecf43", "sourceProperties": { "properties": [{ "key": "myprop1_ID", "values": ["Please verify the XYZ invoice"] }, { "key": "myprop2_ID", "values": ["Name1@contoso.com","Name2@samplecompany.de"] } ], } }
Informationen zu den Parametern des JSON-Objektes finden Sie unter Definieren der Parameter zum Speichern.
Ist für den d.3-Dokumentstatus keine Zuordnung konfiguriert, wird für das DMS-Objekt standardmäßig der Dokumentstatus Freigabe (Release
) verwendet. Möchten Sie einen anderen Dokumentstatus beim Speichern anwenden, muss der Administrator die Eigenschaft Status
zugeordnet haben.
Ist der Aufruf erfolgreich, wird die URL zum DMS-Objekt im Header Location
zurückgegeben.
Wenn Sie ein Element mit einer Akte (parentId
) verknüpfen möchten und diese Aktion fehlschlägt, erhalten Sie als Antwort (Response) die URL zum DMS-Objekt im Header Location
und eine zusätzliche Meldung, dass die Verknüpfung nicht erfolgreich war.
Response
HTTP/1.1 201 Created Location: /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D0001234?sourceId=%2Fmyapp%2Fsources%2Fmysourc { "reason": "You do not have the right to link the document with the dossier manually. Nevertheless, the document was successfully saved. The document may be automatically linked on the server." "severity": 1 }
Wenn der Aufruf erfolgreich war und es Detailinformationen zum Verarbeitungsergebnis des Ablagevorgangs gibt, werden die Detailinformationen in der Antwort (Response) zurückgeliefert. Mithilfe der Informationen können Sie entscheiden, ob weitere Verarbeitungsschritte zum DMS-Objekt notwendig sind. Weitere Informationen finden Sie unter Format der Antwort für erfolgreiche Anforderungen (Requests) mit Detailinformationen.
Schlägt das Speichern des DMS-Objektes fehl, wird eine entsprechende Antwort (Response) zurückgegeben. Weitere Informationen finden Sie unter Format der Antwort bei Fehlern.