Skip to main content

 Services

Web services from /about to /webhooks

get uri config

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

com.pageseeder.psml.GetConfig

Description

This service returns all the configuration files for a document based on its document type, media type or a URL type.

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

  1. /template/[project]/config
  2. /template/[custom]/config
  3. /template/default/config

PSML

If the URI is a PSML document, the relevant configuration files 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/[custom]/psml/[type]
  3. /template/default/psml/[type]
  4. /template/default/psml/default

Other media

If the URI is not a PSML document, the relevant configuration files 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]

URL

For external URIs they are:

  • url-config.xml
  • url-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 URL type, in the following order:

  1. /template/[custom]/url/[type]
  2. /template/default/url/[type]

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">
 [<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>

For external URIs (URLs)

<url-type definedby="myproject"
          name="mytype">
 [<xref-configs>
    ...
  </xref-configs>]
 [<url-config>
    ...
  </url-config>]
 [<url-template>
    ...
  </url-template>]
 [<editor-configs>
    ...
  </editor-configs>]
</document-type>

Error Handling

No specific error handling.

Created on , last edited on