POST api/Documents/{structureId}/FolderStructure/Documents/Export

Get export the documents of a subcontract folder structure from DB application

Request Information

URI Parameters

Name	Description	Type	Additional information
structureId		integer	Required

Body Parameters

FolderStructureOrderedFilter

Name	Type	Additional information
RelativePath	string	None.
ViewDocOnlyInSelectedFolder	boolean	None.
ChildSelectedFolders	Collection of integer	None.
ChildSelectedFoldersString	string	None.
SortedColumns	Collection of Order	None.
FolderName	string	None.
FileName	string	None.
Description	string	None.
Tag	string	None.
Extension	string	None.
StartUploadDate	date	None.
EndUploadDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "relativePath": "sample string 2",
  "viewDocOnlyInSelectedFolder": true,
  "childSelectedFolders": [
    1,
    2
  ],
  "childSelectedFoldersString": "1,2",
  "sortedColumns": [
    {
      "name": "sample string 1",
      "descending": true
    },
    {
      "name": "sample string 1",
      "descending": true
    }
  ],
  "folderName": "sample string 3",
  "fileName": "sample string 4",
  "description": "sample string 5",
  "tag": "sample string 6",
  "extension": "sample string 7",
  "startUploadDate": "2026-05-08T21:23:50.5404959+02:00",
  "endUploadDate": "2026-05-08T21:23:50.5404959+02:00"
}

text/html

Sample:

{"relativePath":"sample string 2","viewDocOnlyInSelectedFolder":true,"childSelectedFolders":[1,2],"childSelectedFoldersString":"1,2","sortedColumns":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}],"folderName":"sample string 3","fileName":"sample string 4","description":"sample string 5","tag":"sample string 6","extension":"sample string 7","startUploadDate":"2026-05-08T21:23:50.5404959+02:00","endUploadDate":"2026-05-08T21:23:50.5404959+02:00"}

application/xml, text/xml

Sample:

<FolderStructureOrderedFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.StructureAgg">
  <Description>sample string 5</Description>
  <EndUploadDate>2026-05-08T21:23:50.5404959+02:00</EndUploadDate>
  <Extension>sample string 7</Extension>
  <FileName>sample string 4</FileName>
  <FolderName>sample string 3</FolderName>
  <StartUploadDate>2026-05-08T21:23:50.5404959+02:00</StartUploadDate>
  <Tag>sample string 6</Tag>
  <ChildSelectedFolders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ChildSelectedFolders>
  <RelativePath>sample string 2</RelativePath>
  <SortedColumns xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <d2p1:Order>
      <d2p1:Descending>true</d2p1:Descending>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:Order>
    <d2p1:Order>
      <d2p1:Descending>true</d2p1:Descending>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:Order>
  </SortedColumns>
  <ViewDocOnlyInSelectedFolder>true</ViewDocOnlyInSelectedFolder>
</FolderStructureOrderedFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.