Planfix API handbook.updateRecord

From Planfix
Jump to: navigation, search

Modifying a directory entry. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="handbook.updateRecord">
    <!-- ... -->
Name Type Value Note
sid string(32) session key issued as a result of authentication completion int directory identifier
key int entry identifier in the list of directory entries, it is in the ID column
parentKey int entry group identifier optional parameter
isGroup bool is the entry a group
name string name, if the entry is a group
archived bool is the entry archived
customData field values field identifier
customData.customValue.value field value (for fields of type task set, employee list, directory entry set - identifiers separated by commas in square brackets)
files root element containing the list of saved files For the Files field type
file saved file string name of the saved file
file.sourceType enum source type see the list of available values in file source types, available values FILESYSTEM and INTERNET
file.otherFile Use an already existing file used when sourceType: INTERNET
file.otherFile.url string URL of the file on the Internet used only when sourceType=INTERNET
file.body string file body encoded in base64 used when sourceType=FILESYSTEM
file.description string brief description of file contents optional parameter
file.newversion boolean if the value is "1", when the file name matches a previously uploaded one, no error is issued, but the file is uploaded as a new version of the existing one optional parameter

Response when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
Name Type Value Note
key int record identifier

Otherwise, a response with an error will be returned:

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


Working with a file type field customValue.value - contains a list of identifiers of files previously attached, separated by commas. All previously attached files, the identifiers of which will be missing - will be deleted.

Go To