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 .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"
	}
}