Web service API

How to use PageSeeder's Web service API

get uris publish config

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

com.pageseeder.publish.GetPublishConfig

Description

Gets the publish config for all URIs in a group.

Parameters

NameDescriptionRequiredTypeDefault value
type a comma-separated list of action types to include - all if not specified (import,export,publish,process,upload,upload-preview) no string

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<publish-config manager-in-project="[true|false]">
  <publishing project="acme">
    <action type="export">
      <source type="document"
              extension="psml"
              document-type="type2"/>
      <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

CodeCause / Description
0x1022 If the member does not belong to the group

Created on , last edited on