Sie können ein bestehendes DMS-Objekt in einem d.3-Repository aktualisieren, ohne dass ein Anwender eine Aktion ausführen muss. Beim Aktualisieren eines DMS-Objektes 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 DMS-Objekt zu aktualisieren, müssen Sie folgende Schritte durchführen:

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 Linkrelationen zum bestehenden DMS-Objekt

Um eine URL zu einem bestehendem DMS-Objekt zu ermitteln, führen Sie eine Suche aus und werten Sie die Linkrelation update oder updateWithContent zu einem Element der Ergebnisliste aus. Im Kapitel Abrufen und Anzeigen der Ergebnisse eines Suchvorgangs finden Sie weitere Informationen zum Ausführen einer Suche und die Beschreibung eines Elements der Ergebnisliste. Hat das bereits vorhandene DMS-Objekt den d.3-Dokumentstatus Processing muss der authentifizierte Benutzer der Bearbeiter des DMS-Objektes sein.

Bereitstellen der zu speichernden Datei (optional)

Haben Sie eine Linkrelation updateWithContent ermittelt, dann können Sie eine Datei mit den Parametern contentUri oder contentLocationUri bereitstellen. Im Kapitel Bereitstellen von Dateien können Sie nachlesen, wie Sie eine Datei bereitstellen können.

Wenn Sie nur Eigenschaften mit der Linkrelation update aktualisieren möchten, ist die Bereitstellung einer Datei nicht notwendig.

Haben Sie ausschließlich eine Linkrelation update erhalten, dann ist keine Aktualisierung mit Datei möglich.

Aufrufen der URL zum Aktualisieren des DMS-Objektes

Führen Sie eine HTTP PUT-Anforderung mit den benötigten Eigenschaften als Body auf die URL des bestehenden DMS-Objektes aus, die Sie in der Linkrelation update oder updateWithContent erhalten haben. Wenn Sie nur Eigenschaften ändern möchten, geben Sie die Parameter contentLocationUri und filename nicht an.

Request

PUT /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/A00000001
Origin: https://baseuri
Accept: application/hal+json
Content-Type: application/hal+json

{
        "filename": "myfile.txt",
        "alterationText": "updated file",
        "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 der Aufruf erfolgreich, wird HTTP 200 OK zurückgegeben:

Response

HTTP/1.1 200 OK

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 der Version fehl, wird eine entsprechende Antwort (Response) zurückgegeben. Weitere Informationen finden Sie unter Format der Antwort bei Fehlern.

Wenn der Aufruf erfolgreich war und es Detailinformationen zum Verarbeitungsergebnis des Ablagevorgangs gibt, so werden diese Detailinformationen in der Antwort (Response) zurückgeliefert. Diese Informationen können Sie z.B. dazu verwenden, um Entscheidungen darüber zu treffen, ob weitere Verarbeitungsschritte zu dem DMS-Objekt nötig sind. Weitere Informationen finden Sie unter dem Kapitel Format der Antwort für erfolgreiche Anforderungen.