tvpl.api

<back to all web services

SubmitWorkflowDeleteRequest

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


open class SubmitWorkflowDeleteRequest
{
    var documentId: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 documentId:Int? = null
    var requestedBy:Int? = null
    var requestedByName:String? = null
    var approverId:Int? = null
    var approverName:String? = null
    var status:Int? = null
    var reason:String? = null
    var comment:String? = null
    var createdAt:Date? = null
    var actionAt:Date? = null
}

Kotlin 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-instance/{DocumentId}/delete-request HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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