tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
WorkflowStep Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorkflowIdformintNo
StepOrderformint?No
StatusIdformint?No
StepNameformstringYes
IsRequiredformboolYes
SLALegalValueformint?No
SLALegalIsByDayformbool?No
SLAInternalValueformint?No
SLAInternalIsByDayformbool?No
RequireAttachmentformboolNo
IsUsingFormformbool?No
DescriptionformstringYes
CreatedByformintNo
DepartmentIdsformList<int>No
MainAssigneeIdsformList<int>No
CoDepartmentIdsformList<int>No
SupportingAssigneeIdsformList<int>No
StepBasisDocumentIdsformList<int>No
AttachedDocumentsformList<StepAttached>No
StepAttached Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DocumentCodeformstringNo
TitleformstringNo
IsSequentialSigningformbool?No
PendingSignFileformUploadedFilesNo
OriginalFileformUploadedFilesNo
SignerConfigsformList<SignerConfigDetail>No
UploadedFiles Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
UploadedFileformstringYes
SubDocumentIdformint?No
StepIdformint?No
CodeformintNo
BasicUploadedFile Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringYes
FilekeyformstringYes
FileUrlformstringYes
ChecksumformstringYes
ETagformstringYes
FileSizeformlongNo
SignerConfigDetail Parameters:
NameParameterData TypeRequiredDescription
ProfileformWorkFlowProfileNo
RoleformRolesNo
SignerConfig Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DocumentIdformintNo
StepIdformint?No
BasicSignerConfig Parameters:
NameParameterData TypeRequiredDescription
SubDocumentIdformint?No
DepartmentIdformint?No
SignerTypeformbyteNo
SignerRefIdformintNo
SignerRefTextformstringNo
ActionTypeformbyteNo
OrderIndexformintNo
WorkFlowProfile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
FullNameformstringNo
EmailformstringNo
DepartmentIdformint?No
AvatarformstringNo
TelephoneformstringNo
BirthdayformDateTime?No
ConfirmStatusformint?No
ConfirmStatusTextformstringNo
SignAtformDateTime?No
SignedFileIdformlong?No
OriginalFileIdformint?No
SignedFileNameformstringNo
IsSignedformboolNo
SignStatusTextformstringNo
Roles Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
CreatedAtformDateTime?No
DeletedAtformDateTime?No
UpdatedAtformDateTime?No
UpdatedByformint?No
DeletedByformint?No
CreatedByformint?No
PermissionformList<string>No
WorkflowStepResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
InsertedIdformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"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,"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","signAt":"0001-01-01T00:00:00.0000000+07:06","signedFileId":0,"originalFileId":0,"signedFileName":"String","isSigned":false,"signStatusText":"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}]}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"code":0,"message":"String","insertedId":0}