DocumentsBySearchCriteria: Yuki Documents by Search Criteria
read only XML
- Catalog:
Yuki - Schema:
Archive - Label: Documents by Search Criteria
Can only retrieve data.
API Source
- XML service:
https://api.yukiworks.nl/ws/Archive.asmx - XML topic:
SearchDocuments - XML path:
/tns:SearchDocumentsResult/Documents/Document
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 31 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
document |
`` | |||
end |
`` | |||
folder |
`` | Yuki answers an internal error without the folder of the documents to search. | ||
search |
`` | All or Creator or Contact or Subject or Tag or Type | ||
search |
`` | |||
sort |
`` | CreatedDesc or CreatedAsc or ModifiedDesc or ModifiedAsc or DocumentDateDesc or DocumentDateAsc or ContactNameAsc or ContactNameDesc | ||
start |
`` | |||
tabID |
`` | Yuki answers an internal error without the tab of the documents to search. |
Table Columns
The columns of the table DocumentsBySearchCriteria are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
AMOUNT |
decimal |
Amount | / |
||
CONTACTNAME |
varchar2 |
itgen_yuki_contactname | / |
||
CONTENTTYPE |
varchar2 |
itgen_yuki_contenttype | / |
||
CREATED |
datetime |
itgen_yuki_created | / |
||
CREATOR |
varchar2 |
itgen_yuki_creator | / |
||
DOCUMENTDATE |
datetime |
itgen_yuki_documentdate | / |
||
DOMAINID |
varchar2 |
Domain ID | |||
DOMAINNAME |
varchar2 |
Domain Name | |||
FILENAME |
varchar2 |
File Name | / |
||
FILESIZE |
int32 |
itgen_yuki_filesize | / |
||
FOLDERDESCRIPTION |
varchar2 |
itgen_yuki_folderdescription | / |
||
FOLDERID |
varchar2 |
itgen_yuki_folderid | / |
||
ID |
varchar2 |
ID | / |
||
MODIFIED |
datetime |
itgen_yuki_modified | / |
||
MODIFIER |
varchar2 |
itgen_yuki_modifier | / |
||
PAYMENTID |
varchar2 |
itgen_yuki_paymentid | / |
||
PAYMENTREFERENCE |
varchar2 |
itgen_yuki_paymentreference | / |
||
SUBJECT |
varchar2 |
itgen_yuki_subject | / |
||
TABDESCRIPTION |
varchar2 |
itgen_yuki_tabdescription | / |
||
TABID |
varchar2 |
itgen_yuki_tabid | / |
||
TYPE |
varchar2 |
Type | / |
||
TYPEDESCRIPTION |
varchar2 |
itgen_yuki_typedescription | / |
||
VATAMOUNT |
decimal |
itgen_yuki_vatamount | / |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver:
Changes of This Table, 26.0 to 27.0
Parameter folderID of Yuki.Archive.DocumentsBySearchCriteria: presence required changes
Presence required changes from false to true. Without these parameters Yuki already answered with an internal error, so no working statement is affected.
false→true- importance 3
Parameter tabID of Yuki.Archive.DocumentsBySearchCriteria: presence required changes
Presence required changes from false to true. Without these parameters Yuki already answered with an internal error, so no working statement is affected.
false→true- importance 3
Yuki.Archive.DocumentsBySearchCriteria: table parameters changes
Table parameters of Yuki.Archive.DocumentsBySearchCriteria changes from documentID, searchOption, searchText, folderID, tabID, startDate, endDate to documentID, searchOption, searchText, folderID, tabID, startDate, endDate, sortOrder.
documentID, searchOption, searchText, folderID, tabID, startDate, endDate→documentID, searchOption, searchText, folderID, tabID, startDate, endDate, sortOrder- importance 3
Parameter sortOrder is added to Yuki.Archive.DocumentsBySearchCriteria
Optional.
- importance 2
+PAYMENTID(varchar2)+PAYMENTREFERENCE(varchar2)+VATAMOUNT(decimal)