Workflow Action
A step taken in a workflow: who took it, with which role, on which record.
Area: The retailer's setup · Why it is here: recipe integration_user · Fields: 8
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/Workflow%20Action?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one, with its tables:
curl -s "https://⟨site⟩/api/resource/Workflow%20Action/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Your app reads it; it does not write it here: iVendNext writes it with each workflow step (apply_workflow). 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 | one of: Open, Completed | |||
| Reference Name | reference_name |
Dynamic Link | ||||
| Reference Document Type | reference_doctype |
Link | DocType | |||
| Workflow State | workflow_state |
Data | yes | |||
| Completed By Role | completed_by_role |
Link | yes | Role | ||
| Completed By User | completed_by |
Link | yes | User | ||
| Permitted Roles | permitted_roles |
Table MultiSelect | yes | Workflow Action Permitted Role | ||
| User | user |
Link | yes | User |
Table: Workflow Action Permitted Role
The rows of permitted_roles. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Role | role |
Link | Role |