Input Arguments
Arg# | Name | Type | Description |
3 | 's' | Required. Constant 'retailmax.elink.tubt.list' | |
8 | 'E' | Maximum number of entries to return. | |
9 | 's' | Predicates to select data to return. | |
101 | 'E' | Data mode. Set to 1 to have actual call data returned as well. Not all call data can be expressed
in every output format, or may result in very large result packets. For example, when the original upload was a spreadsheet or image, then
the output will contain thay binary data. Caution is advised when using data mode.
XML output format cannot represent binary data reliably, so ignore binary data fields if using XML |
When calling this API a single API code can be supplied so that only transactions of a certain type are returned. The transaction code can be encoded with a predicate like
&9=f110,0,NNNWhere NNN is the "WantFunc" code required.
Output Arguments
The output of this API is an array of DATS packets. Each DATS packet describes a single request.
DATS Packet
Arg# | Name | Description |
f104 | DateTime | Date/Time the request was processed |
f105 | TranKey | Unique key identifying this record |
f108 | Bucket | Name of API requested |
f110 | WantFunc | Internal implementor function number. Each API calls to a numbered implementor and are simply a numeric form of the API name |
f114 | Security information reference key | |
f1001 | Description | A readable description of what the entry appears to contain. This is designed for display purposes only and should not be reverse processed by clients. |
Notes
Journal entries are maintained "best effort" and not guaranteed.
If using "data mode" to see original call information, you should refer to the individual API documentation on what the various arguments are specifying. This journal.list API only does superfical analysis of call data
Examples
Select all recent journal entries/gnap/buck?3=retailmax.elink.journal.listResult:
<ARAY> <DATS> <f104>2016|11|13|23|44|17||</f104> <f105>KQPQAAAAD98QD8ITAAI4ADQAAAEQAAAB</f105> <f114>KEPYFWYAD98QD8ITHXFEQCAAAABABQDZ</f114> <f108>retailmax.elink.stock.edit</f108> <f110>2011</f110> </DATS> <DATS> <f104>2016|11|13|23|43|45||</f104> <f105>KQPQAAAAD98QD8ITADW4ADQAAAEAAAAB</f105> <f114>KEPYFWYAD98QD8ITHXFEQCAAAABABQDZ</f114> <f108>retailmax.elink.utility.bulkload.file</f108> <f110>4010</f110> <f1001>"products.xlsx"</f1001> <DATA> <f131>"products.xlsx"</f131> </DATA> </DATS> </ARAY>
Retreive last change on a staff record.
First call to get a list of recent staff edit transactions
/gnap/buck?3=retailmax.elink.journal.list&9=f110,0,2101Result
<ARAY> <DATS> <f104>2017|1|5|6|16|32||</f104> <f105>KQPQAAAADUE8EG9ZAAQMIFQAAABQAAAB</f105> <f114>KEPYISIADUE8EG9ZKFGLIDYAAABABQCT</f114> <f108>retailmax.elink.staff.edit</f108> <f110>2101</f110> </DATS> <DATS> <f104>2017|1|5|6|15|36||</f104> <f105>KQPQAAAADUE8EG9ZADSMIFQAAAAQAAAB</f105> <f114>KEPYISIADUE8EG9ZKFGLIDYAAABABQCT</f114> <f108>retailmax.elink.staff.edit</f108> <f110>2101</f110> </DATS> </ARAY>
Now take the transaction key and fetch full details
Result
<ARAY> <DATS> <f104>2017|1|5|6|16|32||</f104> <f105>KQPQAAAADUE8EG9ZAAQMIFQAAABQAAAB</f105> <f114>KEPYISIADUE8EG9ZKFGLIDYAAABABQCT</f114> <f108>retailmax.elink.staff.edit</f108> <f110>2101</f110> <DATI> <f8>retailmax.elink.staff.edit</f8> <f11>69</f11> <f100>10</f100> <f101>Jim</f101> <f102>1</f102> <f107/> <f130>jem@example.com</f130> <f131/> </DATI> </DATS> </ARAY>
The following call shows a complete fetch of a bulk upload API call. The bulk upload API is used to upload spreadsheets, images, emails etc which then in turn call more APIs
/gnap/buck?3=retailmax.elink.journal.list&8=1&9=f110,0,4010&101=1A sample of the output might be
<ARAY> <DATS> <f104>2016|11|14|1|21|17||</f104> <f105>KQPQAAAAD98QD8ITABI4ADQAAAXQAAAB</f105> <f114>KEPYFWYAD98QD8ITHXFEQCAAAABABQDZ</f114> <f108>retailmax.elink.utility.bulkload.file</f108> « The API called <f110>4010</f110> <DATI> « Packet containing data passed to the API <f8>retailmax.elink.utility.bulkload.file</f8> <f11>69</f11> <f109>1</f109> <f100/> <f110>retailmax.elink.stock.edit</f110> « This is an argument to the API, not called directly <f111>82</f111> <f130> « Field with raw binary data PK..........!.q.9+p... .....Û.[Content_Types].xml ¢×. ... Some binary data removed ... ...docProps/app.xmlPK..............Ó..... </f130> <f131>"SpecialsForWeek.xlsx"</f131> <f17>1</f17> </DATI> <f1001>"SpecialsForWeek.xlsx"</f1001> <DATA> <f131>"SpecialsForWeek.xlsx"</f131> </DATA> </DATS> </ARAY>