tvpl.api

CreateWorkflowStepRequest

The following routes are available for this service:
POST	/WorkflowStep/update

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateWorkflowStepRequest : WorkflowStep()
{
}

open class WorkflowStep
{
    var id:Int? = null
    @References(Document.class)
    var workflowId:Int? = null

    var stepOrder:Int? = null
    var statusId:Int? = null
    @Required()
    @StringLength(255)
    var stepName:String? = null

    @Required()
    var isRequired:Boolean? = null

    var slaLegalValue:Int? = null
    var slaLegalIsByDay:Boolean? = null
    var slaInternalValue:Int? = null
    var slaInternalIsByDay:Boolean? = null
    var requireAttachment:Boolean? = null
    var isUsingForm:Boolean? = null
    @Required()
    var description:String? = null

    var createdBy:Int? = null
    @Ignore()
    var departmentIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var mainAssigneeIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var coDepartmentIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var supportingAssigneeIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var stepBasisDocumentIds:ArrayList<Int> = ArrayList<Int>()

    @Ignore()
    var attachedDocuments:ArrayList<StepAttached> = ArrayList<StepAttached>()
}

open class StepAttached
{
    var id:Int? = null
    var documentCode:String? = null
    var title:String? = null
    var isSequentialSigning:Boolean? = null
    var pendingSignFile:UploadedFiles? = null
    var originalFile:UploadedFiles? = null
    var signerConfigs:ArrayList<SignerConfigDetail> = ArrayList<SignerConfigDetail>()
}

open class UploadedFiles : BasicUploadedFile()
{
    var id:Long? = null
    var uploadedFile:String? = null
    var subDocumentId:Int? = null
    var stepId:Int? = null
    var code:Int? = null
}

open class BasicUploadedFile
{
    var fileName:String? = null
    var filekey:String? = null
    var fileUrl:String? = null
    var checksum:String? = null
    var eTag:String? = null
    var fileSize:Long? = null
}

open class SignerConfigDetail : SignerConfig()
{
    var profile:WorkFlowProfile? = null
    var role:Roles? = null
}

open class SignerConfig : BasicSignerConfig()
{
    var id:Int? = null
    var documentId:Int? = null
    var stepId:Int? = null
}

open class BasicSignerConfig
{
    var subDocumentId:Int? = null
    var departmentId:Int? = null
    var signerType:Short? = null
    var signerRefId:Int? = null
    @Ignore()
    var signerRefText:String? = null

    var actionType:Short? = null
    var orderIndex:Int? = null
}

open class WorkFlowProfile
{
    var id:Int? = null
    var name:String? = null
    var fullName:String? = null
    var email:String? = null
    var departmentId:Int? = null
    var avatar:String? = null
    var telephone:String? = null
    var birthday:Date? = null
    var confirmStatus:Int? = null
    var confirmStatusText:String? = null
    var signAt:Date? = null
    var signedFileId:Long? = null
    var originalFileId:Int? = null
    var signedFileName:String? = null
    var isSigned:Boolean? = null
    var signStatusText:String? = null
}

open class Roles
{
    var id:Int? = null
    @StringLength(50)
    var name:String? = null

    var createdAt:Date? = null
    var deletedAt:Date? = null
    var updatedAt:Date? = null
    var updatedBy:Int? = null
    var deletedBy:Int? = null
    var createdBy:Int? = null
    @Ignore()
    var permission:ArrayList<String> = ArrayList<String>()
}

open class WorkflowStepResponse : IResponseRequest
{
    var code:Int? = null
    var message:String? = null
    var insertedId:Int? = null
}

Kotlin CreateWorkflowStepRequest 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 /WorkflowStep/update HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWorkflowStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <AttachedDocuments xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <StepAttached>
      <DocumentCode>String</DocumentCode>
      <Id>0</Id>
      <IsSequentialSigning>false</IsSequentialSigning>
      <OriginalFile>
        <Checksum>String</Checksum>
        <ETag>String</ETag>
        <FileName>String</FileName>
        <FileSize>0</FileSize>
        <FileUrl>String</FileUrl>
        <Filekey>String</Filekey>
        <Code>0</Code>
        <Id>0</Id>
        <StepId>0</StepId>
        <SubDocumentId>0</SubDocumentId>
        <UploadedFile>String</UploadedFile>
      </OriginalFile>
      <PendingSignFile>
        <Checksum>String</Checksum>
        <ETag>String</ETag>
        <FileName>String</FileName>
        <FileSize>0</FileSize>
        <FileUrl>String</FileUrl>
        <Filekey>String</Filekey>
        <Code>0</Code>
        <Id>0</Id>
        <StepId>0</StepId>
        <SubDocumentId>0</SubDocumentId>
        <UploadedFile>String</UploadedFile>
      </PendingSignFile>
      <SignerConfigs>
        <SignerConfigDetail>
          <ActionType>0</ActionType>
          <DepartmentId>0</DepartmentId>
          <OrderIndex>0</OrderIndex>
          <SignerRefId>0</SignerRefId>
          <SignerRefText>String</SignerRefText>
          <SignerType>0</SignerType>
          <SubDocumentId>0</SubDocumentId>
          <CreateAt>0001-01-01T00:00:00</CreateAt>
          <CreateBy>0</CreateBy>
          <DocumentId>0</DocumentId>
          <Id>0</Id>
          <StepId>0</StepId>
          <Profile>
            <Avatar>String</Avatar>
            <Birthday>0001-01-01T00:00:00</Birthday>
            <ConfirmStatus>0</ConfirmStatus>
            <ConfirmStatusText>String</ConfirmStatusText>
            <DepartmentId>0</DepartmentId>
            <Email>String</Email>
            <FullName>String</FullName>
            <Id>0</Id>
            <IsSigned>false</IsSigned>
            <Name>String</Name>
            <OriginalFileId>0</OriginalFileId>
            <SignAt>0001-01-01T00:00:00</SignAt>
            <SignStatusText>String</SignStatusText>
            <SignedFileId>0</SignedFileId>
            <SignedFileName>String</SignedFileName>
            <Telephone>String</Telephone>
          </Profile>
          <Role>
            <CreatedAt>0001-01-01T00:00:00</CreatedAt>
            <CreatedBy>0</CreatedBy>
            <DeletedAt>0001-01-01T00:00:00</DeletedAt>
            <DeletedBy>0</DeletedBy>
            <Id>0</Id>
            <Name>String</Name>
            <Permission xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </Permission>
            <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
            <UpdatedBy>0</UpdatedBy>
          </Role>
        </SignerConfigDetail>
      </SignerConfigs>
      <Title>String</Title>
    </StepAttached>
  </AttachedDocuments>
  <CoDepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </CoDepartmentIds>
  <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
  <DeletedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</DeletedAt>
  <DeletedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</DeletedBy>
  <DepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </DepartmentIds>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
  <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
  <IsUsingForm xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsUsingForm>
  <MainAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </MainAssigneeIds>
  <RequireAttachment xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</RequireAttachment>
  <SLAInternalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLAInternalIsByDay>
  <SLAInternalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAInternalValue>
  <SLALegalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLALegalIsByDay>
  <SLALegalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLALegalValue>
  <SLAWarningSentAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</SLAWarningSentAt>
  <SLAWarningSentCount xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAWarningSentCount>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StatusId>
  <StepBasisDocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </StepBasisDocumentIds>
  <StepName xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</StepName>
  <StepOrder xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StepOrder>
  <SupportingAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </SupportingAssigneeIds>
  <UpdatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</UpdatedBy>
  <WorkflowId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</WorkflowId>
</CreateWorkflowStepRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
</WorkflowStepResponse>