Add a file to your library programmatically.
See Authenticating requests
for information about how to authenticate the request.
Table 1. Atom API request details
|Method||Resource address||Input representation||Description|
|POST||/basic/api/myuserlibrary/feed||binary media||Adds a file to your library.|
You can use one or more of these headers.
Table 2. Input headers
|Content-Type||No||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||No||Specifies the language of the content being sent to the server. All contents are handled using UTF-8 encoding on the server. |
|Content-Length||No||Specifies the content length when sending media content. |
|Slug||Yes||Contains the file path and label of the resource to be added to the collection. You can include non-ASCII characters in this header, but they must be properly encoded according to the RFC 2047. |
You can use one or more of these input parameters. Separate multiple parameters with an ampersand (&).
Table 3. Input parameters
|commentNotification||String. Specifies whether you want to get a notification when someone adds or updates a comment on a file. Options are on or off. The default value is on.|
|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. |
|includePath||Boolean. Specifies whether you want to show the file path to the file. if true , adds an entry extension <td:path> element that specifies the file path to the object. Options are true or false.|
|mediaNotification||String. Specifies whether the person updating the file wants to get a notification when someone subsequently updates the file. Options are on or off. The default value is 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. |
|propagate||Indicates if users that are shared with can share this document. The default value is false.|
|sharePermission||Defines the level of permission that the people listed in the sharedWith parameter have to the file. Only applicable if the sharedWith parameter is passed. Permission level options are Edit or View. The default value is 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.|
|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. The default value is private.|
A file consists of both the information about the file, which is also known as metadata
, and the binary data that the file contains. You can provide either of the following inputs:
- Binary data and no Atom entry document to define the metadata. Metadata is created automatically and sets all values to the default values, except for the value of the title element, which it takes from the SLUG header.
- Atom entry document that defines the metadata of the file and no binary data.
An Atom entry document representing the new file.
Returned HTTP headers
HTTP/1.1 201 Created
Indicates that the file entry was successfully created. If an error occurs, this header contains one of the error codes.Error codes
Parent topic: Working with files
- HTTP/1.1 401 Unauthorized
- HTTP/1.1 403 Forbidden
- HTTP/1.1 404 Not Found
- HTTP/1.1 409 Conflict
- HTTP/1.1 415 Unsupported media type