Fire workflow action by name
Fires a workflow action, specified by name, on a target contentlet.
Returns a map of the resultant contentlet, with an additional AUTO_ASSIGN_WORKFLOW property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.
When chaining workflow actions or reading state back immediately after firing, pass indexPolicy=WAIT_FOR on each call. The default DEFER is asynchronous and can return stale index reads for several seconds, which can mimic server-side state bugs. For isolated one-off fires where nothing reads the result, leave the default.
Query parameters
Inode of the target content.
Identifier of target content.
Determines how target content is indexed.
| Value | Description |
|---|---|
| DEFER | Content will be indexed asynchronously, outside of the current process. Valid content will finish the method in process and be returned before the content becomes visible in the index. This is the default index policy; it is resource-friendly and well-suited to batch processing. |
| WAIT_FOR | The API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching. |
| FORCE | Forces Elasticsearch to index the content immediately.<br>Caution: Using this value may cause system performance issues; it is not recommended for general use, though may be useful for testing purposes. |
Language version of target content.
Request body
Response
Fired action successfully