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

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

<GetWorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:WorkflowStepDetail>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:DepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:DepartmentIds>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsRequired>false</d2p1:IsRequired>
      <d2p1:MainAssigneeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:MainAssigneeIds>
      <d2p1:RequireAttachment>false</d2p1:RequireAttachment>
      <d2p1:SLAInternalIsByDay>false</d2p1:SLAInternalIsByDay>
      <d2p1:SLAInternalValue>0</d2p1:SLAInternalValue>
      <d2p1:SLALegalIsByDay>false</d2p1:SLALegalIsByDay>
      <d2p1:SLALegalValue>0</d2p1:SLALegalValue>
      <d2p1:SLAWarningSentAt>0001-01-01T00:00:00</d2p1:SLAWarningSentAt>
      <d2p1:SLAWarningSentCount>0</d2p1:SLAWarningSentCount>
      <d2p1:StepAttachedIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepAttachedIds>
      <d2p1:StepBasisDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepBasisDocumentIds>
      <d2p1:StepName>String</d2p1:StepName>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
      <d2p1:WorkflowId>0</d2p1:WorkflowId>
      <d2p1:AttachFiles>
        <d2p1:UploadedFileAttach>
          <d2p1:Checksum>String</d2p1:Checksum>
          <d2p1:ETag>String</d2p1:ETag>
          <d2p1:FileName>String</d2p1:FileName>
          <d2p1:FileSize>0</d2p1:FileSize>
          <d2p1:FileUrl>String</d2p1:FileUrl>
          <d2p1:Filekey>String</d2p1:Filekey>
          <d2p1:AccessType>Public</d2p1:AccessType>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:FileType>String</d2p1:FileType>
          <d2p1:StepId>0</d2p1:StepId>
          <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
        </d2p1:UploadedFileAttach>
      </d2p1:AttachFiles>
      <d2p1:AttachedDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:AttachedDocuments>
      <d2p1:BasisDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:BasisDocuments>
      <d2p1:Departments>
        <d2p1:Category>
          <d2p1:ChildList xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:ChildList>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Type>Department</d2p1:Type>
          <d2p1:Children>
            <d2p1:Category>
              <d2p1:ChildList xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d2p1:ChildList>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:IsParty>false</d2p1:IsParty>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Type>Department</d2p1:Type>
              <d2p1:Children>
                <d2p1:Category>
                  <d2p1:ChildList xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:int>0</d10p1:int>
                  </d2p1:ChildList>
                  <d2p1:Description>String</d2p1:Description>
                  <d2p1:IsParty>false</d2p1:IsParty>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:Type>Department</d2p1:Type>
                  <d2p1:Children i:nil="true" />
                  <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
                  <d2p1:CreatedBy>0</d2p1:CreatedBy>
                  <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
                  <d2p1:DeletedBy>0</d2p1:DeletedBy>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:IsDeleted>false</d2p1:IsDeleted>
                  <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
                  <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
                  <d2p1:Level>0</d2p1:Level>
                  <d2p1:SortOrder>0</d2p1:SortOrder>
                </d2p1:Category>
              </d2p1:Children>
              <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
              <d2p1:CreatedBy>0</d2p1:CreatedBy>
              <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
              <d2p1:DeletedBy>0</d2p1:DeletedBy>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsDeleted>false</d2p1:IsDeleted>
              <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
              <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
              <d2p1:Level>0</d2p1:Level>
              <d2p1:SortOrder>0</d2p1:SortOrder>
            </d2p1:Category>
          </d2p1:Children>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>0</d2p1:DeletedBy>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsDeleted>false</d2p1:IsDeleted>
          <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
          <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
          <d2p1:Level>0</d2p1:Level>
          <d2p1:SortOrder>0</d2p1:SortOrder>
        </d2p1:Category>
      </d2p1:Departments>
      <d2p1:MainAssignees>
        <d2p1:WorkFlowProfile>
          <d2p1:Avatar>String</d2p1:Avatar>
          <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
          <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
          <d2p1:DepartmentId>0</d2p1:DepartmentId>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:FullName>String</d2p1:FullName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Telephone>String</d2p1:Telephone>
        </d2p1:WorkFlowProfile>
      </d2p1:MainAssignees>
      <d2p1:ReferenceDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:ReferenceDocuments>
    </d2p1:WorkflowStepDetail>
  </Data>
  <Message>String</Message>
</GetWorkflowStepResponse>