tvpl.api

<back to all web services

SubmitWorkflowDeleteRequest

Requires Authentication
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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	workflowId: 0,
	reason: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	requiresApproval: False,
	request: 
	{
		id: 0,
		workflowId: 0,
		requestedBy: 0,
		requestedByName: String,
		approverId: 0,
		approverName: String,
		status: Pending,
		reason: String,
		comment: String,
		actionAt: "0001-01-01T00:00:00.0000000+07:06"
	}
}