Actions Available in the PTC Workflow Domain
The following actions are available in the PTC Workflow domain:
CompleteWorkitem
The CompleteWorkitem action completes the specified task. The action is bound to the Workitem entity.
You must provide the following mandatory parameters as input to the action in the request body:
{
"UserEventList":[<routing_options >],
"WorkitemComment":"<comment_for_the_workitem>",
"VoteAction":"<Vote_option_selected_by_the_participant>",
"AutomateFastTrack":<option_to_specify_if_change_notice_should_be_explicitly_created, valid values true or false>,
"Variables":[<workflow_activity_variables>]
}
"UserEventList":[<routing_options >],
"WorkitemComment":"<comment_for_the_workitem>",
"VoteAction":"<Vote_option_selected_by_the_participant>",
"AutomateFastTrack":<option_to_specify_if_change_notice_should_be_explicitly_created, valid values true or false>,
"Variables":[<workflow_activity_variables>]
}
SaveWorkitem
The SaveWorkitem action saves the specified task. The action is bound to the Workitem entity.
You must provide the following mandatory parameters as input to the action in the request body:
{
"UserEventList":[<routing_options >],
"WorkitemComment":"<comment_for_the_workitem>",
"VoteAction":"<Vote_option_selected_by_the_participant>",
"AutomateFastTrack":<option_to_specify_if_change_notice_should_be_explicitly_created, valid values true or false>,
"Variables":[<workflow_activity_variables>]
}
"UserEventList":[<routing_options >],
"WorkitemComment":"<comment_for_the_workitem>",
"VoteAction":"<Vote_option_selected_by_the_participant>",
"AutomateFastTrack":<option_to_specify_if_change_notice_should_be_explicitly_created, valid values true or false>,
"Variables":[<workflow_activity_variables>]
}
ReassignWorkItems
The ReassignWorkItems action reassigns the work items or tasks to a specified user. This is an unbound action.
You should provide the following parameters as input to the action in the request body. You can pass the corresponding entities or entity IDs as input parameters.
• WorkItems—Mandatory parameter. List of work item entities.
 |
While reassigning the work items, if you pass all the attributes of a work item as input, the action only considers the work item ID attribute. The other work item attributes are ignored.
|
• User—Mandatory parameter. User entity.
• Comment—Optional parameter. User comment.
• RestrictReassignToRole—Optional parameter to restrict reassignment of task to only users who are associated with the role or resource pool specified in the task. Can have a value of true or false.
{
"WorkItems":[{"ID":"<workitem_entity_ID>"}],
"User":{"ID":"<user_entity_ID>"},
"Comment":"<user_comment>"
.."RestrictReassignToRole":<true or false>
}
"WorkItems":[{"ID":"<workitem_entity_ID>"}],
"User":{"ID":"<user_entity_ID>"},
"Comment":"<user_comment>"
.."RestrictReassignToRole":<true or false>
}