module function · N/workflow
initiate()
workflow.initiate(options)
Initiates a workflow on-demand.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1workflow.initiate({2 recordId: /* string | number, required */,3 recordType: /* string, required */,4 workflowId: /* string | number, required */5});
| Parameter | Type | Required | Description |
|---|---|---|---|
| options.recordId | string | number | required | The internal ID of the base record. |
| options.recordType | string | required | The record type ID of the workflow base record. Use values from the record.Type enum. This is the Record Type field on the Workflow Definition Page . |
| options.workflowId | string | number | required | The internal ID (number) or script ID (string) for the workflow definition. This is the ID field on the Workflow Definition Page . |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to workflow.initiate(options) today. How should it read?
C
community proposals
Competing syntax for initiate, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
Write the Mynt you wish you could write.
A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.
- Clarity. Does it say what happens, without ceremony?
- Consistency. Does it read like
load,saveandRef[field]? - Expressiveness. Does it cover the cases people actually write?
- Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?