tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
import Foundation
import ServiceStack

public class CreateWorkflowStepRequest : WorkflowStep
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class WorkflowStep : Codable
{
    public var id:Int
    // @References(typeof(Document))
    public var workflowId:Int

    public var stepOrder:Int?
    public var statusId:Int?
    // @Required()
    // @StringLength(255)
    public var stepName:String?

    // @Required()
    public var isRequired:Bool?

    public var slaLegalValue:Int?
    public var slaLegalIsByDay:Bool?
    public var slaInternalValue:Int?
    public var slaInternalIsByDay:Bool?
    public var requireAttachment:Bool
    public var isUsingForm:Bool?
    // @Required()
    public var Description:String?

    public var createdBy:Int
    // @Ignore()
    public var departmentIds:[Int] = []

    // @Ignore()
    public var mainAssigneeIds:[Int] = []

    // @Ignore()
    public var coDepartmentIds:[Int] = []

    // @Ignore()
    public var supportingAssigneeIds:[Int] = []

    // @Ignore()
    public var stepBasisDocumentIds:[Int] = []

    // @Ignore()
    public var attachedDocuments:[StepAttached] = []

    required public init(){}
}

public class StepAttached : Codable
{
    public var id:Int
    public var documentCode:String
    public var title:String
    public var isSequentialSigning:Bool?
    public var pendingSignFile:UploadedFiles
    public var originalFile:UploadedFiles
    public var signerConfigs:[SignerConfigDetail] = []

    required public init(){}
}

public class UploadedFiles : BasicUploadedFile
{
    public var id:Int?
    public var uploadedFile:String
    public var subDocumentId:Int?
    public var stepId:Int?
    public var code:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case uploadedFile
        case subDocumentId
        case stepId
        case code
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        uploadedFile = try container.decodeIfPresent(String.self, forKey: .uploadedFile)
        subDocumentId = try container.decodeIfPresent(Int.self, forKey: .subDocumentId)
        stepId = try container.decodeIfPresent(Int.self, forKey: .stepId)
        code = try container.decodeIfPresent(Int.self, forKey: .code)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if uploadedFile != nil { try container.encode(uploadedFile, forKey: .uploadedFile) }
        if subDocumentId != nil { try container.encode(subDocumentId, forKey: .subDocumentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
        if code != nil { try container.encode(code, forKey: .code) }
    }
}

public class BasicUploadedFile : Codable
{
    public var fileName:String
    public var filekey:String
    public var fileUrl:String
    public var checksum:String
    public var eTag:String
    public var fileSize:Int

    required public init(){}
}

public class SignerConfigDetail : SignerConfig
{
    public var profile:WorkFlowProfile
    public var role:Roles

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case profile
        case role
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        profile = try container.decodeIfPresent(WorkFlowProfile.self, forKey: .profile)
        role = try container.decodeIfPresent(Roles.self, forKey: .role)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if profile != nil { try container.encode(profile, forKey: .profile) }
        if role != nil { try container.encode(role, forKey: .role) }
    }
}

public class SignerConfig : BasicSignerConfig
{
    public var id:Int
    public var documentId:Int
    public var stepId:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case documentId
        case stepId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        documentId = try container.decodeIfPresent(Int.self, forKey: .documentId)
        stepId = try container.decodeIfPresent(Int.self, forKey: .stepId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if documentId != nil { try container.encode(documentId, forKey: .documentId) }
        if stepId != nil { try container.encode(stepId, forKey: .stepId) }
    }
}

public class BasicSignerConfig : Codable
{
    public var subDocumentId:Int?
    public var departmentId:Int?
    public var signerType:UInt8
    public var signerRefId:Int
    // @Ignore()
    public var signerRefText:String

    public var actionType:UInt8
    public var orderIndex:Int

    required public init(){}
}

public class WorkFlowProfile : Codable
{
    public var id:Int
    public var name:String
    public var fullName:String
    public var email:String
    public var departmentId:Int?
    public var avatar:String
    public var telephone:String
    public var birthday:Date?
    public var confirmStatus:Int?
    public var confirmStatusText:String
    public var signAt:Date?
    public var signedFileId:Int?
    public var originalFileId:Int?
    public var signedFileName:String
    public var isSigned:Bool
    public var signStatusText:String

    required public init(){}
}

public class Roles : Codable
{
    public var id:Int
    // @StringLength(50)
    public var name:String

    public var createdAt:Date?
    public var deletedAt:Date?
    public var updatedAt:Date?
    public var updatedBy:Int?
    public var deletedBy:Int?
    public var createdBy:Int?
    // @Ignore()
    public var permission:[String] = []

    required public init(){}
}

public class WorkflowStepResponse : IResponseRequest, Codable
{
    public var code:Int
    public var message:String
    public var insertedId:Int

    required public init(){}
}


Swift CreateWorkflowStepRequest DTOs

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

HTTP + CSV

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

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