Skip to main content

 Services

Web services from /about to /webhooks

list document configs

/groups/{group}/documents/configs [GET]

Description

Returns the list of configuration files for all types of PSML documents available in the project.

Parameters

NameDescriptionRequiredTypeDefault value
includesComma-separated list of configs to includenostringdocument-config,document-template,editor-config

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

<document-types>
  <document-type name="help"
                 definedby="default">
       [<document-config> ... </<document-config>]
       [<document-template type="psml"> ... </document-template>]
       [<editor-configs> ... </editor-configs>]
  </document-type>
  <document-type ... >
  </document-type>
  ...
</document-types>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on