When using this method all the filter inputs (of type GetFileInfoArgs) are optional. The They are used to filter the list in the response.
...
Name | Type | Description | Mandatory | Available from version |
---|
BrickIds | Guid[] | An array of file Guids (unique identifier of file in BFS) | | |
|
|
ContentTypes | string[] | An array of content types | | |
|
|
CreatedBy | Guid[] | An array of person Guids who created the file in BFS | | |
|
|
CreatedDateFrom | DateTime? | The date time that the desired files where created from | | |
|
|
CreatedDateTo | DateTime? | The date time that the desired files where created to | | |
|
|
FileContext | Guid[] | The owner of the file | | |
|
|
Name | string | The name of a file | | |
|
|
Permission | FilePermission?[] | Permission on file; FilePermission.AdminOnly / FilePermission.AdminPartner / FilePermission.All | | |
|
|
Response rows (Array of type GetFileInfoResponseRow)
Name | Type | Description | Available from version |
---|
FilePermission | int | Permission on file; FilePermission.AdminOnly / FilePermission.AdminPartner / FilePermission.All |
|
BrickId | Guid | The identifier of the file |
|
CreatedDate | DateTime | Created date |
|
FileContentType | string | The content type | |
|
Name | string | The name of the file |
|
FileContext | Guid | The owner of the file |
|
FileSize | int? | The size of the file |
|
Code examples
Code Block |
---|
language | c# |
---|
theme | RDark |
---|
title | C# - Get File list of a BFS instance |
---|
linenumbers | true |
---|
collapse | true |
---|
|
//example of how to retrieve a filelist from an instance of BFS
var client = new BFSServiceReference.bfsapiSoapClient();
var credentials = new BFSServiceReference.Credentials()
{
UserName = bfsusername, //Username of administrative user in your instance of BFS
Password = bfspassword, //Password of the administrative user in your instance of BFS
};
GetFileListResponse oResp = client.GetFileList(new GetFileListRequest
{
Credentials = credentials,
identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
Args = new GetFileInfoArgs
{
CreatedDateFrom = new DateTime(2015, 1, 1)
},
Fields = new GetFileInfoFields
{
BrickId = true,
CreatedDate = true,
Name = true
}
});
foreach (GetFileInfoResponseRow oResponseRow in oResp.Result)
{
Console.WriteLine(oResponseRow.Name);
}
|
...