Web service API

How to use PageSeeder's Web service API

export group resources

/groups/{group}/resources/export [GET]

com.pageseeder.developer.ExportProjectFiles

Description

Export all the files in the project

Exports the files for a kit.

All files are exported in a zip which can be imported into another PageSeeder project or server.

The ZIP file will contain all the resources (except the history of changes and other hidden files) in a non-project specific manner so that they can be imported easily in any project.

The filename is usually: "ps[project]-[isodate].zip"

Parameters

NameDescriptionRequiredTypeDefault value
perspectiveThe name of an existing perspective to exportnostringstandard

 

Permission

Undocumented permissions requirements.

Response

When the group is valid, the XML is designed to indicate the HTTP client what:

<export project="[owner directory]"
        perspective="[perspective]"
        datetime="[datetime]"
        file="[filename]"/>

If I put a group invalid, return:

<error id="0101">
    <request>/ps/service/groups/erro/resources/export</request>
    <message>Access forbidden</message>
</error>

The default value of the perspective is "standard".  When I put a value to the  perspective = test,  for example, the return XML is:

<export project="original"
        perspective="test" 
        datetime="2017-02-23T09:57:36+11:00" 
        file="ps-original.test-2017-02-23.zip"/>

Error handling

CodeCause / Description
0x0101Access forbidden. When I put a group invalid.

Created on , last edited on