Skip to main content

 Web service API

How to use PageSeeder's Web service API

get group publish config

/members/{member}/groups/{group}/publishconfig [GET]

com.pageseeder.publish.GetPublishConfig

Description

Gets the publish configuration for a group.

Parameters

NameDescriptionRequiredTypeDefault value
typeA comma-separated list of action types to include – all if not specified (export, publish, process, upload, upload-preview)nostring

Permission

This service requires guest or higher unless the group is public.

Response

The output has the following format:

<publish-config manager-in-project="[true|false]">
  <publishing project="acme">
    <action type="export">
      <source type="group" />      
      <target name="export-psml" 
              perspective="developer" 
              role="contributor">
        <description>Type 2 Export</description>
        <param name="isbn"  
               type="text" 
               label="ISBN" 
               placeholder="Enter a valid
                            ISBN 13 number (97xxxxxxxxxxx)" 
               pattern="97[89][0-9]{10}"/>
        <param name="in-stock"
               type="checkbox"
               label="In Stock"   
               perspective="developer"/>
        <param name="language"
               type="select"
               label="Language">
          <value>English</value>
          <value>French</value>
          <value>Spanish</value>
        </param>
      </target>
    </action>
    ...
  </publishing>
  <publishing project="default"> ... </publishing>
</publish-config>

Error Handling

No specific errors expected for this service.

Created on , last edited on