tvpl.api

<back to all web services

SubmitWorkflowDeleteRequest

Requires Authentication
The following routes are available for this service:
POST/workflow/{WorkflowId}/delete-request
import Foundation
import ServiceStack

public class SubmitWorkflowDeleteRequest : Codable
{
    public var workflowId:Int
    public var reason:String

    required public init(){}
}

public class WorkflowDeleteRequestResponse : Codable
{
    public var code:Int
    public var message:String
    public var requiresApproval:Bool
    public var request:WorkflowDeleteRequestDetail

    required public init(){}
}

public class WorkflowDeleteRequestDetail : Codable
{
    public var id:Int
    public var workflowId:Int
    public var requestedBy:Int
    public var requestedByName:String
    public var approverId:Int
    public var approverName:String
    public var status:WorkflowDeleteRequestStatus
    public var reason:String
    public var comment:String
    public var createdAt:Date
    public var actionAt:Date?

    required public init(){}
}

public enum WorkflowDeleteRequestStatus : String, Codable
{
    case Pending
    case Approved
    case Rejected
    case Cancelled
}


Swift SubmitWorkflowDeleteRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"workflowId":0,"reason":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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","createdAt":"0001-01-01T00:00:00.0000000+07:06","actionAt":"0001-01-01T00:00:00.0000000+07:06"}}