REST API: Working with files: Difference between revisions
From Planfix
(Created page with "{{#seo: |title=REST API: Working with files |titlemode=append |keywords=planfix, api, rest, rest api, files, working with files, api working with files |description=REST API: Working with files }} The REST API of Planfix supports working with files *Attach and update *Get list of files == Attach and update == You can use the API to attach or update files that you have previously uploaded: *Tasks *#Contact...") |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
The [[REST API]] of Planfix supports working with files | The [[REST API]] of Planfix supports working with files | ||
*[[#Attach and update |Attach and update]] | *[[#Attach and update |Attach and update]] | ||
*[[#Get list of files |Get list of files]] | *[[#Get a list of files |Get list of files]] | ||
== Attach and update == | == Attach and update == | ||
| Line 35: | Line 35: | ||
*Attach files to the description when creating a contact: | *Attach files to the description when creating a contact: | ||
https:// | https://s.pfx.so/pf/48/zRF6IB.png | ||
*Update files in the contact description: | *Update files in the contact description: | ||
| Line 61: | Line 61: | ||
*If the files field is not transferred, the files are not updated. | *If the files field is not transferred, the files are not updated. | ||
== | == Get a list of files == | ||
You can | You can obtain a list of files via API: | ||
*[[#Task|Task]] | *[[#Task|Task]] | ||
*[[#Contact|Contact]] | *[[#Contact|Contact]] | ||
| Line 84: | Line 84: | ||
== Go to == | == Go to == | ||
*[REST API]] | *[[REST API]] | ||
*[[API]] | *[[API]] | ||
Latest revision as of 09:57, 27 March 2024
The REST API of Planfix supports working with files
Attach and update
You can use the API to attach or update files that you have previously uploaded:
Task
- Files are only attached or updated in the task description.
- Attach files to the description when creating a task:
- Update files in the task description:
Important:
- Files are replaced with those passed in the files parameter.
- If an empty field is passed, files are detached from the task and deleted if not used elsewhere.
- If the files field is not passed, files are not updated.
Contact
- Files are only attached or updated in the contact description.
- Attach files to the description when creating a contact:
- Update files in the contact description:
Important:
- Files are replaced with those passed in the files parameter.
- If an empty field is passed, files are detached from the contact and deleted if not used elsewhere.
- If the files field is not passed, files are not updated.
Project
- Files are only attached or updated in project documents.
- Attach files during project creation:
- Update files in the project:
Important:
- Files are replaced with those passed in the files parameter.
- If an empty field is passed, the files are removed from the project and deleted if not used elsewhere.
- If the files field is not transferred, the files are not updated.
Get a list of files
You can obtain a list of files via API:
Task
The method has a parameter onlyFromDescription, which allows you to retrieve files only from the task description:
Contact
The method has an onlyFromDescription parameter, which you can use to retrieve files from the contact description only:
Project
The method has the parameters pageSize and offset for page navigation through the list:
