tvpl.api

SubmitWorkflowDeleteRequest

The following routes are available for this service:
POST	/workflow/{WorkflowId}/delete-request

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


class WorkflowDeleteRequestStatus(str, Enum):
    PENDING = 'Pending'
    APPROVED = 'Approved'
    REJECTED = 'Rejected'
    CANCELLED = 'Cancelled'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowDeleteRequestDetail:
    id: int = 0
    workflow_id: int = 0
    requested_by: int = 0
    requested_by_name: Optional[str] = None
    approver_id: int = 0
    approver_name: Optional[str] = None
    status: Optional[WorkflowDeleteRequestStatus] = None
    reason: Optional[str] = None
    comment: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    action_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowDeleteRequestResponse:
    code: int = 0
    message: Optional[str] = None
    requires_approval: bool = False
    request: Optional[WorkflowDeleteRequestDetail] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubmitWorkflowDeleteRequest:
    workflow_id: int = 0
    reason: Optional[str] = None

Python SubmitWorkflowDeleteRequest 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.

POST /workflow/{WorkflowId}/delete-request HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubmitWorkflowDeleteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Reason>String</Reason>
  <WorkflowId>0</WorkflowId>
</SubmitWorkflowDeleteRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowDeleteRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Message>String</Message>
  <Request>
    <ActionAt>0001-01-01T00:00:00</ActionAt>
    <ApproverId>0</ApproverId>
    <ApproverName>String</ApproverName>
    <Comment>String</Comment>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <Id>0</Id>
    <Reason>String</Reason>
    <RequestedBy>0</RequestedBy>
    <RequestedByName>String</RequestedByName>
    <Status>Pending</Status>
    <WorkflowId>0</WorkflowId>
  </Request>
  <RequiresApproval>false</RequiresApproval>
</WorkflowDeleteRequestResponse>