| POST | /document/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 BasicDocument:
# @Required()
title: Optional[str] = None
# @StringLength(4000)
description: Optional[str] = None
# @StringLength(500)
owner: Optional[str] = None
document_policy_id: Optional[int] = None
update_document_id: Optional[int] = None
effect_begin_date: Optional[datetime.datetime] = None
effect_end_date: Optional[datetime.datetime] = None
issuing_agency_id: Optional[int] = None
document_type_id: Optional[int] = None
document_group_id: Optional[int] = None
subject_id: Optional[int] = None
# @StringLength(500)
sign_by: Optional[str] = None
sign_date: Optional[datetime.datetime] = None
status_id: Optional[int] = None
is_internal: bool = False
document_number: Optional[str] = None
document_code: Optional[str] = None
is_urgent: Optional[bool] = None
scope_type: Optional[int] = None
is_active: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentSearchResultItem:
title: Optional[str] = None
description: Optional[str] = None
owner: Optional[str] = None
document_policy_id: Optional[int] = None
update_document_id: Optional[int] = None
effect_begin_date: Optional[datetime.datetime] = None
effect_end_date: Optional[datetime.datetime] = None
issuing_agency_id: Optional[int] = None
subject_id: Optional[int] = None
sign_by: Optional[str] = None
sign_date: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
status_id: Optional[int] = None
is_internal: bool = False
document_number: Optional[str] = None
document_code: Optional[str] = None
is_urgent: Optional[bool] = None
id: int = 0
reason_return: Optional[str] = None
account_id: Optional[int] = None
approver_id: Optional[int] = None
# @StringLength(500)
updated_by: Optional[str] = None
# @StringLength(500)
created_by: Optional[str] = None
is_party: Optional[bool] = None
is_revision_requested: Optional[bool] = None
is_private: Optional[bool] = None
department_id: Optional[int] = None
publication_date: Optional[datetime.datetime] = None
process_status_id: int = 0
document_type_id: Optional[int] = None
document_group_id: Optional[int] = None
account_name: Optional[str] = None
accept_account_name: Optional[str] = None
document_group_text: Optional[str] = None
process_status_text: Optional[str] = None
document_type_text: Optional[str] = None
department_text: Optional[str] = None
status_text: Optional[str] = None
issuing_agency_text: Optional[str] = None
subject_text: Optional[str] = None
comment: Optional[str] = None
submit_comment: Optional[str] = None
full_file: Optional[str] = None
parth_file: Optional[str] = None
is_active: Optional[bool] = None
step_order: Optional[int] = None
step_count: 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 UserLogin:
# @Required()
name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfile(UserLogin):
id: int = 0
full_name: Optional[str] = None
email: Optional[str] = None
department_id: Optional[int] = None
party_group_id: Optional[int] = None
avatar: Optional[str] = None
telephone: Optional[str] = None
birthday: Optional[datetime.datetime] = None
created_at: Optional[datetime.datetime] = None
updated_at: Optional[datetime.datetime] = None
failed_login_count: int = 0
# @Ignore()
roles: Optional[List[int]] = None
last_login_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApproversProfile:
user_profiles: Optional[List[UserProfile]] = None
process_status_id: int = 0
process_title: Optional[str] = None
action_button_label: Optional[str] = None
process_description: Optional[str] = None
is_approval_required: bool = False
is_final_step: bool = False
step_order: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CurrentApprover:
approver_id: Optional[int] = None
status: Optional[str] = None
process_status_id: int = 0
process_title: Optional[str] = None
action_button_label: Optional[str] = None
process_description: Optional[str] = None
is_approval_required: bool = False
is_final_step: bool = False
step_order: int = 0
@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 DocumentDetail(DocumentSearchResultItem):
part_uploaded_file: Optional[UploadedFileAttach] = None
compact_uploaded_file: Optional[UploadedFileAttach] = None
analysis_uploaded_file: Optional[UploadedFileAttach] = None
full_uploaded_file: Optional[UploadedFileAttach] = None
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
next_approver: Optional[ApproversProfile] = None
current_approver: Optional[CurrentApprover] = None
attach_files: Optional[List[UploadedFileAttach]] = None
has_read_permission: bool = False
can_grant_read_permission: bool = False
basis_document: Optional[List[SimpleDocumentRelation]] = None
basis_for_document: Optional[List[SimpleDocumentRelation]] = None
main_document: Optional[SimpleDocumentRelation] = None
reference_document: Optional[List[SimpleDocumentRelation]] = None
referenced_by_document: Optional[List[SimpleDocumentRelation]] = None
replaced_document: Optional[List[SimpleDocumentRelation]] = None
replaced_by_document: Optional[List[SimpleDocumentRelation]] = None
expired_document: Optional[List[SimpleDocumentRelation]] = None
expired_by_document: Optional[List[SimpleDocumentRelation]] = None
update_for_document: Optional[SimpleDocumentRelation] = None
scope_type: Optional[int] = None
step_order: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentDetailResponse(IResponseRequest):
data: Optional[DocumentDetail] = None
code: int = 0
message: Optional[str] = None
@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 UpdateDocumentRequest(BasicDocument):
part_uploaded_file: Optional[UploadedFiles] = None
compact_uploaded_file: Optional[UploadedFiles] = None
analysis_uploaded_file: Optional[UploadedFiles] = None
full_uploaded_file: Optional[UploadedFiles] = None
attach_files: Optional[List[UploadedFiles]] = None
basis_document_id: Optional[List[int]] = None
reference_document_id: Optional[List[int]] = None
replaced_document_id: Optional[List[int]] = None
expired_document_id: Optional[List[int]] = None
id: int = 0
Python UpdateDocumentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /document/update HTTP/1.1
Host: etc-api.vsmlab.vn
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"partUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"compactUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"analysisUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"fullUploadedFile":{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0},"attachFiles":[{"id":0,"uploadedFile":"String","subDocumentId":0,"stepId":0,"code":0,"fileName":"String","filekey":"String","fileUrl":"String","checksum":"String","eTag":"String","fileSize":0}],"basisDocumentId":[0],"referenceDocumentId":[0],"replacedDocumentId":[0],"expiredDocumentId":[0],"id":0,"title":"String","description":"String","owner":"String","documentPolicyId":0,"updateDocumentId":0,"effectBeginDate":"0001-01-01T00:00:00.0000000+07:06","effectEndDate":"0001-01-01T00:00:00.0000000+07:06","issuingAgencyId":0,"documentTypeId":0,"documentGroupId":0,"subjectId":0,"signBy":"String","signDate":"0001-01-01T00:00:00.0000000+07:06","statusId":0,"isInternal":false,"documentNumber":"String","documentCode":"String","isUrgent":false,"scopeType":0,"isActive":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"data":{"partUploadedFile":{"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},"compactUploadedFile":{"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},"analysisUploadedFile":{"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},"fullUploadedFile":{"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},"createdAt":"0001-01-01T00:00:00.0000000+07:06","nextApprover":{"userProfiles":[{"id":0,"fullName":"String","email":"String","departmentId":0,"partyGroupId":0,"avatar":"String","telephone":"String","birthday":"0001-01-01T00:00:00.0000000+07:06","createdAt":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","failedLoginCount":0,"roles":[0],"lastLoginDate":"0001-01-01T00:00:00.0000000+07:06","name":"String"}],"processStatusId":0,"processTitle":"String","actionButtonLabel":"String","processDescription":"String","isApprovalRequired":false,"isFinalStep":false,"stepOrder":0},"currentApprover":{"approverId":0,"status":"String","processStatusId":0,"processTitle":"String","actionButtonLabel":"String","processDescription":"String","isApprovalRequired":false,"isFinalStep":false,"stepOrder":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}],"hasReadPermission":false,"canGrantReadPermission":false,"basisDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"basisForDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"mainDocument":{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"},"referenceDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"referencedByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"replacedDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"replacedByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"expiredDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"expiredByDocument":[{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"}],"updateForDocument":{"id":0,"title":"String","documentCode":"String","publicationDate":"0001-01-01T00:00:00.0000000+07:06"},"scopeType":0,"stepOrder":0,"title":"String","description":"String","owner":"String","documentPolicyId":0,"updateDocumentId":0,"effectBeginDate":"0001-01-01T00:00:00.0000000+07:06","effectEndDate":"0001-01-01T00:00:00.0000000+07:06","issuingAgencyId":0,"subjectId":0,"signBy":"String","signDate":"0001-01-01T00:00:00.0000000+07:06","updatedAt":"0001-01-01T00:00:00.0000000+07:06","statusId":0,"isInternal":false,"documentNumber":"String","documentCode":"String","isUrgent":false,"id":0,"reasonReturn":"String","accountId":0,"approverId":0,"updatedBy":"String","createdBy":"String","isParty":false,"isRevisionRequested":false,"isPrivate":false,"departmentId":0,"publicationDate":"0001-01-01T00:00:00.0000000+07:06","processStatusId":0,"documentTypeId":0,"documentGroupId":0,"accountName":"String","acceptAccountName":"String","documentGroupText":"String","processStatusText":"String","documentTypeText":"String","departmentText":"String","statusText":"String","issuingAgencyText":"String","subjectText":"String","comment":"String","submitComment":"String","fullFile":"String","parthFile":"String","isActive":false,"stepOrder":0,"stepCount":0},"code":0,"message":"String"}