Planfix API file.get

From Planfix
Jump to: navigation, search

Function for obtaining information about a file. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.get">
Name Type Value Note int file identifier
file.uniqueId int unique file identifier ignored if id parameter is set
returnDownloadLinks bool whether to return permanent download links in the response default value is 0
signature string(32) signature

Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
Name Type Value Note
id int file identifier
uniqueId int uniqu
name string file name
version int version
description string description
date DateTime file upload date
sourceType enum file types see the list of permissible values in file types
size int size in kilobytes
task task under which it was uploaded int task identifier
task.title string task name
project project under which 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