GET api/organizations/current/files?query={query}&pageIndex={pageIndex}&pageSize={pageSize}

Gets a file collection corresponding to the specified search query, pageIndex and pageSize.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
query

The search query.

string

Required

pageIndex

A number specifying the number times of files to skip.

integer

Required

pageSize

The number of files to take.

integer

Required



Body Parameters

None.



Response Information

Resource Description

The requested file collection.

Collection of ReadFileViewModel

NameDescriptionTypeAdditional information
CreationDate

decimal number

None.

FullPath

string

None.

Name

string

None.

RelatedEntityInstanceDefiningString

string

None.

RelatedEntityInstanceId

integer

None.

SizeInBytes

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CreationDate": 1.1,
    "FullPath": "sample string 2",
    "Name": "sample string 3",
    "RelatedEntityInstanceDefiningString": "sample string 4",
    "RelatedEntityInstanceId": 5,
    "SizeInBytes": 6
  },
  {
    "CreationDate": 1.1,
    "FullPath": "sample string 2",
    "Name": "sample string 3",
    "RelatedEntityInstanceDefiningString": "sample string 4",
    "RelatedEntityInstanceId": 5,
    "SizeInBytes": 6
  }
]

application/xml, text/xml

Sample:
<ArrayOfReadFileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <ReadFileViewModel>
    <CreationDate>1.1</CreationDate>
    <FullPath>sample string 2</FullPath>
    <Name>sample string 3</Name>
    <RelatedEntityInstanceDefiningString>sample string 4</RelatedEntityInstanceDefiningString>
    <RelatedEntityInstanceId>5</RelatedEntityInstanceId>
    <SizeInBytes>6</SizeInBytes>
  </ReadFileViewModel>
  <ReadFileViewModel>
    <CreationDate>1.1</CreationDate>
    <FullPath>sample string 2</FullPath>
    <Name>sample string 3</Name>
    <RelatedEntityInstanceDefiningString>sample string 4</RelatedEntityInstanceDefiningString>
    <RelatedEntityInstanceId>5</RelatedEntityInstanceId>
    <SizeInBytes>6</SizeInBytes>
  </ReadFileViewModel>
</ArrayOfReadFileViewModel>