tvpl.api

<back to all web services

GetWorkflowByIdRequest

Requires Authentication
The following routes are available for this service:
GET/workflow/{Id}
GetWorkflowByIdRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
Workflow Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TitleformstringYes
DescriptionformstringNo
DocumentCodeformstringNo
DocumentTypeIdformint?No
IsInstanceformboolNo
MainIdformint?No
IsActiveformboolNo
StatusIdformint?No
AccountIdformint?No
DepartmentIdformint?No
ScopeTypeformintNo
CreatedByformstringNo
CreatedAtformDateTimeNo
UpdatedByformstringNo
UpdatedAtformDateTime?No

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.

GET /workflow/{Id} HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Workflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <AccountId>0</AccountId>
  <CreatedAt>0001-01-01T00:00:00</CreatedAt>
  <CreatedBy>String</CreatedBy>
  <DeletedAt>0001-01-01T00:00:00</DeletedAt>
  <DeletedBy>String</DeletedBy>
  <DepartmentId>0</DepartmentId>
  <Description>String</Description>
  <DocumentCode>String</DocumentCode>
  <DocumentTypeId>0</DocumentTypeId>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <IsInstance>false</IsInstance>
  <MainId>0</MainId>
  <StatusId>0</StatusId>
  <Title>String</Title>
  <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy>String</UpdatedBy>
</Workflow>