DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

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

public class dtos
{

    /**
    * Get workflow task.
    */
    @Api(Description="Get workflow task.")
    public static class GetTaskOperation
    {
        /**
        * ID of the workflow task(s) to return
        */
        @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
        public Integer TaskID = null;
        
        public Integer getTaskID() { return TaskID; }
        public GetTaskOperation setTaskID(Integer value) { this.TaskID = value; return this; }
    }

    public static class WorkflowTaskDTO
    {
        public Integer ID = null;
        public String Name = null;
        public Integer WorkflowID = null;
        public String WorkflowDescription = null;
        public Integer RootWorkflowID = null;
        public UUID TransitionID = null;
        public String TransitionName = null;
        public UUID ActivationID = null;
        public Integer TypeID = null;
        public String TypeDescription = null;
        public Integer StatusID = null;
        public String StatusDescription = null;
        public Integer UserID = null;
        public Boolean Active = null;
        public Date OfferedDate = null;
        public Date AssignedDate = null;
        public Date StartDate = null;
        public Date ExpirationDate = null;
        public Integer Order = null;
        public Float Progress = null;
        public Date FinishedDate = null;
        public Integer FinishedByUserID = null;
        public UUID FinishedDocumentID = null;
        public Boolean Read = null;
        public Date DeferDate = null;
        public String DeferReason = null;
        public String Reason = null;
        public Boolean Urgent = null;
        public String Status = null;
        public ArrayList<WorkflowTaskActionDTO> AvailableActions = null;
        public ArrayList<WorkflowTaskActionDTO> FinishActions = null;
        public ArrayList<WorkflowTaskActionDTO> CommentActions = null;
        public ArrayList<WorkflowTaskActionDTO> DocumentActions = null;
        public Integer NumberOfComments = null;
        public String RelativeDetailLink = null;
        public Integer FirstSideStepID = null;
        public String FirstSideStepOmschr = null;
        public String FirstSideStepDetailLink = null;
        public Integer IsSideStepOfWorkflowID = null;
        public String IsSideStepOfWorkflowOmschr = null;
        public String IsSideStepOfWorkflowDetailLink = null;
        public Integer IsSideStepOfTaskID = null;
        public String IsSideStepOfTaskOmschr = null;
        public String IsSideStepOfTaskDetailLink = null;
        public Integer IsObservedID = null;
        public String IsObservedOmschr = null;
        public String IsObservedDetailLink = null;
        
