Updating file metadata

Home

Updating file metadata

Update the Atom document representation of the metadata for a file from your collection.
This method replaces the content of the elements in the Atom document with the values you pass as parameters. The rest of the elements are unchanged. This resource updates the metadata of the file; if you want to update the file itself, see Updating a file or Updating a file using a multipart post.
You must authenticate this request.

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

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

{document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document.
You can use one or more of these input parameters with the request. Separate multiple parameters with an ampersand (&).

Input parameters

Parameter Description
commentNotification String. Specifies whether you want to get an e-mail notification when someone adds or updates a comment on a file. Options are on or off.
created Date to use as the creation date of the file. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time. This value can be set by the user, and defaults to the current system time on the server.
identifier Indicates how the document is identified in the {document-id} variable segment of the Web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a File Atom entry. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
includePath Specifies whether to include the file path information. This parameter takes a boolean value of either true or false. If true, adds an entry extension <td:path> showing the path to the object.
mediaNotification String. Specifies whether the person updating the file wants to get an e-mail notification when someone subsequently updates the file. Options are on or off.
modified Date to use as the last modified date of the file. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time. This value can be set by the user, and defaults to the current system time on the server.
recommendation Specifies whether the person updating the document recommends the document. This parameter takes a boolean value of either true or false. Defaults to false.
removeTag Removes the specified tag. Use it multiple times to remove multiple tags or set it equal to null to remove all tags.
sendNotification Specified whether notifications should be sent about this update. This parameter takes a boolean value of either true or false.
sharePermission Defines the level of permission that the people listed in the sharedWith parameter should have to the file. Only applicable if the sharedWith parameter is passed. Permission level options are Edit or View.
shareSummary Text. Explanation of the share.
shareWith User ID of the user to share the content with. This parameter can be applied multiple times. Supports multivalue.
tag String. Keyword that helps to classify the file. This parameter can be applied multiple times if multiple tags are passed. Supports multivalue. If this parameter and the removeTag parameter pass the same value, the removeTag parameter gets precedence.
visibility String. Specifies who can see the file. Options are private or public. A public file is visible to all users and can be shared by all users. Defaults to private.

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

Indicates that the file entry was successfully updated. If an error occurs, this header will contain one of the error codes below.

Error codes

HTTP/1.1 401 Unauthorized
HTTP/1.1 404 Not Found

Working with files

Related reference

File content

+
Search Tips | Advanced Search

Parameter	Description
commentNotification	String. Specifies whether you want to get an e-mail notification when someone adds or updates a comment on a file. Options are on or off.
created	Date to use as the creation date of the file. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time. This value can be set by the user, and defaults to the current system time on the server.
identifier	Indicates how the document is identified in the {document-id} variable segment of the Web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a File Atom entry. Specify "label" if the URL instead contains the value from the <td:label> element of a File Atom entry.
includePath	Specifies whether to include the file path information. This parameter takes a boolean value of either true or false. If true, adds an entry extension <td:path> showing the path to the object.
mediaNotification	String. Specifies whether the person updating the file wants to get an e-mail notification when someone subsequently updates the file. Options are on or off.
modified	Date to use as the last modified date of the file. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time. This value can be set by the user, and defaults to the current system time on the server.
recommendation	Specifies whether the person updating the document recommends the document. This parameter takes a boolean value of either true or false. Defaults to false.
removeTag	Removes the specified tag. Use it multiple times to remove multiple tags or set it equal to null to remove all tags.
sendNotification	Specified whether notifications should be sent about this update. This parameter takes a boolean value of either true or false.
sharePermission	Defines the level of permission that the people listed in the sharedWith parameter should have to the file. Only applicable if the sharedWith parameter is passed. Permission level options are Edit or View.
shareSummary	Text. Explanation of the share.
shareWith	User ID of the user to share the content with. This parameter can be applied multiple times. Supports multivalue.
tag	String. Keyword that helps to classify the file. This parameter can be applied multiple times if multiple tags are passed. Supports multivalue. If this parameter and the removeTag parameter pass the same value, the removeTag parameter gets precedence.
visibility	String. Specifies who can see the file. Options are private or public. A public file is visible to all users and can be shared by all users. Defaults to private.