tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStep:
    id: int = 0
    # @References(typeof(Document))
    workflow_id: int = 0

    step_order: Optional[int] = None
    # @Required()
    # @StringLength(255)
    step_name: Optional[str] = None

    # @Required()
    is_required: bool = False

    sla_legal_value: Optional[int] = None
    sla_legal_is_by_day: Optional[bool] = None
    sla_internal_value: Optional[int] = None
    sla_internal_is_by_day: Optional[bool] = None
    require_attachment: bool = False
    # @Required()
    description: Optional[str] = None

    created_by: int = 0
    # @Ignore()
    department_ids: Optional[List[int]] = None

    # @Ignore()
    step_basis_document_ids: Optional[List[int]] = None

    # @Ignore()
    step_attached_ids: Optional[List[int]] = None

    # @Ignore()
    main_assignee_ids: Optional[List[int]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowStepResponse(IResponseRequest):
    code: int = 0
    message: Optional[str] = None
    inserted_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicUploadedFile:
    file_name: Optional[str] = None
    filekey: Optional[str] = None
    file_url: Optional[str] = None
    checksum: Optional[str] = None
    e_tag: Optional[str] = None
    file_size: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadedFiles(BasicUploadedFile):
    id: Optional[int] = None
    uploaded_file: Optional[str] = None
    sub_document_id: Optional[int] = None
    step_id: Optional[int] = None
    code: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateWorkflowStepRequest(WorkflowStep):
    step_attach_files: Optional[List[UploadedFiles]] = None

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