POST api/ApprovalFlow/RegisterExternalApproval

Execute an action for an approval flow with attached files

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApprovalFlowActionTypeId	ApprovalFlowActionTypeId	None.
ApprovalFlowEntityId	BusinessEntityTypeId	None.
EntityId	integer	None.
EntityVersionId	integer	None.
Comment	string	None.
ProjectId	integer	None.
SubcontractId	integer	None.
RegistrationUserId	integer	None.
Files	Collection of DocumentBasicInfoDto	None.
ApprovalDate	date	Required
IsRequiredDocumentation	boolean	None.
UpdateEntityStatus	boolean	None.
AutomaticallySendToSap	boolean	None.
SfrCommunicated	boolean	None.
FewoCommunicated	boolean	None.
SiteInstructionCommunicated	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "approvalFlowActionTypeId": 1,
  "approvalFlowEntityId": 1,
  "entityId": 1,
  "entityVersionId": 1,
  "comment": "sample string 2",
  "projectId": 3,
  "subcontractId": 1,
  "registrationUserId": 4,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "approvalDate": "2026-05-08T17:18:54.8666303+02:00",
  "isRequiredDocumentation": true,
  "updateEntityStatus": true,
  "automaticallySendToSap": true,
  "sfrCommunicated": true,
  "fewoCommunicated": true,
  "siteInstructionCommunicated": true
}

text/html

Sample:

{"approvalFlowActionTypeId":1,"approvalFlowEntityId":1,"entityId":1,"entityVersionId":1,"comment":"sample string 2","projectId":3,"subcontractId":1,"registrationUserId":4,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"approvalDate":"2026-05-08T17:18:54.8666303+02:00","isRequiredDocumentation":true,"updateEntityStatus":true,"automaticallySendToSap":true,"sfrCommunicated":true,"fewoCommunicated":true,"siteInstructionCommunicated":true}

application/xml, text/xml

Sample:

<ApprovalFlowExternalRegistrationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.ApprovalFlowAgg">
  <ApprovalDate>2026-05-08T17:18:54.8666303+02:00</ApprovalDate>
  <ApprovalFlowActionTypeId>Approve</ApprovalFlowActionTypeId>
  <ApprovalFlowEntityId>Subcontract</ApprovalFlowEntityId>
  <AutomaticallySendToSap>true</AutomaticallySendToSap>
  <Comment>sample string 2</Comment>
  <EntityId>1</EntityId>
  <EntityVersionId>1</EntityVersionId>
  <FewoCommunicated>true</FewoCommunicated>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
  </Files>
  <IsRequiredDocumentation>true</IsRequiredDocumentation>
  <ProjectId>3</ProjectId>
  <RegistrationUserId>4</RegistrationUserId>
  <SfrCommunicated>true</SfrCommunicated>
  <SiteInstructionCommunicated>true</SiteInstructionCommunicated>
  <SubcontractId>1</SubcontractId>
  <UpdateEntityStatus>true</UpdateEntityStatus>
</ApprovalFlowExternalRegistrationDto>

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.