Abrufen und Anzeigen von Details eines DMS-Objektes
Freigegeben: JSON-Repräsentation, HTML-Seite
Sie können die Details zu einem DMS-Objekt als JSON-Repräsentation abrufen oder die Detailansicht zu einem DMS-Objekt anzeigen. Beim Abrufen der Details als JSON-Repräsentation können Sie durch Angeben einer bestimmten Quelle eines Quellsystems festlegen, welche Quelleigenschaften und Quellkategorien ermittelt werden. Geben Sie keine Quelle an, werden nur die ID und die Linkrelationen zu dem DMS-Objekt zurückgegeben. Im Kapitel Definieren eines Quellsystems erfahren Sie, wie Sie eine Quelle anlegen können.
Um die Details eines DMS-Objektes abzurufen oder anzuzeigen, müssen Sie folgende Schritte durchführen:
Ermitteln der URL zu einem Repository
Ermitteln der Linkrelation zum Abrufen der Details eines DMS-Objektes
Angeben von verhaltenssteuernden Parametern
Aufrufen der URL für die Details eines 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 zum Abrufen oder Anzeigen der Details eines 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
mit Platzhaltern für die Werte, mit deren Hilfe das Abrufen oder Anzeigen der Details eines DMS-Objektes durchgeführt wird.
Response
{ _links: { dmsobjectwithmapping: { href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/{dmsobjectid}{?sourceid}", templated: true } }, id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27" }
Angeben von verhaltenssteuernden Parametern
Das Verhalten beim Abrufen oder Anzeigen von Details eines DMS-Objektes steuern Sie mit folgenden Parametern:
Parameter | Beschreibung |
---|---|
| Gibt die Dokument-ID des DMS-Objektes an, dessen Details abgerufen (Request) oder angezeigt werden sollen. |
| Legt fest, zu welcher Quelle die Zuordnung gehört, die für das Abrufen der Details des DMS-Objektes verwendet wird. Wie Sie ein Quellsystem für Zuordnungen bereitstellen, erfahren Sie unter Definieren eines Quellsystems. Wenn Sie das Standardquellsystem verwenden möchten, finden Sie weitere Informationen unter Abrufen des Standardquellsystems zu einem d.3-Repository. Abrufen (JSON-Repräsentation): Es werden nur die Eigenschaften der Quelle zurückgegeben, die den d.3-Eigenschaften zugeordnet wurden. Wird keine Quelle angegeben, werden nur die ID und die Linkrelationen zum DMS-Objekt zurückgegeben. Anzeigen (HTML-Seite): Wenn Sie die Details eines DMS-Objektes anzeigen möchten, ist das Angeben dieses Parameters nicht erforderlich. Der Parameter wird nicht ausgewertet. |
Aufrufen der URL für die Details eines DMS-Objektes (JSON-Repräsentation)
Wenn Sie eine URL erzeugt haben, dann können Sie die Details des DMS-Objektes wie folgt abrufen:
Request
GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123?sourceid=/myapp/sources/mysource Accept: application/json
Als Ergebnis wird dann folgendes JSON-Objekt zurückgegeben:
Response
{ "_links": { "self": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123" }, "mainblobcontent": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/current/b/main/c" }, "editinoffice": { "href": "{ms-word:ofe|u|{+clientOrigin}/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/dav/D000000123%20(D000000123).DOCX}", "templated": true }, "pdfblobcontent": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/current/b/p1/c" }, "notes":{ "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/n" }, "children":{ "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm/?children_of=D000000123" }, "versions":{ "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/" } }, "id": "D000000123", "sourceProperties": [ { "key": "myprop1_ID", "value": "value of property 1" }, { "key": "myprop2_ID", "value": "value of property 2 in row 2", "values": { "2": "value of property 2 in row 2", "4": "value of property 2 in row 4" } } ], "sourceCategories": ["mycategory2_ID"] }
Eigenschaft | Beschreibung |
---|---|
| Enthält die Linkrelationen zum DMS-Objekt.
|
| Gibt die Dokument-ID des DMS-Objektes an. |
| Gibt das Array mit Quelleigenschaften an, die für das angeforderte DMS-Objekt vorhanden sind. Wurde dieselbe Quelleigenschaft verschiedenen d.3-Eigenschaften zugeordnet, die das angeforderte DMS-Objekt besitzt, wird diese Quelleigenschaft mehrfach mit den jeweiligen Werten der d.3-Eigenschaft zurückgegeben. |
| Gibt das Array mit den IDs der Quellkategorien an, die für das angeforderte DMS-Objekt in Frage kommen. Es werden nur dann mehrere Kategorien zurückgegeben, wenn mehrere Quellkategorien der d.3-Kategorie zugeordnet wurden, in der sich das angeforderte DMS-Objekt befindet. |
Struktur einer Quelleigenschaft
Eigenschaft | Beschreibung |
---|---|
| Gibt den eindeutigen Bezeichner der Quelleigenschaft an. |
| Gibt den Wert der zugeordneten d.3-Eigenschaft an. Handelt es sich bei der d.3-Eigenschaft um eine Mehrfacheigenschaft, wird bei |
| Gibt die Werte der zugeordneten d.3-Eigenschaft an. Wird nur zurückgegeben, wenn die d.3-Eigenschaft eine Mehrfacheigenschaft ist.
Name: Zeilennummer (beginnend bei 1). Wert: Wert der Eigenschaft in der entsprechenden Zeile. |
| Gibt den Anzeigewert der zugeordneten d.3-Eigenschaft an. Wird nur zurückgegeben, wenn der Wert ( |
Aufrufen der URL für die Details eines DMS-Objektes (HTML-Seite)
Wenn Sie die HTML-Darstellung der Ergebnisse aufrufen möchten, erzeugen Sie die URL in derselben Weise wie beim Abfragen der JSON-Repräsentation beschrieben. Geben Sie die URL im Browser ein, um die HTML-Seite anzuzeigen. Diese HTML-Seite enthält die Bezeichner der d.3-Eigenschaften und d.3-Kategorien.
Beispiel:
Request
GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123 Accept: text/html