- Erstellt von Stephan Portmann, zuletzt geändert von Marco Schoch am Jan 08, 2021
Sie zeigen eine alte Version dieser Seite an. Zeigen Sie die aktuelle Version an.
Unterschiede anzeigen Seitenhistorie anzeigen
« Vorherige Version anzeigen Version 7 Nächste Version anzeigen »
Um REST-Funktionen verwenden zu können, muss man sich zuerst mit OAuth2 autorisieren. Die search Operation gibt die gespeicherten Formulareingänge zurück.
Aktuell sind folgende Funktionen verfügbar:
Verfügbare Abfrageparameter
Element | Default | Beschreibung |
---|---|---|
formId | ID des Formulars | |
dbmResource | Absoluter Pfad zu einem DBM. Beispiel: resources/MANDANT/FormularXY/special_search.dbm | |
pageSize | 100 | Anzahl Zeilen |
offset | 0 | Anzahl der Zeilen, die übersprungen werden sollen. |
countTotal | false | Liest alle Zeilen und gibt die Anzahl in der Response zurück. |
includeXML | false | Definiert, ob das xmlField zurückgegeben werden soll. |
checkPDF | false | Definiert, das überprüft werden soll, ob für ein Formular ein PDF existiert. Die einzelnen PDF müssen dann über einen Rest-Aufruf konsumiert werden. |
checkAttachment | false | Definiert, das überprüft werden soll, ob für das Formular Beilagen existieren. Die einzelnen Attachments müssen dann über einen Rest-Aufruf konsumiert werden. |
resultFields | * (alle) | Im XMLDBMapping definierte Felder, welche zurückgegeben werden sollten. |
id | Field-ID gemäss XMLDBMapping | |
value | Wert, nachdem in dem Feld gesucht werden soll. Standardmässig werden die Suchabfragen mit AND verknüpft ausser es wird eine orClauseGroup angegeben. | |
condition | = | Wie der Wert gesucht werden soll (=, <>, >, <, >=, <=, LIKE, IN), erläutert unter "Mögliche Operatoren für Condition" |
orClauseGroup | Identifikation für mindestens 2 searchFields, welche mit OR selektiert werden sollen. Siehe "Eingeschränkte Abfrage mit Verwendung der orClauseGroup". | |
sortOrder | asc | Sortierung aufsteigend/absteigend (asc/desc) |
/search/forms/{formID}
Um diesen Request abzusetzen wird minimal die formID benötigt. Die formID ist der Name des Formulars und kann in der Formularverwaltung eingesehen werden.
Der Response bei keinem Body beinhaltet alle Informationen über alle gespeicherten Formulareingänge.
{ "info":{ "size":14, "offset":0, "totalSize":null, "hasNext":false, "pageSize":100 }, "row":[ { "field":[ { "value":"b193827c-fc6b-450b-ac69-2c19aed3ddeb", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14251", "id":"UUID" }, { "value":"14", "id":"ID" }, { "value":"2021-01-07T14:57:04.0", "id":"Created" }, { "value":"testwebservice", "id":"CreatedUser" }, { "value":"2021-01-07T14:57:04.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17893", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"14" }, { "field":[ { "value":"840955f8-4ac9-42a9-b9a2-5cc3ea0c43c0", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14250", "id":"UUID" }, { "value":"13", "id":"ID" }, { "value":"2021-01-07T11:47:15.0", "id":"Created" }, { "value":"testwebservice", "id":"CreatedUser" }, { "value":"2021-01-07T14:25:37.0", "id":"LastUpdate" }, { "value":"testwebservice", "id":"LastUpdateUser" }, { "value":"128", "id":"Status" }, { "value":"17893", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"13" }, { "field":[ { "value":"2f387d25-6563-4580-8954-842e0716cc61", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14246", "id":"UUID" }, { "value":"12", "id":"ID" }, { "value":"2020-11-19T15:54:29.0", "id":"Created" }, { "value":"anonymous", "id":"CreatedUser" }, { "value":"2020-11-19T15:54:29.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"anonymous", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"12" }, { "field":[ { "value":"9a5a6a44-c22d-4fe8-ac14-06c55a2faa33", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14245", "id":"UUID" }, { "value":"11", "id":"ID" }, { "value":"2020-11-19T15:47:08.0", "id":"Created" }, { "value":"anonymous", "id":"CreatedUser" }, { "value":"2020-11-19T15:47:08.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"anonymous", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"11" }, { "field":[ { "value":"18938b63-33e0-4592-bb25-775655e10faa", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14233", "id":"UUID" }, { "value":"10", "id":"ID" }, { "value":"2020-11-16T18:26:47.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T18:26:47.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"10" }, { "field":[ { "value":"f6e95857-b622-45f2-8f4d-b733faf2a9f5", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14232", "id":"UUID" }, { "value":"9", "id":"ID" }, { "value":"2020-11-16T18:04:39.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T18:04:40.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"9" }, { "field":[ { "value":"c06401f2-4db2-49f9-98fb-e0ebd69212ec", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14231", "id":"UUID" }, { "value":"8", "id":"ID" }, { "value":"2020-11-16T14:01:59.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T14:01:59.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"8" }, { "field":[ { "value":"83497305-d50a-44a8-9ff7-d47e61f58c0e", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14230", "id":"UUID" }, { "value":"7", "id":"ID" }, { "value":"2020-11-16T13:57:57.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:57:57.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"7" }, { "field":[ { "value":"1308f48f-96a0-416e-894a-b54461048de6", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14229", "id":"UUID" }, { "value":"6", "id":"ID" }, { "value":"2020-11-16T13:33:27.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:33:27.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"6" }, { "field":[ { "value":"4b0d9b08-f309-4d8c-b55b-8b1908232e92", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14228", "id":"UUID" }, { "value":"5", "id":"ID" }, { "value":"2020-11-16T13:29:19.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:29:19.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"5" }, { "field":[ { "value":"f1a550b9-bd3f-470c-a4e3-1fc4b27fba78", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14227", "id":"UUID" }, { "value":"4", "id":"ID" }, { "value":"2020-11-16T13:27:29.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:27:29.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"4" }, { "field":[ { "value":"6bbc370a-8c00-4c27-8cd8-8119ba95e551", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14226", "id":"UUID" }, { "value":"3", "id":"ID" }, { "value":"2020-11-16T13:23:48.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:23:48.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"3" }, { "field":[ { "value":"042e5ecb-0f84-4a8d-85a3-60d95bae73f4", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14225", "id":"UUID" }, { "value":"2", "id":"ID" }, { "value":"2020-11-16T13:19:53.0", "id":"Created" }, { "value":"spital-ksbl", "id":"CreatedUser" }, { "value":"2020-11-16T13:19:53.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17040", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"2" }, { "field":[ { "value":"6e55805d-b902-4468-ae71-6045d7d9765b", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14224", "id":"UUID" }, { "value":"1", "id":"ID" }, { "value":"2020-11-16T11:38:54.0", "id":"Created" }, { "value":"anonymous", "id":"CreatedUser" }, { "value":"2020-11-16T11:38:55.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"256", "id":"Status" }, { "value":"anonymous", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"1" } ] }
Beispiele anhand der verfügbaren Abfrageparameter
Abfrage mit Einschränkung der pageSize & countTotal:
{ "countTotal": true, "pageSize": 3 }
{ "info":{ "size":3, "offset":0, "totalSize":15, "hasNext":true, "pageSize":3 }, "row":[ { "field":[ { "value":"127c0138-0fdd-4af9-86fa-9ee837019570", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14252", "id":"UUID" }, { "value":"15", "id":"ID" }, { "value":"2021-01-07T17:16:36.0", "id":"Created" }, { "value":"testwebservice", "id":"CreatedUser" }, { "value":"2021-01-07T17:16:36.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"2", "id":"Status" }, { "value":"17893", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"15" }, { "field":[ { "value":"b193827c-fc6b-450b-ac69-2c19aed3ddeb", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14251", "id":"UUID" }, { "value":"14", "id":"ID" }, { "value":"2021-01-07T14:57:04.0", "id":"Created" }, { "value":"testwebservice", "id":"CreatedUser" }, { "value":"2021-01-07T14:57:04.0", "id":"LastUpdate" }, { "value":"", "id":"LastUpdateUser" }, { "value":"4", "id":"Status" }, { "value":"17893", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"14" }, { "field":[ { "value":"840955f8-4ac9-42a9-b9a2-5cc3ea0c43c0", "id":"AccessID" }, { "value":"111", "id":"Mandator" }, { "value":"Verordnung", "id":"Type" }, { "value":"", "id":"EsurveyID" }, { "value":"", "id":"PeriodID" }, { "value":"14250", "id":"UUID" }, { "value":"13", "id":"ID" }, { "value":"2021-01-07T11:47:15.0", "id":"Created" }, { "value":"testwebservice", "id":"CreatedUser" }, { "value":"2021-01-07T14:25:37.0", "id":"LastUpdate" }, { "value":"testwebservice", "id":"LastUpdateUser" }, { "value":"128", "id":"Status" }, { "value":"17893", "id":"Owner" }, { "value":"", "id":"Sender" }, { "value":"", "id":"Parent" }, { "value":"", "id":"Info" }, { "value":"", "id":"Group" }, { "value":"de", "id":"FORM_LANG" } ], "xml":null, "json":null, "hasPDF":null, "hasAttachment":null, "seqID":"13" } ] }
- Keine Stichwörter