tvpl.api

<back to all web services

SubmitWorkflowDeleteRequest

Requires Authentication
The following routes are available for this service:
POST/workflow/{WorkflowId}/delete-request
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SubmitWorkflowDeleteRequest
{
    var workflowId:Int? = null
    var reason:String? = null
}

open class WorkflowDeleteRequestResponse
{
    var code:Int? = null
    var message:String? = null
    var requiresApproval:Boolean? = null
    var request:WorkflowDeleteRequestDetail? = null
}

open class WorkflowDeleteRequestDetail
{
    var id:Int? = null
    var workflowId:Int? = null
    var requestedBy:Int? = null
    var requestedByName:String? = null
    var approverId:Int? = null
    var approverName:String? = null
    var status:WorkflowDeleteRequestStatus? = null
    var reason:String? = null
    var comment:String? = null
    var createdAt:Date? = null
    var actionAt:Date? = null
}

enum class WorkflowDeleteRequestStatus
{
    Pending,
    Approved,
    Rejected,
    Cancelled,
}

Kotlin 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>