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
{
    public var stepAttachFiles:[UploadedFiles] = []

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

    private enum CodingKeys : String, CodingKey {
        case stepAttachFiles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        stepAttachFiles = try container.decodeIfPresent([UploadedFiles].self, forKey: .stepAttachFiles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if stepAttachFiles.count > 0 { try container.encode(stepAttachFiles, forKey: .stepAttachFiles) }
    }
}

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

    public var stepOrder: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
    // @Required()
    public var Description:String?

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

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

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

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

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

{"stepAttachFiles":[{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":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]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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