Ändern des aktuellen Bearbeiters und Dokumentenstatus

Sie können den Bearbeiter und den Dokumentstatus eines bestehenden DMS-Objekts in einem d.3-Repository aktualisieren, ohne dass ein Anwender eine Aktion ausführen muss. Voraussetzung 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 den Bearbeiter oder den Dokumentstatus eines DMS-Objekts zu ändern, müssen Sie folgende Schritte durchführen:

  • Ermitteln der URL zu einem Repository

  • Ermitteln der Linkrelationen zum bestehenden DMS-Objekt

  • Aufrufen der URL zum Ändern des Bearbeiters oder Dokumentstatus eines DMS-Objekts

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 displayVersion 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.

Aufrufen der URL zum Ändern des DMS-Objektstatus und des Bearbeiters 

Führen Sie eine HTTP PUT-Anforderung mit den benötigten Eigenschaften als Body auf die URL der bestehenden aktuellen Version des DMS-Objekts aus , die Sie in der Linkrelation displayVersion erhalten haben.

Im Folgenden finden Sie Beschreibungen zum JSON-Objekt, das bei der PUT -Anforderung übergeben wird:

Eigenschaft

Beschreibung

property_state 

Zielstatus des Dokuments. Mögliche Werte:

  • Processing 

  • Verification 

  • Release 

property_editor 

Pflichtfeld beim Zielstatus Bearbeitung (Processing) und optional beim Zielstatus Prüfung (Verification). In anderen Zielstatus wird der Parameter ignoriert. Mögliche Werte:

  • Zielstatus Bearbeitung: Benutzer- oder Gruppen-ID, zu dem oder der das Dokument zugeordnet werden soll.

  • Zielstatus Prüfung: Gruppen-ID, der das Dokument zugeordnet werden soll.

Sie können sowohl die IDs von d.ecs identity provider als auch vom DMS-System verwenden.

alterationText 

Pflichtfeld beim Zielstatus Freigabe (Release).

Text (maximal 120 Bytes), der bei der Statusänderung zur Dokumentversion gespeichert wird. Sie können z.B. einen Hinweis zum Änderungsgrad bereitstellen.

Beispiel 1: Dokument in Status "Bearbeitung" überführen oder den Bearbeiter ändern mit eigener Zuordnung 

Stellen Sie sicher, dass eine Zuordnung existiert, in der die Werte myprop1_ID auf property_state und myprop2_ID auf property_editor festgelegt sind.

Request 

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

{
   "sourceId": "/myapp/sources/mysource",
   "sourceProperties": {
      "properties": [
         {
            "key": "myprop1_ID",
            "values": [
               "Processing"
            ]
         },
         {
            "key": "myprop2_ID",
            "values": [
               "97273358-d124-497c-97ce-977f72b32a33"
            ]
         }
      ]
   }
}

Wenn der Aufruf erfolgreich ist, wird HTTP 200 OK zurückgegeben:

Response 

HTTP/1.1 200 OK

Beispiel 2: Dokument in Status "Bearbeitung" überführen oder den Bearbeiter ändern mit Standardzuordnung 

Request 

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

{
   "sourceId": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source",
   "sourceProperties": {
      "properties": [
         {
            "key": "property_state",
            "values": [
               "Processing"
            ]
         },
         {
            "key": " property_editor",
            "values": [
               "97273358-d124-497c-97ce-977f72b32a33"
            ]
         }
      ]
   }
}

Wenn der Aufruf erfolgreich ist, wird HTTP 200 OK zurückgegeben:

Response 

HTTP/1.1 200 OK

Beispiel 3: Dokument in Status "Freigabe" überführen mit Standardzuordnung 

Request 

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

{
   "sourceId": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/source",
   "alterationText": "updated file",
   "sourceProperties": {
      "properties": [
         {
            "key": "property_state",
            "values": [
               "Release"
            ]
         }
      ]
   }
}

Wenn der Aufruf erfolgreich ist, wird HTTP 200 OK zurückgegeben:

Response 

HTTP/1.1 200 OK

Wenn das Ändern des Bearbeiters oder Dokumentstatus fehlschlägt, wird eine entsprechende Antwort (Response) zurückgegeben. Weitere Informationen finden Sie unter Format der Antwort bei Fehlern .