Möchten Sie nach bestimmten Dokumenten anhand von Indexdaten suchen, benutzen Sie die GET-Route /application/jobarchive/archives/:archive/index. Dazu werden in dem where-Parameter die Indexfelder mit Suchwerten und Operatoren angegeben.
Beispiele
URL für Suche nach einer bestimmter Dokument-Revision
/application/jobarchive/archives/MYTESTARCHIVE/index
?where[revisionId][eq]=1032
URL für Suche anhand von Indexfeldern
/application/jobarchive/archives/MYTESTARCHIVE/index
?where[document_type][eq]=note&where[department][eq]=accounting
/application/jobarchive/archives/MYTESTARCHIVE/index
?where[amount][gt]=10000&where[amount][lt]=400000
/application/jobarchive/archives/MYTESTARCHIVE/index
?where[tags][in]=Finanzen,Buchhaltung
Handelt es sich um ein Listenfeld, verwenden Sie den Wert der Option als Suchwert.
Antwort
Die Metadaten der gefundenen Dokumente werden in der Antwort im JSON-Format zurückgegeben. Wie Sie den Inhalt der Dokument-Dateien erhalten ist im Kapitel Dokument abrufen beschrieben.
{
"archivedocuments": [
{
"revisionId": "4110",
"deleteDate": "",
"locked": false,
"createDate": "2017-03-13T15:27:15+02:00",
"createdBy": "jdoe",
"modifyDate": "2017-03-13T15:27:15+02:00",
"modifiedBy": "jdoe",
"indexFields": [
{
"name": "document_type",
"value": "note"
},
... weitere Indexdaten
],
"files": [
{
"pageCount": 40,
"extension": "pdf",
"fileName": "my_document.pdf",
"filesize": 1024513
},
... weitere Dateien
]
},
... weitere Dokumente
]
}
Bitte beachten Sie: Die Route liefert nur aktuelle Dokumentversionen. Wird eine veraltete Revision angefordert, wird eine leere Antwort zurückgegeben.
Dokumentattribut |
Erklärung |
revisionId |
Revision-ID |
deleteDate |
Datum des geplanten Löschen |
locked |
Gibt an, ob das Dokument gesperrt ist (true,false) |
createDate |
Erstelldatum |
createdBy |
Wer hat das Dokument archiviert (Benutzername) |
modifyDate |
Datum der letzte Änderung |
modifiedBy |
Wer hat das Dokument verändert (Benutzername) |
indexFields |
Indexdaten (Name und Wert) |
files |
Name, Größe, Anzahl Seiten und Erweiterung der Dokument-Dateien |
Benötigen Sie weitere Versionen, Dokument-Attribute oder die zugewiesenen Stichwörter, verwenden Sie die GET-Route /application/jobarchive/archives/:archive/documents. Diese Route liefert folgende Daten:
{
"archivedocuments": [
{
"revisionId": "5367",
"baseRevisionId": "5360",
"archiveName": "INVOICES",
"archiveGuid": "5F5AD1BE-352C-4B76-804C-5F3B79DA3A61",
"createDate": "2017-05-10T10:28:31+02:00",
"createdBy": "jdoe",
"modifyDate": "2017-05-10T10:28:31+02:00",
"modifiedBy": "jdoe",
"lockDate": "",
"lockedBy": null,
"indexDataModifyDate": "2017-05-10T10:28:31+02:00",
"indexDataModifiedBy": "jdoe",
"deleteDate": "",
"deleted": false,
"trunk": true,
"locked": false,
"indexFields": [
{
"name": "document_type",
"value": "incoming_invoice",
"type": "varchar",
"label": "",
"hasList": true
},
... weitere Indexfelder
],
"keywordFields": [
{
"name": "tags",
"keywords": [ "Eingang", "Rechnung" ],
"type": "keyword"
},
... weitere Keywords
],
"files": [
{
"pageCount": 16,
"filesize": 30370,
"mimetype": "application/pdf",
"fileName": "Rechnung_239847.pdf",
"extension": "pdf",
"ordernum": 1
},
... weitere Dateien
]
},
....
]}
Mit der documents-Route können Sie z. B. die Versionen eines Dokuments ermitteln. Dazu wird auf das Attribut baserevision_id gefiltert:
/application/jobarchive/archives/MYTESTARCHIVE/index
?where[baserevision_id][eq]=1234
Attribut |
Erklärung |
baseRevisionId |
ID der erste Dokumentversion |
archiveName |
Name der Archivtabelle |
archiveGuid |
GUID des Archivs |
lockDate |
Datum, wann das Dokument gesperrt wurde |
lockedBy |
Wer hat das Dokument gesperrt (Benutzername) |
indexDataModifyDate |
Datum der letzte Änderung der Indexdaten |
indexDataModifiedBy |
Wer hat die Indexdaten verändert (Benutzername) |
deleted |
Flag, ob das Dokument gelöscht wurde (wenn für das Archiv kein unwiderrufliches Löschen eingestellt ist) |
trunk |
Flag, ob es sich um die aktuelle Version handelt (true = aktuelle Version) |
indexFields |
Hier werden zusätzlich Typ, übersetzte Bezeichnung und Flag, ob es sich um ein Listenfeld handelt, zurückgegeben. |
keywordFields |
Eine Auflistung der zugewiesenen Stichworte |
files |
Zusätzlich Mimetype und Reihenfolge-Index der Dokument-Dateien |
