Skip to main content

 Web service API

How to use PageSeeder's Web service API

get uri config

/members/{member}/groups/{group}/uris/{uri}/config [GET]

com.pageseeder.psml.GetConfig

Description

Get config files for a URI.

Get the configuration files for a document.

For PSML they are:

  • document-config.xml
  • document-template.psml
  • editor-config.xml

This service first tries to locate where the document is defined by looking for the corresponding folder based on document type in the following defined order:

  1. /template/[project]/psml/[type]
  2. /template/[custom]/psml/[type]
  3. /template/default/psml/[type]
  4. /template/default/psml/default

For non PSML they are:

  • media-template.psml
  • editor-config.xml
  • document labels from project configuration

This service first tries to locate where the document is defined by looking for the corresponding folder based on file extension in the following defined order:

  1. /template/[project]/document/[extension]
  2. /template/[custom]/document/[extension]
  3. /template/default/document/[extension]

Parameters

No parameters.

Permission

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

Response

For PSML

<document-type definedby="myproject"
               name="mytype"
               icon="/weborganic/psml/default/fallback-icon.png"
               css="/woconfig/myproject/psml/mytype/document.css">
  [<document-config>
    ...
  </document-config>]
  [<document-template type="psml">
    ...
  </document-template>]
  [<editor-configs>
    ...
  </editor-configs>]
</document-type>

For non PSML

<document-extension definedby="default,myproject"
                    name="jpg">
  [<media-template type="psml">
    ...
  </media-template>]
  [<editor-configs>
    ...
  </editor-configs>]
  [<label-config scope="project"
                template="myproject"
                updated="2017-04-24T13:31:24+10:00">
    <labels type="document">
      ...
    </labels>
  </label-config>]
</document-extension>

Error Handling

No specific error handling.

Created on , last edited on