3.1.5.3.13 get manifest
Used by the client to obtain a manifest, an XML document containing a copy of all or some of the information that specifies the site other than the contents of the documents on the site. A manifest contains information such as the names, locations, and metadata for the service, folders, and documents; the web structure; and the list schemas and data. It MAY also recursively include subsites.<31>
If a manifest is created with every option set, then taken in combination with a copy of the documents obtained using the get documents method, this forms a backup of the site.
A manifest created with only some options set can also be used by the client to create a template for new sites that use the same structure and settings. Detailed information within the manifest below the level of sites, documents, and folders is opaque to the client.
Parameters
options: A STRING (section 2.2.2.1.5) that contains the options that specify what to include in the manifest to be returned, as a comma-separated list of values. A manifest returned by the server MAY contain all or only certain types of information about the site, which the client specifies by using the options parameter.
The following option values are allowed.
|
Value |
Meaning |
|---|---|
|
everything |
A shortcut for turning on every option. This requests a complete backup of the site in the manifest. |
|
subwebs |
Include subsites in the manifest. |
|
structure |
Include the web navigation structure in the manifest. |
|
files |
Include the names and metadata of the documents and folders in the manifest. |
|
file_history |
This option MUST be ignored by the server. |
|
userlists |
Include Lists and View schemas in the manifest. |
|
list_data |
Include the data associated with the included lists. |
|
nontemplatizable_data |
Include data that is not required to create a Site template from the included lists. |
|
globallists |
Include common userinfo with subscriptions and discussions data. |
|
subscriptions |
Include subscriptions information in the manifest. |
|
discussions |
Include web discussions information in the manifest. |
|
userinfo |
Include userinfo in the manifest, along with subscriptions or discussions. |
|
webparts |
Include the Web Parts information in the manifest. |
|
security |
This option MUST be ignored by the server. |
Certain options are allowed only in combination with other options. The globallists and userinfo options MUST be included to use the subscriptions and discussions options. The userlists option MUST be included to use the list_data and nontemplatizable_data options.
Entry Point
FPAdminScriptUrl
Return Values
message: For semantics, see message in section 3.1.5.3.1.
subwebs: A VECTOR-URL-DIRECTORY (section 2.2.2.2.16) that contains a list of the subsites in the current site. If the options parameter in the request included "subwebs", either explicitly or as part of the everything option, and the site has subsites, the server MUST include this list in the return value. Otherwise the server MUST exclude this from the return value.
document: The manifest XML file returned as the document stream that is sent after the </HTML> tag at the end of the standard response. The server MUST generate and return a manifest document for the site with the specified options to the client.