DigiOffice API Services Services

<back to all web services

FinishTaskOperation

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/finish
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FinishTaskOperation
    {
        public ArrayList<Integer> TaskIDs = null;
        public UUID WSVerbindingID = null;
        public ArrayList<WorkflowTransitionDTO> Transitions = null;
        public Date DeferTo = null;
        public String Reason = null;
        public String Comment = null;
        
        public ArrayList<Integer> getTaskIDs() { return TaskIDs; }
        public FinishTaskOperation setTaskIDs(ArrayList<Integer> value) { this.TaskIDs = value; return this; }
        public UUID getWsVerbindingID() { return WSVerbindingID; }
        public FinishTaskOperation setWsVerbindingID(UUID value) { this.WSVerbindingID = value; return this; }
        public ArrayList<WorkflowTransitionDTO> getTransitions() { return Transitions; }
        public FinishTaskOperation setTransitions(ArrayList<WorkflowTransitionDTO> value) { this.Transitions = value; return this; }
        public Date getDeferTo() { return DeferTo; }
        public FinishTaskOperation setDeferTo(Date value) { this.DeferTo = value; return this; }
        public String getReason() { return Reason; }
        public FinishTaskOperation setReason(String value) { this.Reason = value; return this; }
        public String getComment() { return Comment; }
        public FinishTaskOperation setComment(String value) { this.Comment = value; return this; }
    }

    public static class WorkflowTransitionDTO
    {
        public UUID ID = null;
        public String Name = null;
        public Boolean AssignmentAtStartWorkflowIsAdHoc = null;
        public Boolean AssignmentIsAdHocRequired = null;
        public Boolean DeferAtStartWorkflowIsAdHoc = null;
        public Boolean IsNext = null;
        public ArrayList<Integer> UserIDs = null;
        public ArrayList<Integer> GroupIDs = null;
        public ArrayList<Integer> RoleIDs = null;
        public Date DeferUntil = null;
        public String DeferralNote = null;
        
        public UUID getId() { return ID; }
        public WorkflowTransitionDTO setId(UUID value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public WorkflowTransitionDTO setName(String value) { this.Name = value; return this; }
        public Boolean isAssignmentAtStartWorkflowIsAdHoc() { return AssignmentAtStartWorkflowIsAdHoc; }
        public WorkflowTransitionDTO setAssignmentAtStartWorkflowIsAdHoc(Boolean value) { this.AssignmentAtStartWorkflowIsAdHoc = value; return this; }
        public Boolean isAssignmentIsAdHocRequired() { return AssignmentIsAdHocRequired; }
        public WorkflowTransitionDTO setAssignmentIsAdHocRequired(Boolean value) { this.AssignmentIsAdHocRequired = value; return this; }
        public Boolean isDeferAtStartWorkflowIsAdHoc() { return DeferAtStartWorkflowIsAdHoc; }
        public WorkflowTransitionDTO setDeferAtStartWorkflowIsAdHoc(Boolean value) { this.DeferAtStartWorkflowIsAdHoc = value; return this; }
        public Boolean getIsNext() { return IsNext; }
        public WorkflowTransitionDTO setIsNext(Boolean value) { this.IsNext = value; return this; }
        public ArrayList<Integer> getUserIDs() { return UserIDs; }
        public WorkflowTransitionDTO setUserIDs(ArrayList<Integer> value) { this.UserIDs = value; return this; }
        public ArrayList<Integer> getGroupIDs() { return GroupIDs; }
        public WorkflowTransitionDTO setGroupIDs(ArrayList<Integer> value) { this.GroupIDs = value; return this; }
        public ArrayList<Integer> getRoleIDs() { return RoleIDs; }
        public WorkflowTransitionDTO setRoleIDs(ArrayList<Integer> value) { this.RoleIDs = value; return this; }
        public Date getDeferUntil() { return DeferUntil; }
        public WorkflowTransitionDTO setDeferUntil(Date value) { this.DeferUntil = value; return this; }
        public String getDeferralNote() { return DeferralNote; }
        public WorkflowTransitionDTO setDeferralNote(String value) { this.DeferralNote = value; return this; }
    }

}

Java FinishTaskOperation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/workflowtasks/finish HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinishTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Comment>String</Comment>
  <DeferTo>0001-01-01T00:00:00</DeferTo>
  <Reason>String</Reason>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
  <Transitions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs" i:nil="true" />
  <WSVerbindingID>00000000-0000-0000-0000-000000000000</WSVerbindingID>
</FinishTaskOperation>