tvpl.api

<back to all web services

GetWorkflowProfileRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/profile
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 WorkflowProfileItem:
    file_id: int = 0
    title: Optional[str] = None
    document_code: Optional[str] = None
    file_key: Optional[str] = None
    file_url: Optional[str] = None
    updated_at: Optional[datetime.datetime] = None
    step_title: Optional[str] = None


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


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

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