Abrufen, Speichern und Bearbeiten von Zuordnungen

Freigegeben: JSON-Repräsentation

In diesem Kapitel erfahren Sie, wie Sie Zuordnungen sowohl für Eigenschaften als auch für Kategorien von einem Quellsystem (z.B. einer E-Mail-Anwendung) zu einem d.3-Repository erstellen und verwalten können. Diese Zuordnungen werden bei der Ablage, beim Abrufen von Details eines Elementes und beim Abrufen und Anzeigen von Ergebnissen eines Suchvorgangs innerhalb von d.3one-Integrationen verwendet. Beim Speichern von Zuordnungen legen Sie fest, welche externen Daten (z.B. die Eigenschaften einer E-Mail) welcher d.3-Dokumenteigenschaft zugewiesen werden.

Pro Quelle eines Quellsystems kann es ausschließlich eine einzige Zuordnung geben.

Im Kapitel Definieren eines Quellsystems erfahren Sie, wie Sie eine Quelle für eine Zuordnung bereitstellen können. Im Kapitel Grundlegendes zu Zuordnungen (Mappings) finden Sie Basisinformationen, die Ihnen das Erstellen von Zuordnungen erleichtern. Wissenswertes zu schreibenden Zugriffen finden Sie unter Grundlegendes zu schreibenden Zugriffen.

Ermitteln der Linkrelation für das Verwalten von Zuordnungen

Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln. Danach führen Sie eine HTTP Get-Anforderung für die REST-Ressource zu einem Repository wie folgt aus:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: application/hal+json

Das JSON-Objekt zu einem Repository enthält die Linkrelation mappingconfig.

Response

{
        "_links": {
                "mappingconfig": {
                        "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m/"
                }
        },
        "id": "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Speichern von Zuordnungen

Führen Sie eine HTTP POST-Anforderung mit den Zuordnungen für Ihr Quellsystem als Body für die URL aus, die Sie in der Linkrelation mappingconfig erhalten haben. Nach dem erfolgreichen Speichern erhalten Sie den HTTP-Statuscode 201 Created.

Request

POST https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m HTTP/1.1
Origin: https://host
Accept: application/hal+json
Content-Type: application/hal+json

{
        name: "My Source",
        sourceId: "/myapp/sources/mysource",
        mappingItems: [{
                destination: "RECH",
                source: "mycategory1_ID",
                type: 1
        },
        {
                destination: "3",
                source: "myprop1_ID",
                type: 0
        },
        {
                destination: "property_caption",
                source: "myprop2_ID",
                type: 0
        }]
}

Das JSON-Objekt, das beim POST übergeben wird, ist wie folgt beschrieben:

Eigenschaft	Eigenschaft eines enthaltenen Objekts	Beschreibung
`name`	-	Gibt den Namen der Zuordnung an.
`sourceId`	-	Gibt den eindeutigen Bezeichner der Quelle an. Die ID muss eine relative URI sein. Die relative URI sollte mit dem Namen der App beginnen, die das Quellsystem bereitstellt, damit eine Eindeutigkeit gewährleistet ist (z.B. `/myapp/sources/mysource`).
`mappingItems`	-	Gibt das Array mit den Elementen der Zuordnung an. Dieses Array ordnet die Eigenschaften und Kategorien des Quellsystems zu den Eigenschaften und Kategorien des d.3-Repositorys zu.
	`type`	Gibt den Typ des Zuordnungselements an. Folgende Werte sind möglich: Bei Wert 0 bezieht sich das Zuordnungselement auf eine Eigenschaft. Bei Wert 1 bezieht sich das Zuordnungselement auf eine Kategorie.
	`source`	Gibt die ID der Eigenschaft im Quellsystem an.
	`destination`	Wenn Sie eine Kategorie zuordnen, dann gibt `destination` die ID der Kategorie im d.3-Repository an. Wenn Sie eine Eigenschaft zuordnen, dann kann `destination` einen der folgenden Werte enthalten: Die ID der erweiterten Eigenschaft, wie sie im d.3-Repository definiert ist. `property_last_modified_date` `property_last_alteration_date` `property_editor` `property_remark1` `property_remark2` `property_remark3` `property_remark4` `property_owner` `property_caption` `property_filename` `property_filetype` `property_document_number` `property_variant_number` `property_creation_date` `property_size` `property_state` `property_access_date` `property_colorcode` Wenn Sie das Erstellungsdatum (`property_creation_date`) des DMS-Objektes festlegen möchten, dann wird das Festlegen der Eigenschaft nur beim Speichern eines neuen DMS-Objektes ohne Benutzerinteraktion berücksichtigt. Weitere Informationen finden Sie unter Speichern eines neuen DMS-Objektes ohne Benutzerinteraktion. Bitte beachten Sie, dass Sie nur d.3-Eigenschaften als Ziel angeben können, die mindestens einer d.3-Kategorie als Eigenschaft zugewiesen sind.

Abrufen der gespeicherten Zuordnungen

Führen Sie eine HTTP GET-Anforderung für die URL /dms/r/<RepositoryID>/m?sourceId=<SourceID> aus, um die Zuordnungen abzurufen. Der Wert der Eigenschaft sourceID gibt den eindeutigen Bezeichner der Quelle an (z.B. /myapp/sources/mysource).

Request

GET https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m?sourceId=%2Fmyapp%2Fsources%2Fmysource HTTP/1.1
Accept: application/hal+json

Sie erhalten als Antwort das Objekt mit den gespeicherten Zuordnungen.

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
        mappings: [{
                _links: {
                        self: {
                                href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m/<MappingContainerID>"
                        }
                }
                name: "My Source",
                sourceId: "/myapp/sources/mysource",
                mappingItems: [{
                        destination: "RECH",
                        source: "mycategory1_ID",
                        type: 1
                },
                {
                        destination: "3",
                        source: "myprop1_ID",
                        type: 0
                },
                {
                        destination: "property_caption",
                        source: "myprop2_ID",
                        type: 0
                }]
        }]
}

