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.*;

public class dtos
{

    public static class SubmitWorkflowDeleteRequest
    {
        public Integer workflowId = null;
        public String reason = null;
        
        public Integer getWorkflowId() { return workflowId; }
        public SubmitWorkflowDeleteRequest setWorkflowId(Integer value) { this.workflowId = value; return this; }
        public String getReason() { return reason; }
        public SubmitWorkflowDeleteRequest setReason(String value) { this.reason = value; return this; }
    }

    public static class WorkflowDeleteRequestResponse
    {
        public Integer code = null;
        public String message = null;
        public Boolean requiresApproval = null;
        public WorkflowDeleteRequestDetail request = null;
        
        public Integer getCode() { return code; }
        public WorkflowDeleteRequestResponse setCode(Integer value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public WorkflowDeleteRequestResponse setMessage(String value) { this.message = value; return this; }
        public Boolean isRequiresApproval() { return requiresApproval; }
        public WorkflowDeleteRequestResponse setRequiresApproval(Boolean value) { this.requiresApproval = value; return this; }
        public WorkflowDeleteRequestDetail getRequest() { return request; }
        public WorkflowDeleteRequestResponse setRequest(WorkflowDeleteRequestDetail value) { this.request = value; return this; }
    }

    public static class WorkflowDeleteRequestDetail
    {
        public Integer id = null;
        public Integer workflowId = null;
        public Integer requestedBy = null;
        public String requestedByName = null;
        public Integer approverId = null;
        public String approverName = null;
        public WorkflowDeleteRequestStatus status = null;
        public String reason = null;
        public String comment = null;
        public Date createdAt = null;
        public Date actionAt = null;
        
        public Integer getId() { return id; }
        public WorkflowDeleteRequestDetail setId(Integer value) { this.id = value; return this; }
        public Integer getWorkflowId() { return workflowId; }
        public WorkflowDeleteRequestDetail setWorkflowId(Integer value) { this.workflowId = value; return this; }
        public Integer getRequestedBy() { return requestedBy; }
        public WorkflowDeleteRequestDetail setRequestedBy(Integer value) { this.requestedBy = value; return this; }
        public String getRequestedByName() { return requestedByName; }
        public WorkflowDeleteRequestDetail setRequestedByName(String value) { this.requestedByName = value; return this; }
        public Integer getApproverId() { return approverId; }
        public WorkflowDeleteRequestDetail setApproverId(Integer value) { this.approverId = value; return this; }
        public String getApproverName() { return approverName; }
        public WorkflowDeleteRequestDetail setApproverName(String value) { this.approverName = value; return this; }
        public WorkflowDeleteRequestStatus getStatus() { return status; }
        public WorkflowDeleteRequestDetail setStatus(WorkflowDeleteRequestStatus value) { this.status = value; return this; }
        public String getReason() { return reason; }
        public WorkflowDeleteRequestDetail setReason(String value) { this.reason = value; return this; }
        public String getComment() { return comment; }
        public WorkflowDeleteRequestDetail setComment(String value) { this.comment = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public WorkflowDeleteRequestDetail setCreatedAt(Date value) { this.createdAt = value; return this; }
        public Date getActionAt() { return actionAt; }
        public WorkflowDeleteRequestDetail setActionAt(Date value) { this.actionAt = value; return this; }
    }

    public static enum WorkflowDeleteRequestStatus
    {
        Pending,
        Approved,
        Rejected,
        Cancelled;
    }

}

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