Workflow

Fire system action by name over multiple contentlets

Changed on

Fire a default system action by name on multiple target contentlets.

Returns a list of resultant contentlet maps, each with an additional AUTO_ASSIGN_WORKFLOW property, which can be referenced by delegate services that handle automatically assigning workflow schemes to content with none.

This is the multi-contentlet variant and returns a list envelope (entity.results[]). To fire on a single contentlet, use PUT on this same path instead — it returns the single resultant contentlet map (with its identifier) directly.

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

Request

Path parameters

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

Default system action.

Request body

commentsstring
assignstring
publishDatestring
publishTimestring
expireDatestring
expireTimestring
neverExpirestring
whereToSendstring
filterKeystring
timezoneIdstring
iwantTostring
contentletobject[]

Response

Fired action successfully

Changes

    • info

      added the new enum value LOCK to the path request parameter systemAction

    • info

      added the new enum value UNLOCK to the path request parameter systemAction