| GET | /WorkflowStep/by-workflow |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStep:
id: int = 0
# @References(typeof(Document))
workflow_id: int = 0
step_order: Optional[int] = None
# @Required()
# @StringLength(255)
step_name: Optional[str] = None
# @Required()
is_required: bool = False
sla_legal_value: Optional[int] = None
sla_legal_is_by_day: Optional[bool] = None
sla_internal_value: Optional[int] = None
sla_internal_is_by_day: Optional[bool] = None
require_attachment: bool = False
# @Required()
description: Optional[str] = None
created_by: int = 0
# @Ignore()
department_ids: Optional[List[int]] = None
# @Ignore()
step_basis_document_ids: Optional[List[int]] = None
# @Ignore()
step_attached_ids: Optional[List[int]] = None
# @Ignore()
main_assignee_ids: Optional[List[int]] = None
class CategoryTypes(str, Enum):
DEPARTMENT = 'Department'
PARTY_GROUP = 'PartyGroup'
DOC_GROUP = 'DocGroup'
DOC_TYPE = 'DocType'
ISSUING_AGENCY = 'IssuingAgency'
STATUS = 'Status'
SUBJECTS = 'Subjects'
WORKFLOW = 'Workflow'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCategoryModel:
name: Optional[str] = None
description: Optional[str] = None
type: Optional[CategoryTypes] = None
is_party: bool = False
# @Ignore()
child_list: Optional[List[int]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Category(CreateCategoryModel):
id: int = 0
level: int = 0
sort_order: int = 0
last_update: Optional[datetime.datetime] = None
# @Ignore()
children: Optional[List[Category]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SimpleDocumentRelation:
id: int = 0
title: Optional[str] = None
document_code: Optional[str] = None
publication_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkFlowProfile:
id: int = 0
full_name: Optional[str] = None
email: Optional[str] = None
department_id: Optional[int] = None
avatar: Optional[str] = None
telephone: Optional[str] = None
birthday: Optional[datetime.datetime] = None
confirm_status: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicUploadedFile:
file_name: Optional[str] = None
filekey: Optional[str] = None
file_url: Optional[str] = None
checksum: Optional[str] = None
e_tag: Optional[str] = None
file_size: int = 0
class AccessType(str, Enum):
PUBLIC = 'Public'
RESTRICTED = 'Restricted'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedFileModel(BasicUploadedFile):
id: int = 0
access_type: Optional[AccessType] = None
created_by: int = 0
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedFileAttach(UploadedFileModel):
file_type: Optional[str] = None
sub_document_id: Optional[int] = None
step_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStepDetail(WorkflowStep):
departments: Optional[List[Category]] = None
basis_documents: Optional[List[SimpleDocumentRelation]] = None
attached_documents: Optional[List[SimpleDocumentRelation]] = None
reference_documents: Optional[List[SimpleDocumentRelation]] = None
main_assignees: Optional[List[WorkFlowProfile]] = None
attach_files: Optional[List[UploadedFileAttach]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWorkflowStepResponse(IResponseRequest):
code: int = 0
message: Optional[str] = None
data: Optional[List[WorkflowStepDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWorkflowStepRequest:
workflow_id: int = 0
Python GetWorkflowStepRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetWorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
<Code>0</Code>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:WorkflowStepDetail>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
<d2p1:DeletedBy>0</d2p1:DeletedBy>
<d2p1:DepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:DepartmentIds>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsRequired>false</d2p1:IsRequired>
<d2p1:MainAssigneeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:MainAssigneeIds>
<d2p1:RequireAttachment>false</d2p1:RequireAttachment>
<d2p1:SLAInternalIsByDay>false</d2p1:SLAInternalIsByDay>
<d2p1:SLAInternalValue>0</d2p1:SLAInternalValue>
<d2p1:SLALegalIsByDay>false</d2p1:SLALegalIsByDay>
<d2p1:SLALegalValue>0</d2p1:SLALegalValue>
<d2p1:SLAWarningSentAt>0001-01-01T00:00:00</d2p1:SLAWarningSentAt>
<d2p1:SLAWarningSentCount>0</d2p1:SLAWarningSentCount>
<d2p1:StepAttachedIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:StepAttachedIds>
<d2p1:StepBasisDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</d2p1:StepBasisDocumentIds>
<d2p1:StepName>String</d2p1:StepName>
<d2p1:StepOrder>0</d2p1:StepOrder>
<d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
<d2p1:UpdatedBy>0</d2p1:UpdatedBy>
<d2p1:WorkflowId>0</d2p1:WorkflowId>
<d2p1:AttachFiles>
<d2p1:UploadedFileAttach>
<d2p1:Checksum>String</d2p1:Checksum>
<d2p1:ETag>String</d2p1:ETag>
<d2p1:FileName>String</d2p1:FileName>
<d2p1:FileSize>0</d2p1:FileSize>
<d2p1:FileUrl>String</d2p1:FileUrl>
<d2p1:Filekey>String</d2p1:Filekey>
<d2p1:AccessType>Public</d2p1:AccessType>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Id>0</d2p1:Id>
<d2p1:FileType>String</d2p1:FileType>
<d2p1:StepId>0</d2p1:StepId>
<d2p1:SubDocumentId>0</d2p1:SubDocumentId>
</d2p1:UploadedFileAttach>
</d2p1:AttachFiles>
<d2p1:AttachedDocuments>
<d2p1:SimpleDocumentRelation>
<d2p1:DocumentCode>String</d2p1:DocumentCode>
<d2p1:Id>0</d2p1:Id>
<d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
<d2p1:Title>String</d2p1:Title>
<d2p1:Type>String</d2p1:Type>
</d2p1:SimpleDocumentRelation>
</d2p1:AttachedDocuments>
<d2p1:BasisDocuments>
<d2p1:SimpleDocumentRelation>
<d2p1:DocumentCode>String</d2p1:DocumentCode>
<d2p1:Id>0</d2p1:Id>
<d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
<d2p1:Title>String</d2p1:Title>
<d2p1:Type>String</d2p1:Type>
</d2p1:SimpleDocumentRelation>
</d2p1:BasisDocuments>
<d2p1:Departments>
<d2p1:Category>
<d2p1:ChildList xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>0</d6p1:int>
</d2p1:ChildList>
<d2p1:Description>String</d2p1:Description>
<d2p1:IsParty>false</d2p1:IsParty>
<d2p1:Name>String</d2p1:Name>
<d2p1:Type>Department</d2p1:Type>
<d2p1:Children>
<d2p1:Category>
<d2p1:ChildList xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>0</d8p1:int>
</d2p1:ChildList>
<d2p1:Description>String</d2p1:Description>
<d2p1:IsParty>false</d2p1:IsParty>
<d2p1:Name>String</d2p1:Name>
<d2p1:Type>Department</d2p1:Type>
<d2p1:Children>
<d2p1:Category>
<d2p1:ChildList xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d10p1:int>0</d10p1:int>
</d2p1:ChildList>
<d2p1:Description>String</d2p1:Description>
<d2p1:IsParty>false</d2p1:IsParty>
<d2p1:Name>String</d2p1:Name>
<d2p1:Type>Department</d2p1:Type>
<d2p1:Children i:nil="true" />
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
<d2p1:DeletedBy>0</d2p1:DeletedBy>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsDeleted>false</d2p1:IsDeleted>
<d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
<d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
<d2p1:Level>0</d2p1:Level>
<d2p1:SortOrder>0</d2p1:SortOrder>
</d2p1:Category>
</d2p1:Children>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
<d2p1:DeletedBy>0</d2p1:DeletedBy>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsDeleted>false</d2p1:IsDeleted>
<d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
<d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
<d2p1:Level>0</d2p1:Level>
<d2p1:SortOrder>0</d2p1:SortOrder>
</d2p1:Category>
</d2p1:Children>
<d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
<d2p1:DeletedBy>0</d2p1:DeletedBy>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsDeleted>false</d2p1:IsDeleted>
<d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
<d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
<d2p1:Level>0</d2p1:Level>
<d2p1:SortOrder>0</d2p1:SortOrder>
</d2p1:Category>
</d2p1:Departments>
<d2p1:MainAssignees>
<d2p1:WorkFlowProfile>
<d2p1:Avatar>String</d2p1:Avatar>
<d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
<d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
<d2p1:DepartmentId>0</d2p1:DepartmentId>
<d2p1:Email>String</d2p1:Email>
<d2p1:FullName>String</d2p1:FullName>
<d2p1:Id>0</d2p1:Id>
<d2p1:Telephone>String</d2p1:Telephone>
</d2p1:WorkFlowProfile>
</d2p1:MainAssignees>
<d2p1:ReferenceDocuments>
<d2p1:SimpleDocumentRelation>
<d2p1:DocumentCode>String</d2p1:DocumentCode>
<d2p1:Id>0</d2p1:Id>
<d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
<d2p1:Title>String</d2p1:Title>
<d2p1:Type>String</d2p1:Type>
</d2p1:SimpleDocumentRelation>
</d2p1:ReferenceDocuments>
</d2p1:WorkflowStepDetail>
</Data>
<Message>String</Message>
</GetWorkflowStepResponse>