Skip to main content

 Web service API

How to use PageSeeder's Web service API

list document configs

/groups/{group}/documents/configs [GET]

com.pageseeder.psml.ListConfigs

Description

Returns the list of configuration files for all types of PSML documents available in the project.

Parameters

Name Description Required Type Default value
includes comma separated list of configs to include no string document-config,document-template,editor-config

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

   <document-types>
     <document-type name="help"
                    definedby="default"
                    icon="/weborganic/psml/help/template-icon.png">
       [<document-config> ... </<document-config>]
       [<document-template type="psml"> ... </document-template>]
       [<editor-configs> ... </editor-configs>]
     </document-type>
     <document-type ... >
     </document-type>
     ...
   </document-types>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on