POST api/ApprovalFlow/Sendtoapproval

Launch an approval flow for a given configuration parameters

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApprovalFlowTemplateId	integer	None.
ApprovalFlowEntityId	BusinessEntityTypeId	None.
EntityId	integer	None.
EntityVersionId	integer	None.
Steps	Collection of ApprovalFlowSendStepsDto	None.
ProjectId	integer	None.
SubcontractId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "approvalFlowTemplateId": 1,
  "approvalFlowEntityId": 1,
  "entityId": 2,
  "entityVersionId": 1,
  "steps": [
    {
      "stepNumber": 1,
      "execUserId": 2
    },
    {
      "stepNumber": 1,
      "execUserId": 2
    }
  ],
  "projectId": 3,
  "subcontractId": 1
}

text/html

Sample:

{"approvalFlowTemplateId":1,"approvalFlowEntityId":1,"entityId":2,"entityVersionId":1,"steps":[{"stepNumber":1,"execUserId":2},{"stepNumber":1,"execUserId":2}],"projectId":3,"subcontractId":1}

application/xml, text/xml

Sample:

<ApprovalFlowSendDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.ApprovalFlowAgg">
  <ApprovalFlowEntityId>Subcontract</ApprovalFlowEntityId>
  <ApprovalFlowTemplateId>1</ApprovalFlowTemplateId>
  <EntityId>2</EntityId>
  <EntityVersionId>1</EntityVersionId>
  <ProjectId>3</ProjectId>
  <Steps>
    <ApprovalFlowSendStepsDto>
      <ExecUserId>2</ExecUserId>
      <StepNumber>1</StepNumber>
    </ApprovalFlowSendStepsDto>
    <ApprovalFlowSendStepsDto>
      <ExecUserId>2</ExecUserId>
      <StepNumber>1</StepNumber>
    </ApprovalFlowSendStepsDto>
  </Steps>
  <SubcontractId>1</SubcontractId>
</ApprovalFlowSendDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfBoolean

Name	Type	Additional information
Data	boolean	None.
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.