tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports tvpl.api.ServiceModel
Imports tvpl.data.Models

Namespace Global

    Namespace tvpl.api.ServiceModel

        Public Partial Class CreateWorkflowStepRequest
            Inherits WorkflowStep
        End Class

        Public Partial Class WorkflowStepResponse
            Implements IResponseRequest
            Public Overridable Property Code As Integer
            Public Overridable Property Message As String
            Public Overridable Property InsertedId As Integer
        End Class
    End Namespace

    Namespace tvpl.data.Models

        Public Partial Class BasicSignerConfig
            Public Overridable Property SubDocumentId As Nullable(Of Integer)
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property SignerType As Byte
            Public Overridable Property SignerRefId As Integer
            <Ignore>
            Public Overridable Property SignerRefText As String

            Public Overridable Property ActionType As Byte
            Public Overridable Property OrderIndex As Integer
        End Class

        Public Partial Class BasicUploadedFile
            Public Overridable Property FileName As String
            Public Overridable Property Filekey As String
            Public Overridable Property FileUrl As String
            Public Overridable Property Checksum As String
            Public Overridable Property ETag As String
            Public Overridable Property FileSize As Long
        End Class

        Public Partial Class Roles
            Public Sub New()
                Permission = New List(Of String)
            End Sub

            Public Overridable Property Id As Integer
            <StringLength(50)>
            Public Overridable Property Name As String

            Public Overridable Property CreatedAt As Nullable(Of Date)
            Public Overridable Property DeletedAt As Nullable(Of Date)
            Public Overridable Property UpdatedAt As Nullable(Of Date)
            Public Overridable Property UpdatedBy As Nullable(Of Integer)
            Public Overridable Property DeletedBy As Nullable(Of Integer)
            Public Overridable Property CreatedBy As Nullable(Of Integer)
            <Ignore>
            Public Overridable Property Permission As List(Of String)
        End Class

        Public Partial Class SignerConfig
            Inherits BasicSignerConfig
            Public Overridable Property Id As Integer
            Public Overridable Property DocumentId As Integer
            Public Overridable Property StepId As Nullable(Of Integer)
        End Class

        Public Partial Class SignerConfigDetail
            Inherits SignerConfig
            Public Overridable Property Profile As WorkFlowProfile
            Public Overridable Property Role As Roles
        End Class

        Public Partial Class StepAttached
            Public Sub New()
                SignerConfigs = New List(Of SignerConfigDetail)
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property DocumentCode As String
            Public Overridable Property Title As String
            Public Overridable Property IsSequentialSigning As Nullable(Of Boolean)
            Public Overridable Property PendingSignFile As UploadedFiles
            Public Overridable Property OriginalFile As UploadedFiles
            Public Overridable Property SignerConfigs As List(Of SignerConfigDetail)
        End Class

        Public Partial Class UploadedFiles
            Inherits BasicUploadedFile
            Public Overridable Property Id As Nullable(Of Long)
            Public Overridable Property UploadedFile As String
            Public Overridable Property SubDocumentId As Nullable(Of Integer)
            Public Overridable Property StepId As Nullable(Of Integer)
            Public Overridable Property Code As Integer
        End Class

        Public Partial Class WorkFlowProfile
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property FullName As String
            Public Overridable Property Email As String
            Public Overridable Property DepartmentId As Nullable(Of Integer)
            Public Overridable Property Avatar As String
            Public Overridable Property Telephone As String
            Public Overridable Property Birthday As Nullable(Of Date)
            Public Overridable Property ConfirmStatus As Nullable(Of Integer)
            Public Overridable Property ConfirmStatusText As String
            Public Overridable Property SignAt As Nullable(Of Date)
            Public Overridable Property SignedFileId As Nullable(Of Long)
            Public Overridable Property OriginalFileId As Nullable(Of Integer)
            Public Overridable Property SignedFileName As String
            Public Overridable Property IsSigned As Boolean
            Public Overridable Property SignStatusText As String
        End Class

        Public Partial Class WorkflowStep
            Public Sub New()
                DepartmentIds = New List(Of Integer)
                MainAssigneeIds = New List(Of Integer)
                CoDepartmentIds = New List(Of Integer)
                SupportingAssigneeIds = New List(Of Integer)
                StepBasisDocumentIds = New List(Of Integer)
                AttachedDocuments = New List(Of StepAttached)
            End Sub

            Public Overridable Property Id As Integer
            <References(GetType(Document))>
            Public Overridable Property WorkflowId As Integer

            Public Overridable Property StepOrder As Nullable(Of Integer)
            Public Overridable Property StatusId As Nullable(Of Integer)
            <Required>
            <StringLength(255)>
            Public Overridable Property StepName As String

            <Required>
            Public Overridable Property IsRequired As Boolean

            Public Overridable Property SLALegalValue As Nullable(Of Integer)
            Public Overridable Property SLALegalIsByDay As Nullable(Of Boolean)
            Public Overridable Property SLAInternalValue As Nullable(Of Integer)
            Public Overridable Property SLAInternalIsByDay As Nullable(Of Boolean)
            Public Overridable Property RequireAttachment As Boolean
            Public Overridable Property IsUsingForm As Nullable(Of Boolean)
            <Required>
            Public Overridable Property Description As String

            Public Overridable Property CreatedBy As Integer
            <Ignore>
            Public Overridable Property DepartmentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property MainAssigneeIds As List(Of Integer)

            <Ignore>
            Public Overridable Property CoDepartmentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property SupportingAssigneeIds As List(Of Integer)

            <Ignore>
            Public Overridable Property StepBasisDocumentIds As List(Of Integer)

            <Ignore>
            Public Overridable Property AttachedDocuments As List(Of StepAttached)
        End Class
    End Namespace
End Namespace

VB.NET CreateWorkflowStepRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":0,"workflowId":0,"stepOrder":0,"statusId":0,"stepName":"String","isRequired":false,"slaLegalValue":0,"slaLegalIsByDay":false,"slaInternalValue":0,"slaInternalIsByDay":false,"requireAttachment":false,"isUsingForm":false,"description":"String","createdBy":0,"departmentIds":[0],"mainAssigneeIds":[0],"coDepartmentIds":[0],"supportingAssigneeIds":[0],"stepBasisDocumentIds":[0],"attachedDocuments":[{"id":0,"documentCode":"String","title":"String","isSequentialSigning":false,"pendingSignFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"originalFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"signerConfigs":[{"profile":{"id":0,"name":"String","fullName":"String","email":"String","departmentId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","confirmStatus":0,"confirmStatusText":"String","signAt":"0001-01-01T00:00:00.0000000+07:06","signedFileId":0,"originalFileId":0,"signedFileName":"String","isSigned":false,"signStatusText":"String"},"role":{"id":0,"name":"String","createdAt":"0001-01-01T00:00:00.0000000+07:06","deletedAt":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","updatedBy":0,"deletedBy":0,"createdBy":0,"permission":["String"]},"id":0,"documentId":0,"stepId":0,"subDocumentId":0,"departmentId":0,"signerType":0,"signerRefId":0,"signerRefText":"String","actionType":0,"orderIndex":0}]}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"code":0,"message":"String","insertedId":0}