get uris document config
/members/{member}/groups/{group}/uris/documentconfig [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9500 | 5.9900 | xml |
Description
This services returns the configuration files for a document type or media type related to a group.
It collects all the relevant files by prioritizing:
- Project template files in
/template/[project]
- Global template files in
/template/[global]
(skipped if the project is the global template) - Default template in
/template/default
Xref configuration
The xref-config.xml is returned if found, in the following order:
/template/[project]/config/xref-config.xml
/template/[global]/config/xref-config.xml
/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:
/template/[project]/psml/[type]
/template/[global]/psml/[type]
/template/default/psml/[type]
/template/default/psml/default
Media 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:
/template/[project]/document/[extension]
/template/[global]/document/[extension]
/template/default/document/[extension]
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
documenttype | The document type for the config | no | string | default |
extension | The file extension for the config (overrides documenttype) | no | string |
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.