Planfix API file.getHistory: Difference between revisions
From Planfix
(Created page with "Function for obtaining the history of file changes. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="file.getHistory"> <account></account> <sid></sid> <file> <id></id> </file> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note |- |file.id ||int ||file identifier|| |- |signature ||string(32) ||signa...") |
No edit summary |
||
Line 88: | Line 88: | ||
|project.id || int||project identifier || | |project.id || int||project identifier || | ||
|- | |- | ||
|project.title || string|| | |project.title || string||project name || | ||
|- | |- | ||
|user || ||user who uploaded the file || | |user || ||user who uploaded the file || |
Latest revision as of 09:17, 13 March 2024
Function for obtaining the history of file changes. Request format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getHistory">
<account></account>
<sid></sid>
<file>
<id></id>
</file>
<signature></signature>
</request>
Name | Type | Value | Note |
---|---|---|---|
file.id | int | file identifier | |
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>
<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>
</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 | |
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 bytes | |
task | within which task it 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 |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>