Take Action on a Workflow Task.
post
/content/management/api/v1.1/items/{id}/workflowAction
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
id of the item.
Query Parameters
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Task status is updated based on the given information in the payload. The fields items and failedItems will be ignored even if given in the payload.
Root Schema : WorkflowActionBean
Type:
object
WorkflowActionBean
Show Source
-
comments(optional):
string
comments related to the action taken
-
failedItems(optional):
array failedItems
items on which the action failed
-
items(optional):
array items
-
tasks(optional):
array tasks
Item to tasks mapping
-
value(optional):
string
action applied on the items
Nested Schema : tasks
Type:
array
Item to tasks mapping
Show Source
-
Array of:
object TaskItemMapping
TaskItemMapping
Nested Schema : FailedItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
message(optional):
string
failed item message.
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
Nested Schema : ItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : TaskItemMapping
Type:
object
TaskItemMapping
Show Source
-
itemId(optional):
string
id of the item.
-
taskId(optional):
string
id of the workflow task.
Response
Supported Media Types
- application/json
200 Response
OK.
400 Response
Bad request.
404 Response
Not found.
500 Response
Internal server error.