tvpl.api

<back to all web services

UpdateStepStatusRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/status
UpdateStepStatusRequest Parameters:
NameParameterData TypeRequiredDescription
StepIdbodyintNo
StatusKeybodyCategoryStatusKeysNo
CommentbodystringNo
CategoryStatusKeys Enum:
WorkCreatedQuy trình mới tạo
WorkInProgressQuy trình đang thực hiện
WorkReturnedTrả lại
WorkCompletedHoàn thành Quy trình
WorkCancelledHủy Quy trình
WorkDoneQuy trình đã kết thúc
StepNotStartedStep Chưa thực hiện
StepInProgressStep Đang thực hiện
StepDoneKết thúc Step
StepCompletedHoàn thành Step
StepSkippedBỏ qua Step
StepReturnedTrả lại Step
NotSignedChưa ký
SignatureReturnedTrả lại
SignaturePendingChờ ký
WorkflowStepResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
InsertedIdformintNo

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /WorkflowStep/status HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateStepStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Comment>String</Comment>
  <StatusKey>WorkCreated</StatusKey>
  <StepId>0</StepId>
</UpdateStepStatusRequest>

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>