tvpl.api

<back to all web services

CreateWorkflowRequest

Requires Authentication
The following routes are available for this service:
POST/workflow

export class Workflow
{
    public id: number;
    // @Required()
    // @StringLength(500)
    public title: string;

    // @StringLength(4000)
    public description?: string;

    // @StringLength(100)
    public documentCode?: string;

    public documentTypeId?: number;
    public isInstance: boolean;
    public mainId?: number;
    public isActive: boolean;
    public statusId?: number;
    public accountId?: number;
    public departmentId?: number;
    // @Ignore()
    public scopeType: number;

    // @StringLength(500)
    public createdBy?: string;

    public createdAt: string;
    // @StringLength(500)
    public updatedBy?: string;

    public updatedAt?: string;

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

export class CreateWorkflowRequest
{
    public title: string;
    public description?: string;
    public documentCode?: string;
    public documentTypeId?: number;
    public isInstance: boolean;
    public mainId?: number;

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

TypeScript CreateWorkflowRequest 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 HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWorkflowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Description>String</Description>
  <DocumentCode>String</DocumentCode>
  <DocumentTypeId>0</DocumentTypeId>
  <IsInstance>false</IsInstance>
  <MainId>0</MainId>
  <Title>String</Title>
</CreateWorkflowRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Workflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
  <AccountId>0</AccountId>
  <CreatedAt>0001-01-01T00:00:00</CreatedAt>
  <CreatedBy>String</CreatedBy>
  <DeletedAt>0001-01-01T00:00:00</DeletedAt>
  <DeletedBy>String</DeletedBy>
  <DepartmentId>0</DepartmentId>
  <Description>String</Description>
  <DocumentCode>String</DocumentCode>
  <DocumentTypeId>0</DocumentTypeId>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <IsDeleted>false</IsDeleted>
  <IsInstance>false</IsInstance>
  <MainId>0</MainId>
  <StatusId>0</StatusId>
  <Title>String</Title>
  <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy>String</UpdatedBy>
</Workflow>