Planfix API file.getListForTask

From Planfix
Jump to: navigation, search

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForTask">
Name Type Value Note 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">
      <!-- ... -->
    <!-- ... -->
Name Type Value Note
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 int task identifier
task.title string task name
project within which project the file was uploaded int project identifier
project.title string project name
user user who uploaded the file int user identifier 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">

Go To