Skip to main content

 Services

Web services from /about to /webhooks

get uris document config

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

com.pageseeder.psml.GetConfig

Description

This services returns the configuration files related to documents for a group.

It collects all the relevant files by prioritizing:

  1. Project template files in /template/[project]
  2. Global template files in/template/[global] (skipped if the project is the global template)
  3. Default template in /template/default

Xref configuration

The xref-config.xml is returned if found, in the following order:

  1. /template/[project]/config/xref-config.xml
  2. /template/[global]/config/xref-config.xml
  3. /template/default/config/xref-config.xml

PSML document types

For PSML, the other configs are:

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/[global]/psml/[type]
  3. /template/default/psml/[type]
  4. /template/default/psml/default

Media document types

For non PSML they are:

  • media-template.xml 
  • 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/[global]/document/[extension]
  3. /template/default/document/[extension]

Parameters

NameDescriptionRequiredTypeDefault
documenttypeThe document type for the confignostring
extensionThe file extension for the config (overrides documenttype)nostring

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">
 [<xref-configs>
    ...
  </xref-configs>]
 [<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">
 [<xref-configs>
    ...
  </xref-configs>]
 [<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 errors expected for this service.

Created on , last edited on