Package com.alfresco.process.apis
Interface TaskAPI
-
- All Implemented Interfaces:
@JvmSuppressWildcards() public interface TaskAPI
Marked as TaskAPI interface
-
-
Method Summary
Modifier and Type Method Description abstract ResultListtaskList(@Body() RequestTaskFilters filters)Api to fetch all the tasks abstract TaskDataEntrygetTaskDetails(@Path(value = "task_id") String taskID)Api to fetch the task details by taskID abstract ResultCommentsgetComments(@Path(value = "task_id") String taskID)Api to fetch the comments by taskID abstract CommentDataEntryaddComment(@Path(value = "task_id") String taskID, @Body() RequestComment requestComment)Api to add comment on the given taskID abstract ResultContentsgetContents(@Path(value = "task_id") String taskID, @Query(value = "isRelatedContent") Boolean isRelatedContent)Api to fetch the contents by taskID abstract Response<Unit>completeTask(@Path(value = "task_id") String taskID)Api to complete the task abstract Response<Unit>getRawContent(@Path(value = "task_id") String taskID)Api to get the raw contents abstract TaskDataEntrycreateTask(@Body() TaskBodyCreate taskBodyCreate)Api to get the create task abstract TaskDataEntryupdateTask(@Path(value = "task_id") String taskID, @Body() TaskBodyCreate taskBodyCreate)Api to update the task abstract TaskDataEntryassignUser(@Path(value = "task_id") String taskID, @Body() AssignUserBody assignUserBody)Api to assign task to other user abstract ResultUserListsearchUser(@Query(value = "filter") String filter, @Query(value = "email") String email)Api to search user on the process services abstract ContentDataEntryuploadRawContent(@Path(value = "task_id") String taskID, @Part() MultipartBody.Part multipartBody, @Query(value = "isRelatedContent") Boolean isRelatedContent)Api to upload the content for the give task id abstract ProfileDatagetProfile()Api to get the user profile abstract Response<Unit>deleteRawContent(@Path(value = "content_id") String contentId)Api to delete the content abstract ResultFormtaskForm(@Path(value = "task_id") String taskID)Api to get the task-form detail abstract Response<Unit>saveForm(@Path(value = "task_id") String taskId, @Body() RequestSaveForm saveFrom)Api to save the form abstract Response<Unit>taskFormAction(@Path(value = "task_id") String taskId, @Body() RequestOutcomes requestOutcome)Api to perform the action on outcomes abstract Response<Unit>claimTask(@Path(value = "task_id") String taskId)Api to perform the claim task abstract Response<Unit>unclaimTask(@Path(value = "task_id") String taskId)Api to perform the un-claim task abstract List<ResultFormVariables>taskFormVariables(@Path(value = "task_id") String taskId)Api to get the task-form variables -
-
Method Detail
-
taskList
@Headers(value = {"Content-type: application/json"})@POST(value = "api/enterprise/tasks/query") abstract ResultList taskList(@Body() RequestTaskFilters filters)Api to fetch all the tasks
-
getTaskDetails
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/tasks/{task_id}") abstract TaskDataEntry getTaskDetails(@Path(value = "task_id") String taskID)Api to fetch the task details by taskID
-
getComments
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/tasks/{task_id}/comments") abstract ResultComments getComments(@Path(value = "task_id") String taskID)Api to fetch the comments by taskID
-
addComment
@Headers(value = {"Content-type: application/json"})@POST(value = "api/enterprise/tasks/{task_id}/comments") abstract CommentDataEntry addComment(@Path(value = "task_id") String taskID, @Body() RequestComment requestComment)Api to add comment on the given taskID
-
getContents
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/tasks/{task_id}/content") abstract ResultContents getContents(@Path(value = "task_id") String taskID, @Query(value = "isRelatedContent") Boolean isRelatedContent)Api to fetch the contents by taskID
-
completeTask
@Headers(value = {"Content-type: application/json"})@PUT(value = "api/enterprise/tasks/{task_id}/action/complete") abstract Response<Unit> completeTask(@Path(value = "task_id") String taskID)Api to complete the task
-
getRawContent
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/content/{task_id}/raw") abstract Response<Unit> getRawContent(@Path(value = "task_id") String taskID)Api to get the raw contents
-
createTask
@Headers(value = {"Content-type: application/json"})@POST(value = "api/enterprise/tasks") abstract TaskDataEntry createTask(@Body() TaskBodyCreate taskBodyCreate)Api to get the create task
-
updateTask
@Headers(value = {"Content-type: application/json"})@PUT(value = "api/enterprise/tasks/{task_id}") abstract TaskDataEntry updateTask(@Path(value = "task_id") String taskID, @Body() TaskBodyCreate taskBodyCreate)Api to update the task
-
assignUser
@Headers(value = {"Content-type: application/json"})@PUT(value = "api/enterprise/tasks/{task_id}/action/assign") abstract TaskDataEntry assignUser(@Path(value = "task_id") String taskID, @Body() AssignUserBody assignUserBody)Api to assign task to other user
-
searchUser
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/users") abstract ResultUserList searchUser(@Query(value = "filter") String filter, @Query(value = "email") String email)Api to search user on the process services
-
uploadRawContent
@Multipart()@POST(value = "api/enterprise/tasks/{task_id}/raw-content") abstract ContentDataEntry uploadRawContent(@Path(value = "task_id") String taskID, @Part() MultipartBody.Part multipartBody, @Query(value = "isRelatedContent") Boolean isRelatedContent)Api to upload the content for the give task id
-
getProfile
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/profile") abstract ProfileData getProfile()Api to get the user profile
-
deleteRawContent
@Headers(value = {"Content-type: application/json"})@DELETE(value = "api/enterprise/content/{content_id}") abstract Response<Unit> deleteRawContent(@Path(value = "content_id") String contentId)Api to delete the content
-
taskForm
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/task-forms/{task_id}") abstract ResultForm taskForm(@Path(value = "task_id") String taskID)Api to get the task-form detail
-
saveForm
@Headers(value = {"Content-type: application/json"})@POST(value = "api/enterprise/task-forms/{task_id}/save-form") abstract Response<Unit> saveForm(@Path(value = "task_id") String taskId, @Body() RequestSaveForm saveFrom)Api to save the form
-
taskFormAction
@Headers(value = {"Content-type: application/json"})@POST(value = "api/enterprise/task-forms/{task_id}") abstract Response<Unit> taskFormAction(@Path(value = "task_id") String taskId, @Body() RequestOutcomes requestOutcome)Api to perform the action on outcomes
-
claimTask
@Headers(value = {"Content-type: application/json"})@PUT(value = "api/enterprise/tasks/{task_id}/action/claim") abstract Response<Unit> claimTask(@Path(value = "task_id") String taskId)Api to perform the claim task
-
unclaimTask
@Headers(value = {"Content-type: application/json"})@PUT(value = "api/enterprise/tasks/{task_id}/action/unclaim") abstract Response<Unit> unclaimTask(@Path(value = "task_id") String taskId)Api to perform the un-claim task
-
taskFormVariables
@Headers(value = {"Content-type: application/json"})@GET(value = "api/enterprise/task-forms/{task_id}/variables") abstract List<ResultFormVariables> taskFormVariables(@Path(value = "task_id") String taskId)Api to get the task-form variables
-
-
-
-