        public Integer getId() { return ID; }
        public WorkflowTaskDTO setId(Integer value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public WorkflowTaskDTO setName(String value) { this.Name = value; return this; }
        public Integer getWorkflowID() { return WorkflowID; }
        public WorkflowTaskDTO setWorkflowID(Integer value) { this.WorkflowID = value; return this; }
        public String getWorkflowDescription() { return WorkflowDescription; }
        public WorkflowTaskDTO setWorkflowDescription(String value) { this.WorkflowDescription = value; return this; }
        public Integer getRootWorkflowID() { return RootWorkflowID; }
        public WorkflowTaskDTO setRootWorkflowID(Integer value) { this.RootWorkflowID = value; return this; }
        public UUID getTransitionID() { return TransitionID; }
        public WorkflowTaskDTO setTransitionID(UUID value) { this.TransitionID = value; return this; }
        public String getTransitionName() { return TransitionName; }
        public WorkflowTaskDTO setTransitionName(String value) { this.TransitionName = value; return this; }
        public UUID getActivationID() { return ActivationID; }
        public WorkflowTaskDTO setActivationID(UUID value) { this.ActivationID = value; return this; }
        public Integer getTypeID() { return TypeID; }
        public WorkflowTaskDTO setTypeID(Integer value) { this.TypeID = value; return this; }
        public String getTypeDescription() { return TypeDescription; }
        public WorkflowTaskDTO setTypeDescription(String value) { this.TypeDescription = value; return this; }
        public Integer getStatusID() { return StatusID; }
        public WorkflowTaskDTO setStatusID(Integer value) { this.StatusID = value; return this; }
        public String getStatusDescription() { return StatusDescription; }
        public WorkflowTaskDTO setStatusDescription(String value) { this.StatusDescription = value; return this; }
        public Integer getUserID() { return UserID; }
        public WorkflowTaskDTO setUserID(Integer value) { this.UserID = value; return this; }
        public Boolean isActive() { return Active; }
        public WorkflowTaskDTO setActive(Boolean value) { this.Active = value; return this; }
        public Date getOfferedDate() { return OfferedDate; }
        public WorkflowTaskDTO setOfferedDate(Date value) { this.OfferedDate = value; return this; }
        public Date getAssignedDate() { return AssignedDate; }
        public WorkflowTaskDTO setAssignedDate(Date value) { this.AssignedDate = value; return this; }
        public Date getStartDate() { return StartDate; }
        public WorkflowTaskDTO setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getExpirationDate() { return ExpirationDate; }
        public WorkflowTaskDTO setExpirationDate(Date value) { this.ExpirationDate = value; return this; }
        public Integer getOrder() { return Order; }
        public WorkflowTaskDTO setOrder(Integer value) { this.Order = value; return this; }
        public Float getProgress() { return Progress; }
        public WorkflowTaskDTO setProgress(Float value) { this.Progress = value; return this; }
        public Date getFinishedDate() { return FinishedDate; }
        public WorkflowTaskDTO setFinishedDate(Date value) { this.FinishedDate = value; return this; }
        public Integer getFinishedByUserID() { return FinishedByUserID; }
        public WorkflowTaskDTO setFinishedByUserID(Integer value) { this.FinishedByUserID = value; return this; }
        public UUID getFinishedDocumentID() { return FinishedDocumentID; }
        public WorkflowTaskDTO setFinishedDocumentID(UUID value) { this.FinishedDocumentID = value; return this; }
        public Boolean isRead() { return Read; }
        public WorkflowTaskDTO setRead(Boolean value) { this.Read = value; return this; }
        public Date getDeferDate() { return DeferDate; }
        public WorkflowTaskDTO setDeferDate(Date value) { this.DeferDate = value; return this; }
        public String getDeferReason() { return DeferReason; }
        public WorkflowTaskDTO setDeferReason(String value) { this.DeferReason = value; return this; }
        public String getReason() { return Reason; }
        public WorkflowTaskDTO setReason(String value) { this.Reason = value; return this; }
        public Boolean isUrgent() { return Urgent; }
        public WorkflowTaskDTO setUrgent(Boolean value) { this.Urgent = value; return this; }
        public String getStatus() { return Status; }
        public WorkflowTaskDTO setStatus(String value) { this.Status = value; return this; }
        public ArrayList<WorkflowTaskActionDTO> getAvailableActions() { return AvailableActions; }
        public WorkflowTaskDTO setAvailableActions(ArrayList<WorkflowTaskActionDTO> value) { this.AvailableActions = value; return this; }
        public ArrayList<WorkflowTaskActionDTO> getFinishActions() { return FinishActions; }
        public WorkflowTaskDTO setFinishActions(ArrayList<WorkflowTaskActionDTO> value) { this.FinishActions = value; return this; }
        public ArrayList<WorkflowTaskActionDTO> getCommentActions() { return CommentActions; }
        public WorkflowTaskDTO setCommentActions(ArrayList<WorkflowTaskActionDTO> value) { this.CommentActions = value; return this; }
        public ArrayList<WorkflowTaskActionDTO> getDocumentActions() { return DocumentActions; }
        public WorkflowTaskDTO setDocumentActions(ArrayList<WorkflowTaskActionDTO> value) { this.DocumentActions = value; return this; }
        public Integer getNumberOfComments() { return NumberOfComments; }
        public WorkflowTaskDTO setNumberOfComments(Integer value) { this.NumberOfComments = value; return this; }
        public String getRelativeDetailLink() { return RelativeDetailLink; }
        public WorkflowTaskDTO setRelativeDetailLink(String value) { this.RelativeDetailLink = value; return this; }
        public Integer getFirstSideStepID() { return FirstSideStepID; }
        public WorkflowTaskDTO setFirstSideStepID(Integer value) { this.FirstSideStepID = value; return this; }
        public String getFirstSideStepOmschr() { return FirstSideStepOmschr; }
        public WorkflowTaskDTO setFirstSideStepOmschr(String value) { this.FirstSideStepOmschr = value; return this; }
        public String getFirstSideStepDetailLink() { return FirstSideStepDetailLink; }
        public WorkflowTaskDTO setFirstSideStepDetailLink(String value) { this.FirstSideStepDetailLink = value; return this; }
        public Integer getIsSideStepOfWorkflowID() { return IsSideStepOfWorkflowID; }
        public WorkflowTaskDTO setIsSideStepOfWorkflowID(Integer value) { this.IsSideStepOfWorkflowID = value; return this; }
        public String getIsSideStepOfWorkflowOmschr() { return IsSideStepOfWorkflowOmschr; }
        public WorkflowTaskDTO setIsSideStepOfWorkflowOmschr(String value) { this.IsSideStepOfWorkflowOmschr = value; return this; }
        public String getIsSideStepOfWorkflowDetailLink() { return IsSideStepOfWorkflowDetailLink; }
        public WorkflowTaskDTO setIsSideStepOfWorkflowDetailLink(String value) { this.IsSideStepOfWorkflowDetailLink = value; return this; }
        public Integer getIsSideStepOfTaskID() { return IsSideStepOfTaskID; }
        public WorkflowTaskDTO setIsSideStepOfTaskID(Integer value) { this.IsSideStepOfTaskID = value; return this; }
        public String getIsSideStepOfTaskOmschr() { return IsSideStepOfTaskOmschr; }
        public WorkflowTaskDTO setIsSideStepOfTaskOmschr(String value) { this.IsSideStepOfTaskOmschr = value; return this; }
        public String getIsSideStepOfTaskDetailLink() { return IsSideStepOfTaskDetailLink; }
        public WorkflowTaskDTO setIsSideStepOfTaskDetailLink(String value) { this.IsSideStepOfTaskDetailLink = value; return this; }
        public Integer getIsObservedID() { return IsObservedID; }
        public WorkflowTaskDTO setIsObservedID(Integer value) { this.IsObservedID = value; return this; }
        public String getIsObservedOmschr() { return IsObservedOmschr; }
        public WorkflowTaskDTO setIsObservedOmschr(String value) { this.IsObservedOmschr = value; return this; }
        public String getIsObservedDetailLink() { return IsObservedDetailLink; }
        public WorkflowTaskDTO setIsObservedDetailLink(String value) { this.IsObservedDetailLink = value; return this; }
    }

