Community articleUpdating a file
Added by IBM contributorIBM on March 25, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Update a file in your file collection programmatically.



Update a file in your file collection programmatically.

See Authenticating requests for information about how to authenticate the request.


You can use one or more of these headers.

You can use one or more of these input parameters with the request. Separate multiple parameters with an ampersand (&).

Input

A file consists of both the information about the file, which is also known as metadata, and the binary data that the file contains. Pass binary data as the input of the request. To update the metadata associated with the file, pass new values for the document elements using input parameters.

Output

An Atom document representing the updated file.

Input
Method URI Description
PUT /files/basic/api/myuserlibrary/document/{document-id}/media Determine the resource address in either of the following ways:
Value of the href attribute of the <link rel="edit-media"> element in the file's Document Atom entries.
Construct the address using the following URL:/files/basic/api/myuserlibrary/document/{document-id}/mediawhere {document-id} is the <td:uuid> or <td:label> element of the document entry.
Name Type Optional Description
document-id
string No {document-id} is the <td:uuid> or <td:label> element of the document entry.
Name Type Optional Description
commentNotification
enumerated Yes String. Specifies whether you want to get an email notification when someone adds or updates a comment on a file. Options are on or off.
Authorized values:
  • on
  • off
created
string Yes 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
string Yes 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
boolean Yes 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
enumerated Yes String. Specifies whether the person updating the file wants to get an email notification when someone subsequently updates the file. Options are on or off.
Authorized values:
  • on
  • off
modified
string Yes 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
enumerated Yes Specifies whether the person updating the document recommends the document. This parameter takes a Boolean value of either on or off. The default is off.
Authorized values:
  • on
  • off
removeTag
string Yes Removes the specified tag. Use it multiple times to remove multiple tags or set it equal to null to remove all tags.
sendNotification
boolean Yes Specified whether notifications should be sent about this update. This parameter takes a Boolean value of either true or false.
sharePermission
enumerated Yes 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.
Authorized values:
  • Edit
  • View
shareSummary
string Yes Text. Explanation of the share.
shareWith
string Yes User ID of the user to share the content with. This parameter can be applied multiple times. Supports multivalue.
tag
string Yes 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
enumerated Yes 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.
Authorized values:
  • private
  • public
Name Type Optional Description
Content-Type
string Yes Used to specify the mime type for the content being sent to the server. If the collection does not support the specified content type, the server returns HTTP response code 415 (Unsupported media type). When a media resource is posted, the mime-type of the resource is set to this value if it is provided. Otherwise, the mime-type of the extension of the Slug header is used. A Content-Type that is an empty string, whitespace only, or equal to "unknown/unknown" is considered to be not-specified.
Content-Language
string Yes Specifies the language of the content being sent to the server. All contents are handled using UTF-8 encoding on the server.
Content-Length
string Yes Specifies the content length when sending media content.
X-Update-Nonce
string Yes String. Represents a unique data string generated by the server upon request that you can provide to secure the request. See Getting a nonce key for information about how to request the data string.
Output
Content Type: application/atom+xml
Code Description
200
Indicates that the file entry was successfully created. If an error occurs, this header contains one of the error codes.
401
Unauthorized.
403
Forbidden.
404
Not Found.
References
Examples
PUT /files/basic/api/myuserlibrary/document/ced0378d-4dda-427c-bdf6-e71e56863bca/entry?tag=addTagTest