POST api/Documents/{structureId}/FileSystem/Documents

Get the documents of a subcontract folder structure from FileSystem.

Request Information

URI Parameters

Name	Description	Type	Additional information
structureId		string	None.

Body Parameters

FolderStructurePagedFilter

Name	Type	Additional information
RelativePath	string	None.
ViewDocOnlyInSelectedFolder	boolean	None.
ChildSelectedFolders	Collection of integer	None.
ChildSelectedFoldersString	string	None.
Page	Page	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",
  "page": {
    "number": 1,
    "size": 2,
    "skip": 0
  },
  "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-09T14:02:51.6852761+02:00",
  "endUploadDate": "2026-05-09T14:02:51.6852761+02:00"
}

text/html

Sample:

{"relativePath":"sample string 2","viewDocOnlyInSelectedFolder":true,"childSelectedFolders":[1,2],"childSelectedFoldersString":"1,2","page":{"number":1,"size":2,"skip":0},"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-09T14:02:51.6852761+02:00","endUploadDate":"2026-05-09T14:02:51.6852761+02:00"}

application/xml, text/xml

Sample:

<FolderStructurePagedFilter 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-09T14:02:51.6852761+02:00</EndUploadDate>
  <Extension>sample string 7</Extension>
  <FileName>sample string 4</FileName>
  <FolderName>sample string 3</FolderName>
  <StartUploadDate>2026-05-09T14:02:51.6852761+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>
  <Page xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
    <d2p1:Number>1</d2p1:Number>
    <d2p1:Size>2</d2p1:Size>
  </Page>
  <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>
</FolderStructurePagedFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IPagedListOfDocumentDto

Name	Type	Additional information
Total	integer	None.
Items	Collection of DocumentDto	None.
ItemsTotal	DocumentDto	None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.