Planfix API file.getListForTask

Function for getting a list of files for a task. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForTask">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <general></general>
  </task>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <returnDownloadLinks></returnDownloadLinks>
  <sort></sort>
  <signature></signature>
</request>

Name	Type	Value	Note
task.id	int	task identifier
task.general	int	task number
pageCurrent	int	current page	numbering from 1. 0 - used to get the amount
pageSize	int	requested page size
sort	enum	sort type	list of valid values see in the file sorting types section
returnDownloadLinks	bool	whether to return permanent download links in the response	default value 0
signature	string(32)	signature

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files count="count" totalCount="totalCount">
    <file>
    <id></id>
    <uniqueId></uniqueId>
      <name></name>
      <version></version>
      <description></description>
      <date></date>
      <sourceType></sourceType>
      <size></size>
      <task>
        <id></id>
        <title></title>
      </task>
      <project>
        <id></id>
        <title></title>
      </project>
      <user>
        <id></id>
        <name></name>
      </user>
      <downloadLink></downloadLink>
    </file>
    <file>
      <!-- ... -->
    </file>
    <!-- ... -->
  </files>
</response>

Name	Type	Value	Note
files
files count	int	number of files returned by the request
files totalCount	int	number of files satisfying the request
file		node describing the file
id	int	file identifier	common for all versions of one file
uniqueId	int	unique file identifier
name	string	file name
version	int	version
description	string	description
date	DateTime	file upload date
sourceType	enum	file types	list of valid values see in file types
size	int	size in kilobytes
task		within which task was uploaded
task.id	int	task identifier
task.title	string	task name
project		within which project the file was uploaded
project.id	int	project identifier
project.title	string	project name
user		user who uploaded the file
user.id	int	user identifier
user.name	string	user name
downloadLink	string	download link for the file

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API:Working with files
• Error codes
• List of functions