Die Eigenschaften der Objekte sind die gleichen Eigenschaften wie beim Speichern von Zuordnungen.

Löschen einer gespeicherten Zuordnung

Wenn Sie die Zuordnungen für Ihre Quelle abrufen, erhalten Sie pro Zuordnung eine Linkrelation zu dieser gespeicherten Zuordnung (_links.self.href). Für diese URL können Sie eine HTTP Delete-Anforderung ausführen, um die Zuordnung zu löschen.

Request

DELETE https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m/<MappingContainerID> HTTP/1.1
Origin: https://host
Accept: application/hal+json

Bearbeiten einer gespeicherten Zuordnung

Wenn Sie die Zuordnungen für Ihre Quelle abrufen, erhalten Sie pro Zuordnung eine Linkrelation zu dieser gespeicherten Zuordnung (_links.self.href). Für diese URL können Sie eine HTTP PUT-Anforderung zum Aktualisieren der Zuordnung ausführen. Das Objekt, das Sie übergeben, entspricht dem Objekt zum Speichern einer Zuordnung.

Request

PUT https://host/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/m/<MappingContainerID> HTTP/1.1
Origin: https://host
Accept: application/hal+json
Content-Type: application/hal+json

{
        name: "My Source",
        sourceId: "/myapp/sources/mysource",
        mappingItems: [{
                destination: "RECH",
                source: "mycategory1_ID",
                type: 1
        },
        {
                destination: "3",
                source: "myprop1_ID",
                type: 0
        },
        {
                destination: "property_caption",
                source: "myprop2_ID",
                type: 0
        }]
}

Löschen der aktuellen Version eines DMS-Objektes ohne Benutzerinteraktion

Abrufen und Speichern der Notizen eines DMS-Objektes