Workflow

Fire system action by name

Fire a default system action 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.

put/api/v1/workflow/actions/default/fire/{systemAction}

Path parameters

systemAction'NEW' | 'EDIT' | 'PUBLISH' | 'UNPUBLISH' | 'ARCHIVE' | 'UNARCHIVE' | 'DELETE' | 'DESTROY' required

Default system action.

Query parameters

inodestring

Inode of the target content.

identifierstring

Identifier of target content.

indexPolicy'DEFER' | 'WAIT_FOR' | 'FORCE'

Determines how target content is indexed.

ValueDescription
DEFERContent 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_FORThe API call will not return from the content check process until the content has been indexed. Ensures content is promptly available for searching.
FORCEForces 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.
languagestring

Language version of target content.

Request body

commentsstring
assignstring
publishDatestring
publishTimestring
expireDatestring
expireTimestring
neverExpirestring
whereToSendstring
filterKeystring
querystring
pathToMovestring
timezoneIdstring
individualPermissionsobject
actionNamestring
iwantTostring
contentletobject

Response

Fired action successfully

entityobject
i18nMessagesMapobject
permissionsstring[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.