3.1.5.3.25 put document

The put document request is used by the client to write a single document to a specified service-relative URL in an existing site.

Parameters

service_name: This parameter is deprecated. For semantics, see service_name in section 3.1.5.3.1.

document: A DOCINFO (section 2.2.2.2.12) that specifies the service-relative URL and metadata of the document to write to the site. The client MUST send this parameter.

put_option: A set of PUT-OPTION-VAL flags that describe how the operation behaves; see Put-Option (section 2.2.2.2.18) for specific semantics for the options.

comment: A STRING (section 2.2.2.1.5) that provides a checkin comment for the file being uploaded.

keep_checked_out: A BOOLEAN (section 2.2.2.1.3) value that SHOULD determine a specified document's behavior in source control. If TRUE, the document SHOULD be checked in to source control and immediately checked back out; if FALSE, the document SHOULD be checked in. The server MUST treat this as equivalent to the "checkout" PUT-OPTION-VAL, as specified in section 2.2.2.2.18.

validateWelcomeNames: For semantics, see validateWelcomeNames in section 3.1.5.3.1.

Entry Point

FPAuthorScriptUrl

Return Values

message: For semantics, see message in section 3.1.5.3.1.

document: A DOCINFO that contains the name and metadata of the document as it was saved. Although this return value is called "document", it does not contain the document stream. The server updates the metadata when the document is saved. The server MUST return the updated metadata.