tvpl.api

<back to all web services

GetWorkflowByIdRequest

Requires Authentication
The following routes are available for this service:
GET/workflow/{Id}
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 Workflow:
    id: int = 0
    # @Required()
    # @StringLength(500)
    title: Optional[str] = None

    # @StringLength(4000)
    description: Optional[str] = None

    # @StringLength(100)
    document_code: Optional[str] = None

    document_type_id: Optional[int] = None
    is_instance: bool = False
    main_id: Optional[int] = None
    is_active: bool = False
    status_id: Optional[int] = None
    account_id: Optional[int] = None
    department_id: Optional[int] = None
    # @Ignore()
    scope_type: int = 0

    # @StringLength(500)
    created_by: Optional[str] = None

    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    # @StringLength(500)
    updated_by: Optional[str] = None

    updated_at: Optional[datetime.datetime] = None


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

Python GetWorkflowByIdRequest 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 /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>