| GET | /WorkflowStep/by-workflow |
|---|
import Foundation
import ServiceStack
public class GetWorkflowStepRequest : Codable
{
public var workflowId:Int
required public init(){}
}
public class GetWorkflowStepResponse : IResponseRequest, Codable
{
public var code:Int
public var message:String
public var data:[WorkflowStepDetail] = []
required public init(){}
}
public class WorkflowStepDetail : WorkflowStep
{
public var departments:[Category] = []
public var coDepartments:[Category] = []
public var basisDocuments:[SimpleDocumentRelation] = []
public var referenceDocuments:[SimpleDocumentRelation] = []
public var mainAssignees:[WorkFlowProfile] = []
public var supportingAssignees:[WorkFlowProfile] = []
public var statusKey:String
public var statusText:String
// @Ignore()
public var canRead:Bool?
// @Ignore()
public var canWrite:Bool?
// @Ignore()
public var canUpload:Bool?
public var reasonReturn:String
public var returnDate:Date?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case departments
case coDepartments
case basisDocuments
case referenceDocuments
case mainAssignees
case supportingAssignees
case statusKey
case statusText
case canRead
case canWrite
case canUpload
case reasonReturn
case returnDate
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
departments = try container.decodeIfPresent([Category].self, forKey: .departments) ?? []
coDepartments = try container.decodeIfPresent([Category].self, forKey: .coDepartments) ?? []
basisDocuments = try container.decodeIfPresent([SimpleDocumentRelation].self, forKey: .basisDocuments) ?? []
referenceDocuments = try container.decodeIfPresent([SimpleDocumentRelation].self, forKey: .referenceDocuments) ?? []
mainAssignees = try container.decodeIfPresent([WorkFlowProfile].self, forKey: .mainAssignees) ?? []
supportingAssignees = try container.decodeIfPresent([WorkFlowProfile].self, forKey: .supportingAssignees) ?? []
statusKey = try container.decodeIfPresent(String.self, forKey: .statusKey)
statusText = try container.decodeIfPresent(String.self, forKey: .statusText)
canRead = try container.decodeIfPresent(Bool.self, forKey: .canRead)
canWrite = try container.decodeIfPresent(Bool.self, forKey: .canWrite)
canUpload = try container.decodeIfPresent(Bool.self, forKey: .canUpload)
reasonReturn = try container.decodeIfPresent(String.self, forKey: .reasonReturn)
returnDate = try container.decodeIfPresent(Date.self, forKey: .returnDate)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if departments.count > 0 { try container.encode(departments, forKey: .departments) }
if coDepartments.count > 0 { try container.encode(coDepartments, forKey: .coDepartments) }
if basisDocuments.count > 0 { try container.encode(basisDocuments, forKey: .basisDocuments) }
if referenceDocuments.count > 0 { try container.encode(referenceDocuments, forKey: .referenceDocuments) }
if mainAssignees.count > 0 { try container.encode(mainAssignees, forKey: .mainAssignees) }
if supportingAssignees.count > 0 { try container.encode(supportingAssignees, forKey: .supportingAssignees) }
if statusKey != nil { try container.encode(statusKey, forKey: .statusKey) }
if statusText != nil { try container.encode(statusText, forKey: .statusText) }
if canRead != nil { try container.encode(canRead, forKey: .canRead) }
if canWrite != nil { try container.encode(canWrite, forKey: .canWrite) }
if canUpload != nil { try container.encode(canUpload, forKey: .canUpload) }
if reasonReturn != nil { try container.encode(reasonReturn, forKey: .reasonReturn) }
if returnDate != nil { try container.encode(returnDate, forKey: .returnDate) }
}
}
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 Category : CreateCategoryModel
{
public var id:Int
public var level:Int
public var key:String
public var sortOrder:Int
public var lastUpdate:Date?
// @Ignore()
public var children:[Category] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case level
case key
case sortOrder
case lastUpdate
case children
}
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)
level = try container.decodeIfPresent(Int.self, forKey: .level)
key = try container.decodeIfPresent(String.self, forKey: .key)
sortOrder = try container.decodeIfPresent(Int.self, forKey: .sortOrder)
lastUpdate = try container.decodeIfPresent(Date.self, forKey: .lastUpdate)
children = try container.decodeIfPresent([Category].self, forKey: .children) ?? []
}
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 level != nil { try container.encode(level, forKey: .level) }
if key != nil { try container.encode(key, forKey: .key) }
if sortOrder != nil { try container.encode(sortOrder, forKey: .sortOrder) }
if lastUpdate != nil { try container.encode(lastUpdate, forKey: .lastUpdate) }
if children.count > 0 { try container.encode(children, forKey: .children) }
}
}
public class CreateCategoryModel : Codable
{
public var name:String
public var Description:String
public var type:CategoryTypes
public var isParty:Bool
// @Ignore()
public var childList:[Int] = []
required public init(){}
}
public enum CategoryTypes : String, Codable
{
case Department
case PartyGroup
case DocGroup
case DocType
case IssuingAgency
case Status
case Subjects
case Workflow
case WorkStatus
case StepStatus
case SignStatus
}
public class SimpleDocumentRelation : Codable
{
public var id:Int
public var title:String
public var documentCode:String
public var publicationDate:Date?
public var isSequentialSigning:Bool?
public var statusText:String
public var documentTypeId:Int?
required public init(){}
}
Swift GetWorkflowStepRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
code: 0,
message: String,
data:
[
{
departments:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
children:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
children:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
coDepartments:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
children:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
children:
[
{
id: 0,
level: 0,
key: String,
sortOrder: 0,
lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
basisDocuments:
[
{
id: 0,
title: String,
documentCode: String,
publicationDate: "0001-01-01T00:00:00.0000000+07:06",
isSequentialSigning: False,
statusText: String,
documentTypeId: 0
}
],
referenceDocuments:
[
{
id: 0,
title: String,
documentCode: String,
publicationDate: "0001-01-01T00:00:00.0000000+07:06",
isSequentialSigning: False,
statusText: String,
documentTypeId: 0
}
],
mainAssignees:
[
{
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
}
],
supportingAssignees:
[
{
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
}
],
statusKey: String,
statusText: String,
canRead: False,
canWrite: False,
canUpload: False,
reasonReturn: String,
returnDate: "0001-01-01T00:00:00.0000000+07:06",
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
}
]
}
]
}
]
}