searchDocumentsExtv2

POST

Über diesen Befehl wird nach Dokumenten mit bestimmten Parametern gesucht.

Request URL
http://localhost:8180/api/searchDocumentsExtv2
Request body
{
  "filter": [
    {
      "classifyAttribut": "string",
      "searchOperator": "string",
      "searchValue": "string"
    }
  ],
  "maxDocumentCount": 1000,
  "personalDocumentsOnly": false,
  "readRoles": true,
  "sortOrder": [
    {
      "classifyAttribut": "string",
      "sortDirection": "string"
    }
  ],
  "trashedDocuments": true
}
Request (Beispiel)
{
  "filter": [
    {
      "classifyAttribut": "status",
      "searchOperator": "=",
      "searchValue": "2"
    }
  ],
  "maxDocumentCount": 1000,
  "personalDocumentsOnly": false,
  "readRoles": true,
  "sortOrder": [
    {
      "classifyAttribut": "docid",
      "sortDirection": "desc"
    }
  ],
  "trashedDocuments": false
}
Response body (Beispiel)
  {
    "docId": 234,
    "clDocId": 236,
    "archiveName": "1",
    "classifyAttributes": {
      "docart": "0",
      "dyn_0_1624539569944": "",
      "docid": "234#236",
      "defdate": "2021-07-02",
      "dyn_1_1624538057946": "",
      "changeid": "Herr Meier",
      "revision": "1.6",
      "rechte": "W",
      "folder": "0",
      "cdate": "2021-06-28",
      "bemerkung": "Dies ist ein Beispieldokument",
      "ctimestamp": "2021-07-01 10:21:36",
      "mainfolder": "0",
      "dyn_1_1624539569944": "",
      "status": "2"
    },
    "editRoles": [],
    "readRoles": []
  },
  {
    "docId": 233,
    "clDocId": 235,
    "archiveName": "1",
    "classifyAttributes": {
      "docart": "2",
      "dyn_0_1624539569944": "",
      "docid": "233#235",
      "defdate": "2021-07-03",
      "dyn_1_1624538057946": "",
      "changeid": "Frau Müller",
      "revision": "1.3",
      "rechte": "W",
      "folder": "1.1",
      "cdate": "2021-06-23",
      "bemerkung": "Dies ist ein weiteres Beispieldokument",
      "ctimestamp": "2021-07-01 10:21:36",
      "mainfolder": "1",
      "dyn_1_1624539569944": "",
      "status": "2"
    }

Hinweise

  • Das Beispiel sucht alle Dokumente mit dem Status=2 (hier: Wiedervorlage).
  • Die Ergebnisse werden nach DocID sortiert absteigend (desc) angezeigt.
  • Für die Sortierung kann ein beliebiges Klassifizierungsattribute angegeben werden.
  • Über optionale Parameter ist es möglich, die Suche zu beschränken:
    • maxDocumentCount : Anzahl der zurückgelieferten Dokumente (max. 1000)
    • personalDocumentsOnly=true Ansicht von ausschließlich persönlichen Dokumenten (default=false)
    • readRoles=false Lesen der Berechtigungen des Dokuments (default=true)
    • trashedDocuments=true Lesen der Dokumente aus dem Papierkorb (default=false)
  • Die maximale Anzahl der Suchergebnisse beträgt 1000.
  • Nach dem Volltext kann mit dem classifyAttribute fulltext gesucht werden.

Verwandte Artikel