tvpl.api

<back to all web services

GetSingleWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/{WorkflowId}/{StepId}
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/ILangGenerator.cs:line 53
   at ServiceStack.Metadata.BaseMetadataHandler.ProcessOperationsAsync(Stream writer, IRequest httpReq, IResponse httpRes) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/Metadata/BaseMetadataHandler.cs:line 207

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/{WorkflowId}/{StepId} HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<GetSingleWorkflowStepResponse 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:AttachedDocuments>
      <d2p1:StepAttached>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSequentialSigning>false</d2p1:IsSequentialSigning>
        <d2p1:OriginalFile>
          <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:Code>0</d2p1:Code>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:StepId>0</d2p1:StepId>
          <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
          <d2p1:UploadedFile>String</d2p1:UploadedFile>
        </d2p1:OriginalFile>
        <d2p1:PendingSignFile>
          <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:Code>0</d2p1:Code>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:StepId>0</d2p1:StepId>
          <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
          <d2p1:UploadedFile>String</d2p1:UploadedFile>
        </d2p1:PendingSignFile>
        <d2p1:SignerConfigs>
          <d2p1:SignerConfigDetail>
            <d2p1:ActionType>0</d2p1:ActionType>
            <d2p1:DepartmentId>0</d2p1:DepartmentId>
            <d2p1:OrderIndex>0</d2p1:OrderIndex>
            <d2p1:SignerRefId>0</d2p1:SignerRefId>
            <d2p1:SignerRefText>String</d2p1:SignerRefText>
            <d2p1:SignerType>0</d2p1:SignerType>
            <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
            <d2p1:CreateAt>0001-01-01T00:00:00</d2p1:CreateAt>
            <d2p1:CreateBy>0</d2p1:CreateBy>
            <d2p1:DocumentId>0</d2p1:DocumentId>
            <d2p1:Id>0</d2p1:Id>
            <d2p1:StepId>0</d2p1:StepId>
            <d2p1:Profile>
              <d2p1:Avatar>String</d2p1:Avatar>
              <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
              <d2p1:Comment>String</d2p1:Comment>
              <d2p1:ConfirmAt>0001-01-01T00:00:00</d2p1:ConfirmAt>
              <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
              <d2p1:ConfirmStatusText>String</d2p1:ConfirmStatusText>
              <d2p1:DepartmentId>0</d2p1:DepartmentId>
              <d2p1:Email>String</d2p1:Email>
              <d2p1:FullName>String</d2p1:FullName>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsSigned>false</d2p1:IsSigned>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:OriginalFileId>0</d2p1:OriginalFileId>
              <d2p1:SignAt>0001-01-01T00:00:00</d2p1:SignAt>
              <d2p1:SignStatusText>String</d2p1:SignStatusText>
              <d2p1:SignedFileId>0</d2p1:SignedFileId>
              <d2p1:SignedFileName>String</d2p1:SignedFileName>
              <d2p1:Telephone>String</d2p1:Telephone>
            </d2p1:Profile>
            <d2p1:Role>
              <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:Name>String</d2p1:Name>
              <d2p1:Permission xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:string>String</d8p1:string>
              </d2p1:Permission>
              <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
              <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
            </d2p1:Role>
          </d2p1:SignerConfigDetail>
        </d2p1:SignerConfigs>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:StepAttached>
    </d2p1:AttachedDocuments>
    <d2p1:AttachedFiles>
      <d2p1:UploadedFiles>
        <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:Code>0</d2p1:Code>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:StepId>0</d2p1:StepId>
        <d2p1:SubDocumentId>0</d2p1:SubDocumentId>
        <d2p1:UploadedFile>String</d2p1:UploadedFile>
      </d2p1:UploadedFiles>
    </d2p1:AttachedFiles>
    <d2p1:CoDepartmentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:CoDepartmentIds>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:DefaultAttachedDocumentId>0</d2p1:DefaultAttachedDocumentId>
    <d2p1:DeletedAt>0001-01-01T00:00:00</d2p1:DeletedAt>
    <d2p1:DeletedBy>0</d2p1:DeletedBy>
    <d2p1:DepartmentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:DepartmentIds>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsRequired>false</d2p1:IsRequired>
    <d2p1:IsUsingForm>false</d2p1:IsUsingForm>
    <d2p1:MainAssigneeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1: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:StatusId>0</d2p1:StatusId>
    <d2p1:StepBasisDocumentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:StepBasisDocumentIds>
    <d2p1:StepName>String</d2p1:StepName>
    <d2p1:StepOrder>0</d2p1:StepOrder>
    <d2p1:SupportingAssigneeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:SupportingAssigneeIds>
    <d2p1:UpdatedAt>0001-01-01T00:00:00</d2p1:UpdatedAt>
    <d2p1:UpdatedBy>0</d2p1:UpdatedBy>
    <d2p1:WorkflowId>0</d2p1:WorkflowId>
    <d2p1:BasisDocuments>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSequentialSigning>false</d2p1:IsSequentialSigning>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:StatusKey>String</d2p1:StatusKey>
        <d2p1:StatusText>String</d2p1:StatusText>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:BasisDocuments>
    <d2p1:CanRead>false</d2p1:CanRead>
    <d2p1:CanUpload>false</d2p1:CanUpload>
    <d2p1:CanWrite>false</d2p1:CanWrite>
    <d2p1:CoDepartments>
      <d2p1:Category>
        <d2p1:ChildList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ChildList>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:IsParty>false</d2p1:IsParty>
        <d2p1:LongName>String</d2p1:LongName>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Type>Department</d2p1:Type>
        <d2p1:Children>
          <d2p1:Category>
            <d2p1:ChildList xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d2p1:ChildList>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:IsParty>false</d2p1:IsParty>
            <d2p1:LongName>String</d2p1:LongName>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Type>Department</d2p1:Type>
            <d2p1:Children>
              <d2p1:Category>
                <d2p1:ChildList xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:int>0</d9p1:int>
                </d2p1:ChildList>
                <d2p1:Description>String</d2p1:Description>
                <d2p1:IsParty>false</d2p1:IsParty>
                <d2p1:LongName>String</d2p1:LongName>
                <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:Key>String</d2p1:Key>
                <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
                <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:Key>String</d2p1:Key>
            <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
            <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:Key>String</d2p1:Key>
        <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
        <d2p1:Level>0</d2p1:Level>
        <d2p1:SortOrder>0</d2p1:SortOrder>
      </d2p1:Category>
    </d2p1:CoDepartments>
    <d2p1:Departments>
      <d2p1:Category>
        <d2p1:ChildList xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </d2p1:ChildList>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:IsParty>false</d2p1:IsParty>
        <d2p1:LongName>String</d2p1:LongName>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Type>Department</d2p1:Type>
        <d2p1:Children>
          <d2p1:Category>
            <d2p1:ChildList xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d2p1:ChildList>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:IsParty>false</d2p1:IsParty>
            <d2p1:LongName>String</d2p1:LongName>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Type>Department</d2p1:Type>
            <d2p1:Children>
              <d2p1:Category>
                <d2p1:ChildList xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:int>0</d9p1:int>
                </d2p1:ChildList>
                <d2p1:Description>String</d2p1:Description>
                <d2p1:IsParty>false</d2p1:IsParty>
                <d2p1:LongName>String</d2p1:LongName>
                <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:Key>String</d2p1:Key>
                <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
                <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:Key>String</d2p1:Key>
            <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
            <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:Key>String</d2p1:Key>
        <d2p1:LastUpdate>0001-01-01T00:00:00</d2p1:LastUpdate>
        <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:Comment>String</d2p1:Comment>
        <d2p1:ConfirmAt>0001-01-01T00:00:00</d2p1:ConfirmAt>
        <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
        <d2p1:ConfirmStatusText>String</d2p1:ConfirmStatusText>
        <d2p1:DepartmentId>0</d2p1:DepartmentId>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:FullName>String</d2p1:FullName>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSigned>false</d2p1:IsSigned>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:OriginalFileId>0</d2p1:OriginalFileId>
        <d2p1:SignAt>0001-01-01T00:00:00</d2p1:SignAt>
        <d2p1:SignStatusText>String</d2p1:SignStatusText>
        <d2p1:SignedFileId>0</d2p1:SignedFileId>
        <d2p1:SignedFileName>String</d2p1:SignedFileName>
        <d2p1:Telephone>String</d2p1:Telephone>
      </d2p1:WorkFlowProfile>
    </d2p1:MainAssignees>
    <d2p1:ReasonReturn>String</d2p1:ReasonReturn>
    <d2p1:ReferenceDocuments>
      <d2p1:SimpleDocumentRelation>
        <d2p1:DocumentCode>String</d2p1:DocumentCode>
        <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSequentialSigning>false</d2p1:IsSequentialSigning>
        <d2p1:PublicationDate>0001-01-01T00:00:00</d2p1:PublicationDate>
        <d2p1:StatusKey>String</d2p1:StatusKey>
        <d2p1:StatusText>String</d2p1:StatusText>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:Type>String</d2p1:Type>
      </d2p1:SimpleDocumentRelation>
    </d2p1:ReferenceDocuments>
    <d2p1:ReturnDate>0001-01-01T00:00:00</d2p1:ReturnDate>
    <d2p1:StatusKey>String</d2p1:StatusKey>
    <d2p1:StatusText>String</d2p1:StatusText>
    <d2p1:SupportingAssignees>
      <d2p1:WorkFlowProfile>
        <d2p1:Avatar>String</d2p1:Avatar>
        <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
        <d2p1:Comment>String</d2p1:Comment>
        <d2p1:ConfirmAt>0001-01-01T00:00:00</d2p1:ConfirmAt>
        <d2p1:ConfirmStatus>0</d2p1:ConfirmStatus>
        <d2p1:ConfirmStatusText>String</d2p1:ConfirmStatusText>
        <d2p1:DepartmentId>0</d2p1:DepartmentId>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:FullName>String</d2p1:FullName>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:IsSigned>false</d2p1:IsSigned>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:OriginalFileId>0</d2p1:OriginalFileId>
        <d2p1:SignAt>0001-01-01T00:00:00</d2p1:SignAt>
        <d2p1:SignStatusText>String</d2p1:SignStatusText>
        <d2p1:SignedFileId>0</d2p1:SignedFileId>
        <d2p1:SignedFileName>String</d2p1:SignedFileName>
        <d2p1:Telephone>String</d2p1:Telephone>
      </d2p1:WorkFlowProfile>
    </d2p1:SupportingAssignees>
  </Data>
  <Message>String</Message>
</GetSingleWorkflowStepResponse>