tvpl.api

<back to all web services

CreateWorkflowStepRequest

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

export class WorkflowStep
{
    public id: number;
    // @References("typeof(tvpl.data.Models.Document)")
    public workflowId: number;

    public stepOrder?: number;
    // @Required()
    // @StringLength(255)
    public stepName: string;

    // @Required()
    public isRequired: boolean;

    public slaLegalValue?: number;
    public slaLegalIsByDay?: boolean;
    public slaInternalValue?: number;
    public slaInternalIsByDay?: boolean;
    public requireAttachment: boolean;
    // @Required()
    public description: string;

    public createdBy: number;
    // @Ignore()
    public departmentIds?: number[];

    // @Ignore()
    public stepBasisDocumentIds?: number[];

    // @Ignore()
    public stepAttachedIds?: number[];

    // @Ignore()
    public mainAssigneeIds?: number[];

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

export class WorkflowStepResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public insertedId: number;

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

export class BasicUploadedFile
{
    public fileName: string;
    public filekey: string;
    public fileUrl: string;
    public checksum: string;
    public eTag: string;
    public fileSize: number;

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

export class UploadedFiles extends BasicUploadedFile
{
    public id?: number;
    public uploadedFile: string;
    public subDocumentId?: number;
    public stepId?: number;
    public code: number;

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

export class CreateWorkflowStepRequest extends WorkflowStep
{
    public stepAttachFiles?: UploadedFiles[];

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

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

<CreateWorkflowStepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <CreatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</CreatedAt>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</CreatedBy>
  <DeletedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</DeletedAt>
  <DeletedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</DeletedBy>
  <DepartmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </DepartmentIds>
  <Description xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Description>
  <Id xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</Id>
  <IsRequired xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</IsRequired>
  <MainAssigneeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </MainAssigneeIds>
  <RequireAttachment xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</RequireAttachment>
  <SLAInternalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLAInternalIsByDay>
  <SLAInternalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAInternalValue>
  <SLALegalIsByDay xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">false</SLALegalIsByDay>
  <SLALegalValue xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLALegalValue>
  <SLAWarningSentAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</SLAWarningSentAt>
  <SLAWarningSentCount xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</SLAWarningSentCount>
  <StepAttachedIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </StepAttachedIds>
  <StepBasisDocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:int>0</d2p1:int>
  </StepBasisDocumentIds>
  <StepName xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</StepName>
  <StepOrder xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</StepOrder>
  <UpdatedAt xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0001-01-01T00:00:00</UpdatedAt>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</UpdatedBy>
  <WorkflowId xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</WorkflowId>
  <StepAttachFiles>
    <UploadedFiles>
      <Checksum xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Checksum>
      <ETag xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</ETag>
      <FileName xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</FileName>
      <FileSize xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">0</FileSize>
      <FileUrl xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</FileUrl>
      <Filekey xmlns="http://schemas.datacontract.org/2004/07/tvpl.data.Models">String</Filekey>
      <Code>0</Code>
      <Id>0</Id>
      <StepId>0</StepId>
      <SubDocumentId>0</SubDocumentId>
      <UploadedFile>String</UploadedFile>
    </UploadedFiles>
  </StepAttachFiles>
</CreateWorkflowStepRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <InsertedId>0</InsertedId>
  <Message>String</Message>
</WorkflowStepResponse>