tvpl.api

SubmitWorkflowDeleteRequest

The following routes are available for this service:
POST	/workflow/{WorkflowId}/delete-request


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 SubmitWorkflowDeleteRequest
{
    public workflowId: number;
    public reason?: string;

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

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