Prepared Report
One run of a report prepared in the background, and its result.
Area: Your app: its install, its user and its doors · Why it is here: recipe shop_reports · Fields: 9
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Prepared%20Report?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Prepared%20Report/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: prepare_report makes it. All the record calls and their answers: the API reference.
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Status | status |
Select | yes | yes | one of: Error, Queued, Completed, Started | |
| Report Name | report_name |
Data | yes | yes | ||
| Queued By | queued_by |
Data | yes | |||
| Job ID | job_id |
Data | yes | |||
| Queued At | queued_at |
Datetime | yes | |||
| Finished At | report_end_time |
Datetime | yes | |||
| Peak Memory Usage | peak_memory_usage |
Int | yes | |||
| Error Message | error_message |
Text | yes | |||
| Filters | filters |
Small Text | yes | yes |