    public static class WorkflowTaskActionDTO
    {
        public Boolean BeginGroup = null;
        public String DigiOfficeIcon = null;
        public Boolean Enabled = null;
        public String FontAwesomeIcon = null;
        public String Hint = null;
        public String Name = null;
        public Boolean ShowTextForRootItems = null;
        public String Text = null;
        public String Url = null;
        public ArrayList<WorkflowTaskActionDTO> Items = null;
        
        public Boolean isBeginGroup() { return BeginGroup; }
        public WorkflowTaskActionDTO setBeginGroup(Boolean value) { this.BeginGroup = value; return this; }
        public String getDigiOfficeIcon() { return DigiOfficeIcon; }
        public WorkflowTaskActionDTO setDigiOfficeIcon(String value) { this.DigiOfficeIcon = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public WorkflowTaskActionDTO setEnabled(Boolean value) { this.Enabled = value; return this; }
        public String getFontAwesomeIcon() { return FontAwesomeIcon; }
        public WorkflowTaskActionDTO setFontAwesomeIcon(String value) { this.FontAwesomeIcon = value; return this; }
        public String getHint() { return Hint; }
        public WorkflowTaskActionDTO setHint(String value) { this.Hint = value; return this; }
        public String getName() { return Name; }
        public WorkflowTaskActionDTO setName(String value) { this.Name = value; return this; }
        public Boolean isShowTextForRootItems() { return ShowTextForRootItems; }
        public WorkflowTaskActionDTO setShowTextForRootItems(Boolean value) { this.ShowTextForRootItems = value; return this; }
        public String getText() { return Text; }
        public WorkflowTaskActionDTO setText(String value) { this.Text = value; return this; }
        public String getUrl() { return Url; }
        public WorkflowTaskActionDTO setUrl(String value) { this.Url = value; return this; }
        public ArrayList<WorkflowTaskActionDTO> getItems() { return Items; }
        public WorkflowTaskActionDTO setItems(ArrayList<WorkflowTaskActionDTO> value) { this.Items = value; return this; }
    }

}

Java GetTaskOperation DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":0,"Name":"String","WorkflowID":0,"WorkflowDescription":"String","RootWorkflowID":0,"TransitionID":"00000000-0000-0000-0000-000000000000","TransitionName":"String","ActivationID":"00000000-0000-0000-0000-000000000000","TypeID":0,"TypeDescription":"String","StatusID":0,"StatusDescription":"String","UserID":0,"Active":false,"OfferedDate":"0001-01-01T00:00:00.0000000","AssignedDate":"0001-01-01T00:00:00.0000000","StartDate":"0001-01-01T00:00:00.0000000","ExpirationDate":"0001-01-01T00:00:00.0000000","Order":0,"Progress":0,"FinishedDate":"0001-01-01T00:00:00.0000000","FinishedByUserID":0,"FinishedDocumentID":"00000000-0000-0000-0000-000000000000","Read":false,"DeferDate":"0001-01-01T00:00:00.0000000","DeferReason":"String","Reason":"String","Urgent":false,"Status":"String","AvailableActions":null,"FinishActions":null,"CommentActions":null,"DocumentActions":null,"NumberOfComments":0,"RelativeDetailLink":"String","FirstSideStepID":0,"FirstSideStepOmschr":"String","FirstSideStepDetailLink":"String","IsSideStepOfWorkflowID":0,"IsSideStepOfWorkflowOmschr":"String","IsSideStepOfWorkflowDetailLink":"String","IsSideStepOfTaskID":0,"IsSideStepOfTaskOmschr":"String","IsSideStepOfTaskDetailLink":"String","IsObservedID":0,"IsObservedOmschr":"String","IsObservedDetailLink":"String"}