| POST | /WorkflowStep/update |
|---|
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
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
@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
# @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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStepResponse(IResponseRequest):
code: int = 0
message: Optional[str] = None
inserted_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWorkflowStepRequest(WorkflowStep):
pass
Python CreateWorkflowStepRequest 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.
POST /WorkflowStep/update HTTP/1.1
Host: etc-api.vsmlab.vn
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateWorkflowStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
<AttachedDocuments xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<StepAttached>
<DocumentCode>String</DocumentCode>
<Id>0</Id>
<IsSequentialSigning>false</IsSequentialSigning>
<OriginalFile>
<Checksum>String</Checksum>
<ETag>String</ETag>
<FileName>String</FileName>
<FileSize>0</FileSize>
<FileUrl>String</FileUrl>
<Filekey>String</Filekey>
<Code>0</Code>
<Id>0</Id>
<StepId>0</StepId>
<SubDocumentId>0</SubDocumentId>
<UploadedFile>String</UploadedFile>
</OriginalFile>
<PendingSignFile>
<Checksum>String</Checksum>
<ETag>String</ETag>
<FileName>String</FileName>
<FileSize>0</FileSize>
<FileUrl>String</FileUrl>
<Filekey>String</Filekey>
<Code>0</Code>
<Id>0</Id>
<StepId>0</StepId>
<SubDocumentId>0</SubDocumentId>
<UploadedFile>String</UploadedFile>
</PendingSignFile>
<SignerConfigs>
<SignerConfigDetail>
<ActionType>0</ActionType>
<DepartmentId>0</DepartmentId>
<OrderIndex>0</OrderIndex>
<SignerRefId>0</SignerRefId>
<SignerRefText>String</SignerRefText>
<SignerType>0</SignerType>
<SubDocumentId>0</SubDocumentId>
<CreateAt>0001-01-01T00:00:00</CreateAt>
<CreateBy>0</CreateBy>
<DocumentId>0</DocumentId>
<Id>0</Id>
<StepId>0</StepId>
<Profile>
<Avatar>String</Avatar>
<Birthday>0001-01-01T00:00:00</Birthday>
<ConfirmStatus>0</ConfirmStatus>
<ConfirmStatusText>String</ConfirmStatusText>
<DepartmentId>0</DepartmentId>
<Email>String</Email>
<FullName>String</FullName>
<Id>0</Id>
<IsSigned>false</IsSigned>
<Name>String</Name>
<OriginalFileId>0</OriginalFileId>
<SignAt>0001-01-01T00:00:00</SignAt>
<SignStatusText>String</SignStatusText>
<SignedFileId>0</SignedFileId>
<SignedFileName>String</SignedFileName>
<Telephone>String</Telephone>
</Profile>
<Role>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>0</CreatedBy>
<DeletedAt>0001-01-01T00:00:00</DeletedAt>
<DeletedBy>0</DeletedBy>
<Id>0</Id>
<Name>String</Name>
<Permission xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</Permission>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy>0</UpdatedBy>
</Role>
</SignerConfigDetail>
</SignerConfigs>
<Title>String</Title>
</StepAttached>
</AttachedDocuments>
<CoDepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:int>0</d2p1:int>
</CoDepartmentIds>
<CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
<CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
<DeletedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</DeletedAt>
<DeletedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</DeletedBy>
<DepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:int>0</d2p1:int>
</DepartmentIds>
<Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
<Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
<IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
<IsUsingForm xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsUsingForm>
<MainAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:int>0</d2p1:int>
</MainAssigneeIds>
<RequireAttachment xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</RequireAttachment>
<SLAInternalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLAInternalIsByDay>
<SLAInternalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAInternalValue>
<SLALegalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLALegalIsByDay>
<SLALegalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLALegalValue>
<SLAWarningSentAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</SLAWarningSentAt>
<SLAWarningSentCount xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAWarningSentCount>
<StatusId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StatusId>
<StepBasisDocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:int>0</d2p1:int>
</StepBasisDocumentIds>
<StepName xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</StepName>
<StepOrder xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StepOrder>
<SupportingAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
<d2p1:int>0</d2p1:int>
</SupportingAssigneeIds>
<UpdatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</UpdatedAt>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</UpdatedBy>
<WorkflowId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</WorkflowId>
</CreateWorkflowStepRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <WorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel"> <Code>0</Code> <InsertedId>0</InsertedId> <Message>String</Message> </WorkflowStepResponse>