| 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 .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"code":0,"message":"String","data":[{"departments":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":[{"id":0,"level":0,"sortOrder":0,"lastUpdate":"0001-01-01T00:00:00.0000000+07:06","children":null,"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"}],"attachedDocuments":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"referenceDocuments":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"mainAssignees":[{"id":0,"fullName":"String","email":"String","departmentId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","confirmStatus":0}],"attachFiles":[{"fileType":"String","subDocumentId":0,"stepId":0,"id":0,"accessType":"Public","createdBy":0,"createdDate":"0001-01-01T00:00:00.0000000+07:06","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]}]}