Abrufen und Anzeigen der Ergebnisse eines Suchvorgangs

Freigegeben: JSON-Repräsentation, HTML-Seite

Sie können beim Abrufen oder Anzeigen von Ergebnissen eines Suchvorgangs durch Angeben einer bestimmten Quelle sowie zugehörigen Quellkategorien und Quelleigenschaften die Ergebnismenge eingrenzen. Auch ein Volltextsuchbegriff kann zur Einschränkung des Suchergebnisses angegeben werden. Im Kapitel Definition eines Quellsystems erfahren Sie, wie Sie eine Quelle für eine Zuordnung bereitstellen können.

Um die Ergebnisse eines Suchvorgangs abzurufen oder anzuzeigen, müssen Sie folgende Schritte durchführen:

Ermitteln der URL zu einem Repository
Ermitteln der Linkrelation zum Abrufen der Ergebnisse eines Suchvorgangs
Angeben von verhaltenssteuernden Parametern
Aufrufen der URL für die Ergebnisse eines Suchvorgangs

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 Ergebnisse eines Suchvorgangs

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 searchresultwithmapping mit Platzhaltern für die Werte, mit deren Hilfe das Abrufen oder Anzeigen der Ergebnisse eines Suchvorgangs durchgeführt wird.

Response

{
        _links: {
                searchresultwithmapping: {
                        href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm{?sourceid,sourceproperties,sourcecategories,sourcepropertysort,ascending,fulltext,page,pagesize}",
                        templated: true
                }
        },
        id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Angeben von verhaltenssteuernden Parametern

Das Verhalten beim Abrufen oder Anzeigen von Suchergebnissen zu einem Suchvorgang steuern Sie mit folgenden Parametern. Sie müssen die Parameter der URL encodieren (z.B. Leerzeichen in %20). Die Länge des encodierten Abfrageparameters darf 2000 Zeichen nicht überschreiten.

Parameter	Beschreibung
`sourceid`	Legt fest, zu welcher Quelle die Zuordnung gehört, die für das Abrufen der Ergebnisse eines Suchvorgangs angewendet werden soll. Für die einzelnen Elemente des Ergebnisses werden nur die Eigenschaften und Kategorien der Quelle verwendet, die zu d.3-Eigenschaften und d.3-Kategorien zugeordnet wurden. Wird keine Quelle angegeben, werden für die einzelnen Elemente des Ergebnisses nur die ID und die Linkrelationen des DMS-Objektes zurückgegeben.
`sourceproperties`	Gibt eine Sucheinschränkung nach Eigenschaften der Dokumente und Akten aus Sicht der Quelle an. Geben Sie die ID der zugeordneten Quelleigenschaften an, um einen Suchvorgang auf bestimmte Kriterien zu beschränken. Der Suchvorgang wird basierend auf der Zuordnung ausgeführt. Reguläre Ausdrücke, die vom Administrator bei einer Zuordnung angegeben wurden, werden nicht berücksichtigt. Die Sucheinschränkungen geben Sie als JSON-Objekt an. Sie können je Eigenschaft mindestens einen Wert definieren. Beispiele (nicht encodiert): `sourceproperties={"myprop1_ID":["Test E-Mail 1"]}`: für die Suche nach Elementen mit der d.3-Eigenschaft mit dem Wert `"Test E-Mail 1"`, die der Quelleigenschaft mit der ID `"myprop1_ID"` zugeordnet wurde. `sourceproperties={"myprop1_ID":["Test E-Mail 1", "Test E-Mail 2"]}`: für die Suche nach Elementen mit der d.3-Eigenschaft mit dem Wert `"Test E-Mail 1"` oder `"Test E-Mail 2"`, die der Quelleigenschaft mit der ID `"myprop1_ID"` zugeordnet wurde. Einschränkung in Bezug auf die Definition eines Suchvorgangs: Sie können zu einem Parameter mehrere Werte definieren, sofern für die zugeordnete d.3-Eigenschaft Facetten konfiguriert wurden. Falls keine Facetten für die d.3-Eigenschaft zum Anzeigen konfiguriert wurden, wird immer der letzte Wert für den Suchvorgang übernommen. Quelleigenschaften, die den allgemeinen Eigenschaften für die Bemerkungsfelder (Bemerkung 1 - 4) zugeordnet sind, können Sie nicht für die Suche verwenden, da eine Suche nach einzelnen Bemerkungsfeldern im d.3-Repository nicht unterstützt wird. Sie können auch mehrere Eigenschaften gleichzeitig als Sucheinschränkung verwenden: Beispiel (nicht encodiert): s`ourceproperties={"myprop1_ID":["Test E-Mail 1"],"myprop2_ID":["Max Mustermann"]}`: für die Suche nach Elementen mit der d.3-Eigenschaft mit dem Wert `"Test E-Mail 1"`, die der Quelleigenschaft mit der ID `"myprop1_ID"` zugeordnet wurde und der d.3-Eigenschaft mit dem Wert `"Max Mustermann"`, die der Quelleigenschaft mit der ID `"myprop2_ID"` zugeordnet wurde.
`sourcecategories`	Legt fest, auf welche Kategorien sich die Suche bezieht. Sie können mindestens eine Kategorie definieren. Geben Sie die ID der Quellkategorie an, andernfalls erfolgt die Suche in allen Kategorien eines d.3-Repositorys. Legt fest, auf welche Quellkategorien sich die Suche bezieht. Geben Sie die ID der Quellkategorie an. Der Suchvorgang wird basierend auf der Zuordnung ausgeführt. Sie geben die Sucheinschränkungen als JSON-Array an. Sie können eine Quellkategorie oder mehrere Quellkategorien angeben. Geben Sie keine Quellkategorie an, erfolgt die Suche in allen Kategorien eines d.3-Repositorys. Beispiele (nicht encodiert): `sourcecategories=["mycategory1_ID"]`: für die Suche in der d.3-Kategorie, die der Quellkategorie mit der ID `"mycategory1_ID"` zugeordnet wurde. `sourcecategories=["mycategory1_ID","mycategory2_ID"]`: für die Suche in den d.3-Kategorien, die der Quellkategorie mit der ID `"mycategory1_ID"` oder `"mycategory2_ID"` zugeordnet wurden.
`sourcepropertysort`	Gibt die ID der zugeordneten Quelleigenschaft an, nach der sortiert wird. Ist keine Sortiereigenschaft angegeben, erfolgt die Sortierung gemäß Standardsortierung anhand des Sortierkriteriums Geändert am.
`ascending`	Gibt die Richtung der Sortierreihenfolge an. `ascending=true`: führt zu einer aufsteigenden Sortierung (von klein nach groß (A-Z) und von alt nach jung). `ascending=false`: führt zu absteigenden Sortierung (von groß nach klein (Z-A) und von jung nach alt). Wird der `ascending`-Parameter nicht explizit angegeben, wird eine aufsteigende Sortierung vorgenommen. Davon ausgenommen ist die Standardsortierung: Wird nach dem Kriterium Geändert am sortiert und ist die Sortierreihenfolge nicht angegeben, wird in diesem Fall absteigend sortiert. Außerdem werden in der Ergebnisliste zunächst die Akten und dann die Dokumente angezeigt. Innerhalb von Dokumenten und Akten wird nach dem angegebenen Sortierkriterium sortiert.
`fulltext`	Gibt einen Volltextsuchbegriff an.
`page`	Gibt an, welche Seite der Ergebnisliste angefordert werden. Wird der Parameter nicht übergeben, wird die Seite 1 angefordert.
`pagesize`	Gibt an, wie viele Elemente pro Seite angezeigt werden. Wird der Parameter nicht übergeben, werden 25 Elemente pro Seite angefordert.

Anmerkung

Spezielle Angaben für den sourceproperties-Parameter in Bezug auf verschiedene Einschränkungsmöglichkeiten, um gezielt zum Ergebnis zu gelangen:

Suche nach einem numerischen Wert oder einem Geldwert:
Geben Sie den Wert ohne Tausendertrennzeichen an. Als Dezimaltrennzeichen gilt der Punkt (.). Beispiel: Für den Wert 1.000,20 EUR geben Sie 1000.20 an.
Suche nach einem Datum und Uhrzeit:
Geben Sie das Datum im Format YYYY-MM-DD an. Beispiel: Für den 05.12.2014 (DD.MM.YYYY) geben Sie 2014-12-05 an.
Zeitangaben werden nach dem Format YYYY-MM-DDTHH:mm:ss+01:00 durchführt. Das Pluszeichen (+) müssen Sie mit %2b encodieren. Beispiel: 2015-02-18T23:59:59%2b01:00 für den 18.02.2015 um 23:59 Uhr und 59 Sekunden in der Zeitzone UTC+1 für Winterzeit in Deutschland.
Suche nach Elementen, die sich in einem bestimmten Bereich befinden:
Für die Bereichssuche verwenden Sie als Trennzeichen eine Kombination aus einem Pipe- und Minuszeichen (|-). Beispiele für ein numerisches Feld mit der ID "231":

Werte größer oder gleich 100: {"231":["100|-"]}
Werte kleiner oder gleich 100: {"231":["|-100"]}
Werte zwischen 100 und 200: {"231":["100|-200"]}

Aufrufen der URL für die Ergebnisse eines Suchvorgangs (JSON-Repräsentation)

Wenn Sie eine URL erzeugt haben, dann können Sie die Ergebnisse des Suchvorgangs wie folgt abrufen:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm?sourceid=/myapp/sources/mysource&sourceproperties={"myprop1_ID":["Test E-Mail 1"]}&sourcecategories=["mycategory1_ID"]&sourcepropertysort=myprop1_ID&ascending=true&fulltext=test&page=1&pagesize=50
Accept: application/json

Als Ergebnis wird dann folgendes JSON-Objekt zurückgegeben:

Response

{
  "_links": {
    "next": {
      "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm?...page=2"
    },
    "self": {
      "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm?...page=1"
    }
  },
  "page": 1,
  "items": [
    {
      "_links": {
        "self": { "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123" },
                "previewReadonly": { href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/preview?isReadonly=true" }
      },
      "id": "D000000123",
      "sourceProperties": [
        {
          "key": "myprop1_ID",
          "value": "Test E-Mail 1",
          "isMultiValue": false
        },
        {
          "key": "myprop2_ID",
          "value": "Max Mustermann",
          "isMultiValue": true
        },
        "..."
      ],
      "sourceCategories": [ "mycategory1_ID" ]
    },
    "..."
  ]
}

Eigenschaft	Beschreibung
`_links`	Enthält die Linkrelationen zum Element. `self`: Self-Link. `previewReadonly`: Relative URL zum Abrufen der Vorschau im Lesemodus. Verwenden Sie die Linkrelation, wenn die Vorschau im Inner Supply ( InnerSupply ) des Bedienkonzepts angezeigt wird. `next`: Relative URL zum Abrufen der nächsten Seite der Ergebnisliste. Wird nur angegeben, wenn es weitere Ergebnisse gibt. `prev`: Relative URL zum Abrufen der vorherigen Seite der Ergebnisliste. Wird nur angegeben, wenn es vorherige Ergebnisse gibt.
`page`	Gibt die Seitennummer der Ergebnisliste an.
`items`	Gibt das Array mit Elementen der Ergebnisse für den Suchvorgang für die angeforderte Seite an.

Eigenschaft

Beschreibung

_links

Enthält die Linkrelationen zum Element.

self: Self-Link.

previewReadonly: Relative URL zum Abrufen der Vorschau im Lesemodus. Verwenden Sie die Linkrelation, wenn die Vorschau im Inner Supply ( InnerSupply ) des Bedienkonzepts angezeigt wird.

next: Relative URL zum Abrufen der nächsten Seite der Ergebnisliste. Wird nur angegeben, wenn es weitere Ergebnisse gibt.

prev: Relative URL zum Abrufen der vorherigen Seite der Ergebnisliste. Wird nur angegeben, wenn es vorherige Ergebnisse gibt.

page

Gibt die Seitennummer der Ergebnisliste an.

items

Gibt das Array mit Elementen der Ergebnisse für den Suchvorgang für die angeforderte Seite an.

Struktur eines Elementes der Ergebnisliste

Eigenschaft	Beschreibung
`_links`	Enthält die Linkrelationen zu dem Element. `self`: Self-Link. `delete` oder `deleteWithReason`: Falls vorhanden, kann das Element mit einem HTTP DELETE-Anforderung (Request) gelöscht werden. Weitere Informationen finden Sie unter Löschen der aktuellen Version eines DMS-Objektes ohne Benutzerinteraktion. `update` oder `updateWithContent`: Falls vorhanden, kann das Element mit einem HTTP PUT-Anforderung (Request) aktualisiert werden. Weitere Informationen finden Sie unter Speichern einer neuen Version ohne Benutzerinterkation.
`id`	Gibt die Dokument-ID des Elements an.
`sourceProperties`	Gibt das Array mit Quelleigenschaften an, die für das Element vorhanden sind. Wurde dieselbe Quelleigenschaft mehreren d.3-Eigenschaften zugeordnet, die das Element besitzt, wird die Quelleigenschaft mehrfach mit den jeweiligen Werten der d.3-Eigenschaft zurückgegeben. Reguläre Ausdrücke, die vom Administrator bei einer Zuordnung angegeben wurden, werden nicht berücksichtigt.
`sourceCategories`	Gibt das Array mit den IDs der Quellkategorien an, die für das Element zur Verfügung stehen. Es werden nur dann mehrere Kategorien zurückgegeben, wenn mehrere Quellkategorien der d.3-Kategorie zugeordnet wurden, in der sich das Element befindet.

Struktur einer Quelleigenschaft

Eigenschaft	Beschreibung
`key`	Gibt den eindeutigen Bezeichner der Quelleigenschaft an.
`value`	Gibt den Wert der zugeordneten d.3-Eigenschaft an.
`displayValue`	Gibt den Anzeigewert der zugeordneten d.3-Eigenschaft an. Wird nur zurückgegeben, wenn der Wert ( `value` ) und der Anzeigewert ( `displayValue` ) unterschiedlich sind.
`isMultiValue`	Gibt an, ob die zugeordnete d.3-Eigenschaft eine Mehrfacheigenschaft ist. Handelt es sich bei der d.3-Eigenschaft um eine Mehrfacheigenschaft, wird bei `value` der erste oder der erste gefüllte Wert der Eigenschaft zurückgegeben (abhängig von der d.3-Repositorykonfiguration). Um alle Mehrfachwerte abzurufen, verwenden Sie die Anforderung (Request) zum Abrufen der Details eines DMS-Objektes.

Aufrufen der URL für die Ergebnisse eines Suchvorgangs (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 (nicht encodiert):

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/srm?sourceid=/myapp/sources/mysource&sourceproperties={"myprop1_ID":["Test E-Mail 1"]}&sourcecategories=["mycategory1_ID"]&sourcepropertysort=myprop1_ID&ascending=true&fulltext=test&page=1&pagesize=50
Accept: text/html

Abrufen des Standardquellsystems zu einem d.3-Repository

Abrufen und Anzeigen von Details eines DMS-Objektes