tvpl.api

<back to all web services

GetWorkflowProfileRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/profile
GetWorkflowProfileRequest Parameters:
NameParameterData TypeRequiredDescription
WorkflowIdqueryintNo
GetWorkflowProfileResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<WorkflowProfileItem>No
WorkflowProfileItem Parameters:
NameParameterData TypeRequiredDescription
FileIdformintNo
TitleformstringNo
DocumentCodeformstringNo
FileKeyformstringNo
FileUrlformstringNo
UpdatedAtformDateTime?No
StepTitleformstringNo

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 /WorkflowStep/profile HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetWorkflowProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data>
    <WorkflowProfileItem>
      <DocumentCode>String</DocumentCode>
      <FileId>0</FileId>
      <FileKey>String</FileKey>
      <FileUrl>String</FileUrl>
      <StepTitle>String</StepTitle>
      <Title>String</Title>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </WorkflowProfileItem>
  </Data>
  <Message>String</Message>
</GetWorkflowProfileResponse>