tvpl.api

GetWorkflowStepRequest

The following routes are available for this service:
GET	/WorkflowStep/by-workflow


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 enum CategoryTypes
{
    Department = 'Department',
    PartyGroup = 'PartyGroup',
    DocGroup = 'DocGroup',
    DocType = 'DocType',
    IssuingAgency = 'IssuingAgency',
    Status = 'Status',
    Subjects = 'Subjects',
    Workflow = 'Workflow',
}

export class CreateCategoryModel
{
    public name: string;
    public description: string;
    public type: CategoryTypes;
    public isParty: boolean;
    // @Ignore()
    public childList?: number[];

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

export class Category extends CreateCategoryModel
{
    public id: number;
    public level: number;
    public sortOrder: number;
    public lastUpdate?: string;
    // @Ignore()
    public children: Category[];

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

export class SimpleDocumentRelation
{
    public id: number;
    public title: string;
    public documentCode: string;
    public publicationDate?: string;

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

export class WorkFlowProfile
{
    public id: number;
    public fullName?: string;
    public email?: string;
    public departmentId?: number;
    public avatar?: string;
    public telephone?: string;
    public birthday?: string;
    public confirmStatus?: number;

    public constructor(init?: Partial<WorkFlowProfile>) { (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 enum AccessType
{
    Public = 'Public',
    Restricted = 'Restricted',
}

export class UploadedFileModel extends BasicUploadedFile
{
    public id: number;
    public accessType: AccessType;
    public createdBy: number;
    public createdDate: string;

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

export class UploadedFileAttach extends UploadedFileModel
{
    public fileType: string;
    public subDocumentId?: number;
    public stepId?: number;

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

export class WorkflowStepDetail extends WorkflowStep
{
    public departments?: Category[];
    public basisDocuments?: SimpleDocumentRelation[];
    public attachedDocuments?: SimpleDocumentRelation[];
    public referenceDocuments?: SimpleDocumentRelation[];
    public mainAssignees?: WorkFlowProfile[];
    public attachFiles?: UploadedFileAttach[];

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

export class GetWorkflowStepResponse implements IResponseRequest
{
    public code: number;
    public message: string;
    public data?: WorkflowStepDetail[];

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

export class GetWorkflowStepRequest
{
    public workflowId: number;

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

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

GET /WorkflowStep/by-workflow HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<GetWorkflowStepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <Code>0</Code>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/tvpl.data.Models">
    <d2p1:WorkflowStepDetail>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:CreatedBy>0</d2p1:CreatedBy>
      <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
      <d2p1:DeletedBy>0</d2p1:DeletedBy>
      <d2p1:DepartmentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:DepartmentIds>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsRequired>false</d2p1:IsRequired>
      <d2p1:MainAssigneeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:MainAssigneeIds>
      <d2p1:RequireAttachment>false</d2p1:RequireAttachment>
      <d2p1:SLAInternalIsByDay>false</d2p1:SLAInternalIsByDay>
      <d2p1:SLAInternalValue>0</d2p1:SLAInternalValue>
      <d2p1:SLALegalIsByDay>false</d2p1:SLALegalIsByDay>
      <d2p1:SLALegalValue>0</d2p1:SLALegalValue>
      <d2p1:SLAWarningSentAt>0001-01-01T00:00:00</d2p1:SLAWarningSentAt>
      <d2p1:SLAWarningSentCount>0</d2p1:SLAWarningSentCount>
      <d2p1:StepAttachedIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepAttachedIds>
      <d2p1:StepBasisDocumentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:StepBasisDocumentIds>
      <d2p1:StepName>String</d2p1:StepName>
      <d2p1:StepOrder>0</d2p1:StepOrder>
      <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
      <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
      <d2p1:WorkflowId>0</d2p1:WorkflowId>
      <d2p1:AttachFiles>
        <d2p1:UploadedFileAttach>
          <d2p1:Checksum>String</d2p1:Checksum>
          <d2p1:ETag>String</d2p1:ETag>
          <d2p1:FileName>String</d2p1:FileName>
          <d2p1:FileSize>0</d2p1:FileSize>
          <d2p1:FileUrl>String</d2p1:FileUrl>
          <d2p1:Filekey>String</d2p1:Filekey>
          <d2p1:AccessType>Public</d2p1:AccessType>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:FileType>String</d2p1:FileType>
          <d2p1:StepId>0</d2p1:StepId>
          <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
        </d2p1:UploadedFileAttach>
      </d2p1:AttachFiles>
      <d2p1:AttachedDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:AttachedDocuments>
      <d2p1:BasisDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:BasisDocuments>
      <d2p1:Departments>
        <d2p1:Category>
          <d2p1:ChildList xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:ChildList>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:IsParty>false</d2p1:IsParty>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Type>Department</d2p1:Type>
          <d2p1:Children>
            <d2p1:Category>
              <d2p1:ChildList xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d2p1:ChildList>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:IsParty>false</d2p1:IsParty>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Type>Department</d2p1:Type>
              <d2p1:Children>
                <d2p1:Category>
                  <d2p1:ChildList xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                    <d10p1:int>0</d10p1:int>
                  </d2p1:ChildList>
                  <d2p1:Description>String</d2p1:Description>
                  <d2p1:IsParty>false</d2p1:IsParty>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:Type>Department</d2p1:Type>
                  <d2p1:Children i:nil="true" />
                  <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
                  <d2p1:CreatedBy>0</d2p1:CreatedBy>
                  <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
                  <d2p1:DeletedBy>0</d2p1:DeletedBy>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:IsDeleted>false</d2p1:IsDeleted>
                  <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
                  <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
                  <d2p1:Level>0</d2p1:Level>
                  <d2p1:SortOrder>0</d2p1:SortOrder>
                </d2p1:Category>
              </d2p1:Children>
              <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
              <d2p1:CreatedBy>0</d2p1:CreatedBy>
              <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
              <d2p1:DeletedBy>0</d2p1:DeletedBy>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsDeleted>false</d2p1:IsDeleted>
              <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
              <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
              <d2p1:Level>0</d2p1:Level>
              <d2p1:SortOrder>0</d2p1:SortOrder>
            </d2p1:Category>
          </d2p1:Children>
          <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
          <d2p1:CreatedBy>0</d2p1:CreatedBy>
          <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
          <d2p1:DeletedBy>0</d2p1:DeletedBy>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsDeleted>false</d2p1:IsDeleted>
          <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
          <d2p1:LastUpdateBy>0</d2p1:LastUpdateBy>
          <d2p1:Level>0</d2p1:Level>
          <d2p1:SortOrder>0</d2p1:SortOrder>
        </d2p1:Category>
      </d2p1:Departments>
      <d2p1:MainAssignees>
        <d2p1:WorkFlowProfile>
          <d2p1:Avatar>String</d2p1:Avatar>
          <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
          <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
          <d2p1:DepartmentId>0</d2p1:DepartmentId>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:FullName>String</d2p1:FullName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Telephone>String</d2p1:Telephone>
        </d2p1:WorkFlowProfile>
      </d2p1:MainAssignees>
      <d2p1:ReferenceDocuments>
        <d2p1:SimpleDocumentRelation>
          <d2p1:DocumentCode>String</d2p1:DocumentCode>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Type>String</d2p1:Type>
        </d2p1:SimpleDocumentRelation>
      </d2p1:ReferenceDocuments>
    </d2p1:WorkflowStepDetail>
  </Data>
  <Message>String</Message>
</GetWorkflowStepResponse>