tvpl.api

<back to all web services

GetWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/by-workflow
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetWorkflowStepRequest
    {
        public Integer workflowId = null;
        
        public Integer getWorkflowId() { return workflowId; }
        public GetWorkflowStepRequest setWorkflowId(Integer value) { this.workflowId = value; return this; }
    }

    public static class GetWorkflowStepResponse implements IResponseRequest
    {
        public Integer code = null;
        public String message = null;
        public ArrayList<WorkflowStepDetail> data = null;
        
        public Integer getCode() { return code; }
        public GetWorkflowStepResponse setCode(Integer value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public GetWorkflowStepResponse setMessage(String value) { this.message = value; return this; }
        public ArrayList<WorkflowStepDetail> getData() { return data; }
        public GetWorkflowStepResponse setData(ArrayList<WorkflowStepDetail> value) { this.data = value; return this; }
    }

    public static class WorkflowStepDetail extends WorkflowStep
    {
        public ArrayList<Category> departments = null;
        public ArrayList<SimpleDocumentRelation> basisDocuments = null;
        public ArrayList<SimpleDocumentRelation> attachedDocuments = null;
        public ArrayList<SimpleDocumentRelation> referenceDocuments = null;
        public ArrayList<WorkFlowProfile> mainAssignees = null;
        public ArrayList<UploadedFileAttach> attachFiles = null;
        
        public ArrayList<Category> getDepartments() { return departments; }
        public WorkflowStepDetail setDepartments(ArrayList<Category> value) { this.departments = value; return this; }
        public ArrayList<SimpleDocumentRelation> getBasisDocuments() { return basisDocuments; }
        public WorkflowStepDetail setBasisDocuments(ArrayList<SimpleDocumentRelation> value) { this.basisDocuments = value; return this; }
        public ArrayList<SimpleDocumentRelation> getAttachedDocuments() { return attachedDocuments; }
        public WorkflowStepDetail setAttachedDocuments(ArrayList<SimpleDocumentRelation> value) { this.attachedDocuments = value; return this; }
        public ArrayList<SimpleDocumentRelation> getReferenceDocuments() { return referenceDocuments; }
        public WorkflowStepDetail setReferenceDocuments(ArrayList<SimpleDocumentRelation> value) { this.referenceDocuments = value; return this; }
        public ArrayList<WorkFlowProfile> getMainAssignees() { return mainAssignees; }
        public WorkflowStepDetail setMainAssignees(ArrayList<WorkFlowProfile> value) { this.mainAssignees = value; return this; }
        public ArrayList<UploadedFileAttach> getAttachFiles() { return attachFiles; }
        public WorkflowStepDetail setAttachFiles(ArrayList<UploadedFileAttach> value) { this.attachFiles = value; return this; }
    }

    public static class WorkflowStep
    {
        public Integer id = null;
        @References(Document.class)
        public Integer workflowId = null;

        public Integer stepOrder = null;
        @Required()
        @StringLength(255)
        public String stepName = null;

        @Required()
        public Boolean isRequired = null;

        public Integer slaLegalValue = null;
        public Boolean slaLegalIsByDay = null;
        public Integer slaInternalValue = null;
        public Boolean slaInternalIsByDay = null;
        public Boolean requireAttachment = null;
        @Required()
        public String description = null;

        public Integer createdBy = null;
        @Ignore()
        public ArrayList<Integer> departmentIds = null;

        @Ignore()
        public ArrayList<Integer> stepBasisDocumentIds = null;

        @Ignore()
        public ArrayList<Integer> stepAttachedIds = null;

        @Ignore()
        public ArrayList<Integer> mainAssigneeIds = null;
        
        public Integer getId() { return id; }
        public WorkflowStep setId(Integer value) { this.id = value; return this; }
        public Integer getWorkflowId() { return workflowId; }
        public WorkflowStep setWorkflowId(Integer value) { this.workflowId = value; return this; }
        public Integer getStepOrder() { return stepOrder; }
        public WorkflowStep setStepOrder(Integer value) { this.stepOrder = value; return this; }
        public String getStepName() { return stepName; }
        public WorkflowStep setStepName(String value) { this.stepName = value; return this; }
        public Boolean getIsRequired() { return isRequired; }
        public WorkflowStep setIsRequired(Boolean value) { this.isRequired = value; return this; }
        public Integer getSlaLegalValue() { return slaLegalValue; }
        public WorkflowStep setSlaLegalValue(Integer value) { this.slaLegalValue = value; return this; }
        public Boolean isSlaLegalIsByDay() { return slaLegalIsByDay; }
        public WorkflowStep setSlaLegalIsByDay(Boolean value) { this.slaLegalIsByDay = value; return this; }
        public Integer getSlaInternalValue() { return slaInternalValue; }
        public WorkflowStep setSlaInternalValue(Integer value) { this.slaInternalValue = value; return this; }
        public Boolean isSlaInternalIsByDay() { return slaInternalIsByDay; }
        public WorkflowStep setSlaInternalIsByDay(Boolean value) { this.slaInternalIsByDay = value; return this; }
        public Boolean isRequireAttachment() { return requireAttachment; }
        public WorkflowStep setRequireAttachment(Boolean value) { this.requireAttachment = value; return this; }
        public String getDescription() { return description; }
        public WorkflowStep setDescription(String value) { this.description = value; return this; }
        public Integer getCreatedBy() { return createdBy; }
        public WorkflowStep setCreatedBy(Integer value) { this.createdBy = value; return this; }
        public ArrayList<Integer> getDepartmentIds() { return departmentIds; }
        public WorkflowStep setDepartmentIds(ArrayList<Integer> value) { this.departmentIds = value; return this; }
        public ArrayList<Integer> getStepBasisDocumentIds() { return stepBasisDocumentIds; }
        public WorkflowStep setStepBasisDocumentIds(ArrayList<Integer> value) { this.stepBasisDocumentIds = value; return this; }
        public ArrayList<Integer> getStepAttachedIds() { return stepAttachedIds; }
        public WorkflowStep setStepAttachedIds(ArrayList<Integer> value) { this.stepAttachedIds = value; return this; }
        public ArrayList<Integer> getMainAssigneeIds() { return mainAssigneeIds; }
        public WorkflowStep setMainAssigneeIds(ArrayList<Integer> value) { this.mainAssigneeIds = value; return this; }
    }

    public static class Category extends CreateCategoryModel
    {
        public Integer id = null;
        public Integer level = null;
        public Integer sortOrder = null;
        public Date lastUpdate = null;
        @Ignore()
        public ArrayList<Category> children = null;
        
        public Integer getId() { return id; }
        public Category setId(Integer value) { this.id = value; return this; }
        public Integer getLevel() { return level; }
        public Category setLevel(Integer value) { this.level = value; return this; }
        public Integer getSortOrder() { return sortOrder; }
        public Category setSortOrder(Integer value) { this.sortOrder = value; return this; }
        public Date getLastUpdate() { return lastUpdate; }
        public Category setLastUpdate(Date value) { this.lastUpdate = value; return this; }
        public ArrayList<Category> getChildren() { return children; }
        public Category setChildren(ArrayList<Category> value) { this.children = value; return this; }
    }

    public static class CreateCategoryModel
    {
        public String name = null;
        public String description = null;
        public CategoryTypes type = null;
        public Boolean isParty = null;
        @Ignore()
        public ArrayList<Integer> childList = null;
        
        public String getName() { return name; }
        public CreateCategoryModel setName(String value) { this.name = value; return this; }
        public String getDescription() { return description; }
        public CreateCategoryModel setDescription(String value) { this.description = value; return this; }
        public CategoryTypes getType() { return type; }
        public CreateCategoryModel setType(CategoryTypes value) { this.type = value; return this; }
        public Boolean getIsParty() { return isParty; }
        public CreateCategoryModel setIsParty(Boolean value) { this.isParty = value; return this; }
        public ArrayList<Integer> getChildList() { return childList; }
        public CreateCategoryModel setChildList(ArrayList<Integer> value) { this.childList = value; return this; }
    }

    public static enum CategoryTypes
    {
        Department,
        PartyGroup,
        DocGroup,
        DocType,
        IssuingAgency,
        Status,
        Subjects,
        Workflow;
    }

    public static class SimpleDocumentRelation
    {
        public Integer id = null;
        public String title = null;
        public String documentCode = null;
        public Date publicationDate = null;
        
        public Integer getId() { return id; }
        public SimpleDocumentRelation setId(Integer value) { this.id = value; return this; }
        public String getTitle() { return title; }
        public SimpleDocumentRelation setTitle(String value) { this.title = value; return this; }
        public String getDocumentCode() { return documentCode; }
        public SimpleDocumentRelation setDocumentCode(String value) { this.documentCode = value; return this; }
        public Date getPublicationDate() { return publicationDate; }
        public SimpleDocumentRelation setPublicationDate(Date value) { this.publicationDate = value; return this; }
    }

    public static class WorkFlowProfile
    {
        public Integer id = null;
        public String fullName = null;
        public String email = null;
        public Integer departmentId = null;
        public String avatar = null;
        public String telephone = null;
        public Date birthday = null;
        public Integer confirmStatus = null;
        
        public Integer getId() { return id; }
        public WorkFlowProfile setId(Integer value) { this.id = value; return this; }
        public String getFullName() { return fullName; }
        public WorkFlowProfile setFullName(String value) { this.fullName = value; return this; }
        public String getEmail() { return email; }
        public WorkFlowProfile setEmail(String value) { this.email = value; return this; }
        public Integer getDepartmentId() { return departmentId; }
        public WorkFlowProfile setDepartmentId(Integer value) { this.departmentId = value; return this; }
        public String getAvatar() { return avatar; }
        public WorkFlowProfile setAvatar(String value) { this.avatar = value; return this; }
        public String getTelephone() { return telephone; }
        public WorkFlowProfile setTelephone(String value) { this.telephone = value; return this; }
        public Date getBirthday() { return birthday; }
        public WorkFlowProfile setBirthday(Date value) { this.birthday = value; return this; }
        public Integer getConfirmStatus() { return confirmStatus; }
        public WorkFlowProfile setConfirmStatus(Integer value) { this.confirmStatus = value; return this; }
    }

    public static class UploadedFileAttach extends UploadedFileModel
    {
        public String fileType = null;
        public Integer subDocumentId = null;
        public Integer stepId = null;
        
        public String getFileType() { return fileType; }
        public UploadedFileAttach setFileType(String value) { this.fileType = value; return this; }
        public Integer getSubDocumentId() { return subDocumentId; }
        public UploadedFileAttach setSubDocumentId(Integer value) { this.subDocumentId = value; return this; }
        public Integer getStepId() { return stepId; }
        public UploadedFileAttach setStepId(Integer value) { this.stepId = value; return this; }
    }

    public static class UploadedFileModel extends BasicUploadedFile
    {
        public Long id = null;
        public AccessType accessType = null;
        public Integer createdBy = null;
        public Date createdDate = null;
        
        public Long getId() { return id; }
        public UploadedFileModel setId(Long value) { this.id = value; return this; }
        public AccessType getAccessType() { return accessType; }
        public UploadedFileModel setAccessType(AccessType value) { this.accessType = value; return this; }
        public Integer getCreatedBy() { return createdBy; }
        public UploadedFileModel setCreatedBy(Integer value) { this.createdBy = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public UploadedFileModel setCreatedDate(Date value) { this.createdDate = value; return this; }
    }

    public static class BasicUploadedFile
    {
        public String fileName = null;
        public String filekey = null;
        public String fileUrl = null;
        public String checksum = null;
        public String eTag = null;
        public Long fileSize = null;
        
        public String getFileName() { return fileName; }
        public BasicUploadedFile setFileName(String value) { this.fileName = value; return this; }
        public String getFilekey() { return filekey; }
        public BasicUploadedFile setFilekey(String value) { this.filekey = value; return this; }
        public String getFileUrl() { return fileUrl; }
        public BasicUploadedFile setFileUrl(String value) { this.fileUrl = value; return this; }
        public String getChecksum() { return checksum; }
        public BasicUploadedFile setChecksum(String value) { this.checksum = value; return this; }
        public String getETag() { return eTag; }
        public BasicUploadedFile setETag(String value) { this.eTag = value; return this; }
        public Long getFileSize() { return fileSize; }
        public BasicUploadedFile setFileSize(Long value) { this.fileSize = value; return this; }
    }

    public static enum AccessType
    {
        Public,
        Restricted;
    }

}

Java GetWorkflowStepRequest 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.

GET /WorkflowStep/by-workflow HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			departments: 
			[
				{
					id: 0,
					level: 0,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							children: 
							[
								{
									id: 0,
									level: 0,
									sortOrder: 0,
									lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
									name: String,
									description: String,
									type: Department,
									isParty: False,
									childList: 
									[
										0
									]
								}
							],
							name: String,
							description: String,
							type: Department,
							isParty: False,
							childList: 
							[
								0
							]
						}
					],
					name: String,
					description: String,
					type: Department,
					isParty: False,
					childList: 
					[
						0
					]
				}
			],
			basisDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			attachedDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			referenceDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			mainAssignees: 
			[
				{
					id: 0,
					fullName: String,
					email: String,
					departmentId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					confirmStatus: 0
				}
			],
			attachFiles: 
			[
				{
					fileType: String,
					subDocumentId: 0,
					stepId: 0,
					id: 0,
					accessType: Public,
					createdBy: 0,
					fileName: String,
					filekey: String,
					fileUrl: String,
					checksum: String,
					eTag: String,
					fileSize: 0
				}
			],
			id: 0,
			workflowId: 0,
			stepOrder: 0,
			stepName: String,
			isRequired: False,
			slaLegalValue: 0,
			slaLegalIsByDay: False,
			slaInternalValue: 0,
			slaInternalIsByDay: False,
			requireAttachment: False,
			description: String,
			createdBy: 0,
			departmentIds: 
			[
				0
			],
			stepBasisDocumentIds: 
			[
				0
			],
			stepAttachedIds: 
			[
				0
			],
			mainAssigneeIds: 
			[
				0
			]
		}
	]
}