tvpl.api

<back to all web services

CancelWorkflowDeleteRequest

Requires Authentication
The following routes are available for this service:
POST/workflow-delete-request/{Id}/cancel

export enum WorkflowDeleteRequestStatus
{
    Pending = 'Pending',
    Approved = 'Approved',
    Rejected = 'Rejected',
    Cancelled = 'Cancelled',
}

export class WorkflowDeleteRequestDetail
{
    public id: number;
    public workflowId: number;
    public requestedBy: number;
    public requestedByName?: string;
    public approverId: number;
    public approverName?: string;
    public status: WorkflowDeleteRequestStatus;
    public reason?: string;
    public comment?: string;
    public createdAt: string;
    public actionAt?: string;

    public constructor(init?: Partial<WorkflowDeleteRequestDetail>) { (Object as any).assign(this, init); }
}

export class WorkflowDeleteRequestResponse
{
    public code: number;
    public message?: string;
    public requiresApproval: boolean;
    public request?: WorkflowDeleteRequestDetail;

    public constructor(init?: Partial<WorkflowDeleteRequestResponse>) { (Object as any).assign(this, init); }
}

export class CancelWorkflowDeleteRequest
{
    public id: number;

    public constructor(init?: Partial<CancelWorkflowDeleteRequest>) { (Object as any).assign(this, init); }
}

TypeScript CancelWorkflowDeleteRequest 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-delete-request/{Id}/cancel HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}
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"
	}
}