Update file metadata 

Update the Atom document representation of the metadata for a file from your library.

This method replaces the content of the elements in the Atom document with the values you specify in the Atom document you provide as input. This resource updates the metadata of the file; if you want to update the file itself, see Update a file or Update a file using a multipart post.

You must authenticate this request.

Table 1. Atom API request details

Method URI Output representation Description
PUT You can determine the URI in either of the following ways:

  • Value of the href attribute of the <link rel="edit"> element in the file's Document Atom entries.

  • Construct the URI using the following syntax: /basic/api/myuserlibrary/document/{document-id}/entry

Note: Atom elements take precedence over HTTP parameters.

file Atom document Updates the Atom document containing the metadata of a file from your library.


Note: {document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document. If you identify the document using the value of the <td:label>, then include the identifier=label parameter with the request.

You can use the following header.

Table 2. Input header

Parameter Description
X-Method-Override Tunnels a PUT request over the HTTP POST request.

Table 3. Input parameters

Parameter Description
propagate Indicates if users that are shared with can share this document. The default value is true.
sendEmail Indicates if an email notification is sent when sharing with the specified user. The default value is true.


Input

An Atom entry document containing the updated Atom document for the file. The content type must be specified as application/atom+xml.


Output

An updated Atom entry document.

Returned HTTP headers

HTTP/1.1 200 OK

Error codes


Parent topic

Work with files

Related reference
File content


   

 

});

+

Search Tips   |   Advanced Search