| GET | /WorkflowStep/{WorkflowId}/{StepId} |
|---|
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 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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedFiles(BasicUploadedFile):
id: Optional[int] = None
uploaded_file: Optional[str] = None
sub_document_id: Optional[int] = None
step_id: Optional[int] = None
code: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicSignerConfig:
sub_document_id: Optional[int] = None
department_id: Optional[int] = None
signer_type: int = 0
signer_ref_id: int = 0
# @Ignore()
signer_ref_text: Optional[str] = None
action_type: int = 0
order_index: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignerConfig(BasicSignerConfig):
id: int = 0
document_id: int = 0
step_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkFlowProfile:
id: int = 0
name: Optional[str] = None
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
confirm_status_text: Optional[str] = None
confirm_at: Optional[datetime.datetime] = None
sign_at: Optional[datetime.datetime] = None
signed_file_id: Optional[int] = None
original_file_id: Optional[int] = None
signed_file_name: Optional[str] = None
is_signed: bool = False
sign_status_text: Optional[str] = None
comment: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Roles:
id: int = 0
# @StringLength(50)
name: Optional[str] = None
created_at: Optional[datetime.datetime] = None
deleted_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
updated_by: Optional[int] = None
deleted_by: Optional[int] = None
created_by: Optional[int] = None
# @Ignore()
permission: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SignerConfigDetail(SignerConfig):
profile: Optional[WorkFlowProfile] = None
role: Optional[Roles] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StepAttached:
id: int = 0
document_code: Optional[str] = None
title: Optional[str] = None
is_sequential_signing: Optional[bool] = None
pending_sign_file: Optional[UploadedFiles] = None
original_file: Optional[UploadedFiles] = None
signer_configs: Optional[List[SignerConfigDetail]] = None
@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
status_id: 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
is_using_form: Optional[bool] = None
# @Required()
description: Optional[str] = None
created_by: int = 0
updated_at: Optional[datetime.datetime] = None
default_attached_document_id: Optional[int] = None
# @Ignore()
department_ids: Optional[List[int]] = None
# @Ignore()
main_assignee_ids: Optional[List[int]] = None
# @Ignore()
co_department_ids: Optional[List[int]] = None
# @Ignore()
supporting_assignee_ids: Optional[List[int]] = None
# @Ignore()
step_basis_document_ids: Optional[List[int]] = None
# @Ignore()
attached_documents: Optional[List[StepAttached]] = None
# @Ignore()
attached_files: Optional[List[UploadedFiles]] = 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'
WORK_STATUS = 'WorkStatus'
STEP_STATUS = 'StepStatus'
SIGN_STATUS = 'SignStatus'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCategoryModel:
name: Optional[str] = None
long_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
key: Optional[str] = None
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
is_sequential_signing: Optional[bool] = None
status_text: Optional[str] = None
status_key: Optional[str] = None
document_type_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStepDetail(WorkflowStep):
departments: Optional[List[Category]] = None
co_departments: Optional[List[Category]] = None
basis_documents: Optional[List[SimpleDocumentRelation]] = None
reference_documents: Optional[List[SimpleDocumentRelation]] = None
main_assignees: Optional[List[WorkFlowProfile]] = None
supporting_assignees: Optional[List[WorkFlowProfile]] = None
status_key: Optional[str] = None
status_text: Optional[str] = None
# @Ignore()
can_read: Optional[bool] = None
# @Ignore()
can_write: Optional[bool] = None
# @Ignore()
can_upload: Optional[bool] = None
reason_return: Optional[str] = None
return_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSingleWorkflowStepResponse(IResponseRequest):
code: int = 0
message: Optional[str] = None
data: Optional[WorkflowStepDetail] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSingleWorkflowStepRequest:
workflow_id: int = 0
step_id: int = 0
Python GetSingleWorkflowStepRequest 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/{WorkflowId}/{StepId} 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,
longName: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
longName: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
longName: 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,
longName: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
longName: String,
description: String,
type: Department,
isParty: False,
childList:
[
0
]
}
],
name: String,
longName: 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,
statusKey: String,
documentTypeId: 0
}
],
referenceDocuments:
[
{
id: 0,
title: String,
documentCode: String,
publicationDate: "0001-01-01T00:00:00.0000000+07:06",
isSequentialSigning: False,
statusText: String,
statusKey: 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,
confirmAt: "0001-01-01T00:00:00.0000000+07:06",
signAt: "0001-01-01T00:00:00.0000000+07:06",
signedFileId: 0,
originalFileId: 0,
signedFileName: String,
isSigned: False,
signStatusText: String,
comment: 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,
confirmAt: "0001-01-01T00:00:00.0000000+07:06",
signAt: "0001-01-01T00:00:00.0000000+07:06",
signedFileId: 0,
originalFileId: 0,
signedFileName: String,
isSigned: False,
signStatusText: String,
comment: 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,
updatedAt: "0001-01-01T00:00:00.0000000+07:06",
defaultAttachedDocumentId: 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,
confirmAt: "0001-01-01T00:00:00.0000000+07:06",
signAt: "0001-01-01T00:00:00.0000000+07:06",
signedFileId: 0,
originalFileId: 0,
signedFileName: String,
isSigned: False,
signStatusText: String,
comment: 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
}
]
}
],
attachedFiles:
[
{
id: 0,
uploadedFile: String,
subDocumentId: 0,
stepId: 0,
code: 0,
fileName: String,
filekey: String,
fileUrl: String,
checksum: String,
eTag: String,
fileSize: 0
}
]
}
}