DigiOffice Gateway Web Services

<back to all web services

StartSideStep

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class StartSideStep
    {
        public Integer ProcessID = null;
        public Integer WorkflowTaskID = null;
        public SideStepDetails Details = null;
        
        public Integer getProcessID() { return ProcessID; }
        public StartSideStep setProcessID(Integer value) { this.ProcessID = value; return this; }
        public Integer getWorkflowTaskID() { return WorkflowTaskID; }
        public StartSideStep setWorkflowTaskID(Integer value) { this.WorkflowTaskID = value; return this; }
        public SideStepDetails getDetails() { return Details; }
        public StartSideStep setDetails(SideStepDetails value) { this.Details = value; return this; }
    }

    public static class SideStepDetails extends AdhocTransitionDetails
    {
        public User Coordinator = null;
        public WorkflowTaskActionComment Comment = null;
        public Boolean Urgent = null;
        
        public User getCoordinator() { return Coordinator; }
        public SideStepDetails setCoordinator(User value) { this.Coordinator = value; return this; }
        public WorkflowTaskActionComment getComment() { return Comment; }
        public SideStepDetails setComment(WorkflowTaskActionComment value) { this.Comment = value; return this; }
        public Boolean isUrgent() { return Urgent; }
        public SideStepDetails setUrgent(Boolean value) { this.Urgent = value; return this; }
    }

    public static class AdhocTransitionDetails
    {
        public ArrayList<WorkflowTaskAdhocTransition> AdhocTransitions = null;
        
        public ArrayList<WorkflowTaskAdhocTransition> getAdhocTransitions() { return AdhocTransitions; }
        public AdhocTransitionDetails setAdhocTransitions(ArrayList<WorkflowTaskAdhocTransition> value) { this.AdhocTransitions = value; return this; }
    }

    public static class WorkflowTaskAdhocTransition
    {
        public UUID ID = null;
        public String Title = null;
        public Boolean AssignmentAllowed = null;
        public Boolean AssignmentRequired = null;
        public Integer UserEnvironment = null;
        public ArrayList<User> Users = null;
        public ArrayList<Group> Groups = null;
        public WorkflowTaskDelay Delay = null;
        public WorkflowTaskReason Reason = null;
        public ArrayList<UserOrGroup> UsersOrGroups = null;
        public String Value = null;
        
        public UUID getId() { return ID; }
        public WorkflowTaskAdhocTransition setId(UUID value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public WorkflowTaskAdhocTransition setTitle(String value) { this.Title = value; return this; }
        public Boolean isAssignmentAllowed() { return AssignmentAllowed; }
        public WorkflowTaskAdhocTransition setAssignmentAllowed(Boolean value) { this.AssignmentAllowed = value; return this; }
        public Boolean isAssignmentRequired() { return AssignmentRequired; }
        public WorkflowTaskAdhocTransition setAssignmentRequired(Boolean value) { this.AssignmentRequired = value; return this; }
        public Integer getUserEnvironment() { return UserEnvironment; }
        public WorkflowTaskAdhocTransition setUserEnvironment(Integer value) { this.UserEnvironment = value; return this; }
        public ArrayList<User> getUsers() { return Users; }
        public WorkflowTaskAdhocTransition setUsers(ArrayList<User> value) { this.Users = value; return this; }
        public ArrayList<Group> getGroups() { return Groups; }
        public WorkflowTaskAdhocTransition setGroups(ArrayList<Group> value) { this.Groups = value; return this; }
        public WorkflowTaskDelay getDelay() { return Delay; }
        public WorkflowTaskAdhocTransition setDelay(WorkflowTaskDelay value) { this.Delay = value; return this; }
        public WorkflowTaskReason getReason() { return Reason; }
        public WorkflowTaskAdhocTransition setReason(WorkflowTaskReason value) { this.Reason = value; return this; }
        public ArrayList<UserOrGroup> getUsersOrGroups() { return UsersOrGroups; }
        public WorkflowTaskAdhocTransition setUsersOrGroups(ArrayList<UserOrGroup> value) { this.UsersOrGroups = value; return this; }
        public String getValue() { return Value; }
        public WorkflowTaskAdhocTransition setValue(String value) { this.Value = value; return this; }
    }

    public static class User extends UserOrGroup
    {
        public String Image = null;
        
        public String getImage() { return Image; }
        public User setImage(String value) { this.Image = value; return this; }
    }

    public static class UserOrGroup
    {
        public Integer ID = null;
        public String Title = null;
        public Boolean IsChecked = null;
        public String Image = null;
        
        public Integer getId() { return ID; }
        public UserOrGroup setId(Integer value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public UserOrGroup setTitle(String value) { this.Title = value; return this; }
        public Boolean getIsChecked() { return IsChecked; }
        public UserOrGroup setIsChecked(Boolean value) { this.IsChecked = value; return this; }
        public String getImage() { return Image; }
        public UserOrGroup setImage(String value) { this.Image = value; return this; }
    }

    public static class Group extends UserOrGroup
    {
        public String Image = null;
        
        public String getImage() { return Image; }
        public Group setImage(String value) { this.Image = value; return this; }
    }

    public static class WorkflowTaskDelay
    {
        public Date DelayDate = null;
        public String Reason = null;
        
        public Date getDelayDate() { return DelayDate; }
        public WorkflowTaskDelay setDelayDate(Date value) { this.DelayDate = value; return this; }
        public String getReason() { return Reason; }
        public WorkflowTaskDelay setReason(String value) { this.Reason = value; return this; }
    }

    public static class WorkflowTaskReason
    {
        public String Reason = null;
        public Boolean Required = null;
        
        public String getReason() { return Reason; }
        public WorkflowTaskReason setReason(String value) { this.Reason = value; return this; }
        public Boolean isRequired() { return Required; }
        public WorkflowTaskReason setRequired(Boolean value) { this.Required = value; return this; }
    }

    public static class WorkflowTaskActionComment
    {
        public String Comment = null;
        public Boolean Required = null;
        
        public String getComment() { return Comment; }
        public WorkflowTaskActionComment setComment(String value) { this.Comment = value; return this; }
        public Boolean isRequired() { return Required; }
        public WorkflowTaskActionComment setRequired(Boolean value) { this.Required = value; return this; }
    }

}

Java StartSideStep DTOs

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

HTTP + JSV

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

POST /jsv/oneway/StartSideStep HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProcessID: 0,
	WorkflowTaskID: 0,
	Details: 
	{
		Coordinator: 
		{
			Image: Icons/User,
			ID: 0,
			Title: String,
			IsChecked: False
		},
		Comment: 
		{
			Comment: String,
			Required: False
		},
		Urgent: False,
		AdhocTransitions: 
		[
			{
				Title: String,
				AssignmentAllowed: False,
				AssignmentRequired: False,
				UserEnvironment: 0,
				Users: 
				[
					{
						Image: Icons/User,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Groups: 
				[
					{
						Image: Icons/Group,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Delay: 
				{
					DelayDate: 0001-01-01,
					Reason: String
				},
				Reason: 
				{
					Reason: String,
					Required: False
				},
				UsersOrGroups: 
				[
					{
						__type: "IDB.API.DTO.User, IDB.API.DTO",
						Image: Icons/User,
						ID: 0,
						Title: String,
						IsChecked: False
					},
					{
						__type: "IDB.API.DTO.Group, IDB.API.DTO",
						Image: Icons/Group,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Value: "String
String"
			}
		]
	}
}