tvpl.api

<back to all web services

GetWorkflowFlowchartRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/flowchart
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 WorkflowNode:
    step_id: int = 0
    step_name: Optional[str] = None
    signer_id: int = 0
    signer_name: Optional[str] = None
    department_name: Optional[str] = None
    telephone: Optional[str] = None
    avatar: Optional[str] = None
    email: Optional[str] = None
    signer_type: int = 0
    action_type: int = 0
    status: int = 0
    status_text: Optional[str] = None
    sign_status_text: Optional[str] = None
    sign_at: Optional[datetime.datetime] = None
    is_signed: bool = False
    confirm_status: Optional[int] = None
    confirm_status_text: Optional[str] = None
    signed_file_id: Optional[int] = None
    signed_file_name: Optional[str] = None
    is_current: bool = False
    reason_return: Optional[str] = None
    return_date: Optional[datetime.datetime] = None
    action_date: Optional[datetime.datetime] = None
    order_index: int = 0
    is_using_form: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWorkflowFlowchartResponse(IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    data: Optional[List[WorkflowNode]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWorkflowFlowchartRequest:
    workflow_id: int = 0

Python GetWorkflowFlowchartRequest DTOs

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

<GetWorkflowFlowchartResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data>
    <WorkflowNode>
      <ActionDate>0001-01-01T00:00:00</ActionDate>
      <ActionType>0</ActionType>
      <Avatar>String</Avatar>
      <ConfirmStatus>0</ConfirmStatus>
      <ConfirmStatusText>String</ConfirmStatusText>
      <DepartmentName>String</DepartmentName>
      <Email>String</Email>
      <IsCurrent>false</IsCurrent>
      <IsSigned>false</IsSigned>
      <IsUsingForm>false</IsUsingForm>
      <OrderIndex>0</OrderIndex>
      <ReasonReturn>String</ReasonReturn>
      <ReturnDate>0001-01-01T00:00:00</ReturnDate>
      <SignAt>0001-01-01T00:00:00</SignAt>
      <SignStatusText>String</SignStatusText>
      <SignedFileId>0</SignedFileId>
      <SignedFileName>String</SignedFileName>
      <SignerId>0</SignerId>
      <SignerName>String</SignerName>
      <SignerType>0</SignerType>
      <Status>0</Status>
      <StatusText>String</StatusText>
      <StepId>0</StepId>
      <StepName>String</StepName>
      <Telephone>String</Telephone>
    </WorkflowNode>
  </Data>
  <Message>String</Message>
</GetWorkflowFlowchartResponse>